DSCResources/MSFT_SPSearchResultSource/MSFT_SPSearchResultSource.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $SearchServiceAppName, [Parameter(Mandatory = $true)] [System.String] $Query, [Parameter(Mandatory = $true)] [ValidateSet("Exchange Search Provider", "Local People Provider", "Local SharePoint Provider", "OpenSearch Provider", "Remote People Provider", "Remote SharePoint Provider")] [System.String] $ProviderType, [Parameter()] [System.String] $ConnectionUrl, [Parameter()] [System.String] $ScopeUrl, [Parameter()] [ValidateSet("Present","Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting search result source '$Name'" $result = Invoke-SPDSCCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] [void] [Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search") $nullReturn = @{ Name = $params.Name SearchServiceAppName = $params.SearchServiceAppName Query = $null ProviderType = $null ConnectionUrl = $null ScopeUrl = $null Ensure = "Absent" InstallAccount = $params.InstallAccount } $serviceApp = Get-SPEnterpriseSearchServiceApplication -Identity $params.SearchServiceAppName $searchSiteUrl = $serviceApp.SearchCenterUrl -replace "/pages" $searchSite = Get-SPWeb -Identity $searchSiteUrl -ErrorAction SilentlyContinue if ($null -eq $searchSite) { Write-Verbose -Message ("Search centre site collection does not exist at " + ` "$searchSiteUrl. Unable to create search context " + ` "to determine result source details.") return $nullReturn } $adminNamespace = "Microsoft.Office.Server.Search.Administration" $queryNamespace = "Microsoft.Office.Server.Search.Administration.Query" $objectLevel = [Microsoft.Office.Server.Search.Administration.SearchObjectLevel] $fedManager = $null if ($null -eq $params.ScopeUrl) { $fedManager = New-Object -TypeName "$queryNamespace.FederationManager" ` -ArgumentList $serviceApp $searchOwner = New-Object -TypeName "$adminNamespace.SearchObjectOwner" ` -ArgumentList @( $objectLevel::Ssa, $searchSite ) $source = $fedManager.GetSourceByName($params.Name, $searchOwner) } else { $fedManager = New-Object Microsoft.Office.Server.Search.Administration.Query.FederationManager($serviceApp) $searchOwner = Get-SPEnterpriseSearchOwner -Level SPWeb -SPWeb $params.ScopeUrl $filter = New-Object Microsoft.Office.Server.Search.Administration.SearchObjectFilter($searchOwner) $filter.IncludeHigherLevel = $false $source = $fedManager.ListSources($filter,$true) | Where-Object -FilterScript { $_.Name -eq $params.Name } } if ($null -ne $source) { $providers = $fedManager.ListProviders() $provider = $providers.Values | Where-Object -FilterScript { $_.Id -eq $source.ProviderId } return @{ Name = $params.Name SearchServiceAppName = $params.SearchServiceAppName Query = $source.QueryTransform.QueryTemplate ProviderType = $provider.Name ConnectionUrl = $source.ConnectionUrlTemplate ScopeUrl = $params.ScopeUrl Ensure = "Present" InstallAccount = $params.InstallAccount } } else { return $nullReturn } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $SearchServiceAppName, [Parameter(Mandatory = $true)] [System.String] $Query, [Parameter(Mandatory = $true)] [ValidateSet("Exchange Search Provider", "Local People Provider", "Local SharePoint Provider", "OpenSearch Provider", "Remote People Provider", "Remote SharePoint Provider")] [System.String] $ProviderType, [Parameter()] [System.String] $ConnectionUrl, [Parameter()] [System.String] $ScopeUrl, [Parameter()] [ValidateSet("Present","Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting search result source '$Name'" $CurrentValues = Get-TargetResource @PSBoundParameters if ($CurrentValues.Ensure -eq "Absent" -and $Ensure -eq "Present") { Write-Verbose -Message "Creating search result source $Name" Invoke-SPDSCCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] [void] [Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search") $serviceApp = Get-SPEnterpriseSearchServiceApplication ` -Identity $params.SearchServiceAppName $searchSiteUrl = $serviceApp.SearchCenterUrl -replace "/pages" $searchSite = Get-SPWeb -Identity $searchSiteUrl -ErrorAction SilentlyContinue if ($null -eq $searchSite) { throw ("Search centre site collection does not exist at " + ` "$searchSiteUrl. Unable to create search context " + ` "to set result source.") return } $fedManager = $null if ($null -eq $params.ScopeUrl) { $adminNamespace = "Microsoft.Office.Server.Search.Administration" $queryNamespace = "Microsoft.Office.Server.Search.Administration.Query" $objectLevel = [Microsoft.Office.Server.Search.Administration.SearchObjectLevel] $fedManager = New-Object -TypeName "$queryNamespace.FederationManager" ` -ArgumentList $serviceApp $searchOwner = New-Object -TypeName "$adminNamespace.SearchObjectOwner" ` -ArgumentList @( $objectLevel::Ssa, $searchSite ) $transformType = "Microsoft.Office.Server.Search.Query.Rules.QueryTransformProperties" $queryProperties = New-Object -TypeName $transformType $resultSource = $fedManager.CreateSource($searchOwner) } else { $fedManager = New-Object Microsoft.Office.Server.Search.Administration.Query.FederationManager($serviceApp) $searchOwner = Get-SPEnterpriseSearchOwner -Level SPWeb -SPWeb $params.ScopeUrl $transformType = "Microsoft.Office.Server.Search.Query.Rules.QueryTransformProperties" $queryProperties = New-Object -TypeName $transformType $resultSource = $fedManager.CreateSource($searchOwner) } $resultSource.Name = $params.Name $providers = $fedManager.ListProviders() $provider = $providers.Values | Where-Object -FilterScript { $_.Name -eq $params.ProviderType } $resultSource.ProviderId = $provider.Id $resultSource.CreateQueryTransform($queryProperties, $params.Query) if ($params.ContainsKey("ConnectionUrl") -eq $true) { $resultSource.ConnectionUrlTemplate = $params.ConnectionUrl } $resultSource.Commit() } } if ($Ensure -eq "Absent") { Write-Verbose -Message "Removing search result source $Name" Invoke-SPDSCCommand -Credential $InstallAccount -Arguments $PSBoundParameters -ScriptBlock { $params = $args[0] [void] [Reflection.Assembly]::LoadWithPartialName("Microsoft.Office.Server.Search") $serviceApp = Get-SPEnterpriseSearchServiceApplication ` -Identity $params.SearchServiceAppName $searchSiteUrl = $serviceApp.SearchCenterUrl -replace "/pages" $searchSite = Get-SPWeb -Identity $searchSiteUrl $adminNamespace = "Microsoft.Office.Server.Search.Administration" $queryNamespace = "Microsoft.Office.Server.Search.Administration.Query" $objectLevel = [Microsoft.Office.Server.Search.Administration.SearchObjectLevel] $fedManager = New-Object -TypeName "$queryNamespace.FederationManager" ` -ArgumentList $serviceApp $searchOwner = New-Object -TypeName "$adminNamespace.SearchObjectOwner" ` -ArgumentList @( $objectLevel::Ssa, $searchSite ) $source = $fedManager.GetSourceByName($params.Name, $searchOwner) if ($null -ne $source) { $fedManager.RemoveSource($source) } } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter(Mandatory = $true)] [System.String] $SearchServiceAppName, [Parameter(Mandatory = $true)] [System.String] $Query, [Parameter(Mandatory = $true)] [ValidateSet("Exchange Search Provider", "Local People Provider", "Local SharePoint Provider", "OpenSearch Provider", "Remote People Provider", "Remote SharePoint Provider")] [System.String] $ProviderType, [Parameter()] [System.String] $ConnectionUrl, [Parameter()] [System.String] $ScopeUrl, [Parameter()] [ValidateSet("Present","Absent")] [System.String] $Ensure = "Present", [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing search result source '$Name'" $PSBoundParameters.Ensure = $Ensure $CurrentValues = Get-TargetResource @PSBoundParameters return Test-SPDscParameterState -CurrentValues $CurrentValues ` -DesiredValues $PSBoundParameters ` -ValuesToCheck @("Ensure") } Export-ModuleMember -Function *-TargetResource |