DSCResources/MSFT_SPServiceAppProxyGroup/MSFT_SPServiceAppProxyGroup.psm1
|
$script:SPDscUtilModulePath = Join-Path -Path $PSScriptRoot -ChildPath '..\..\Modules\SharePointDsc.Util' Import-Module -Name $script:SPDscUtilModulePath function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] [ValidateSet("Present", "Absent")] $Ensure = "Present", [Parameter()] [System.String[]] $ServiceAppProxies, [Parameter()] [System.String[]] $ServiceAppProxiesToInclude, [Parameter()] [System.String[]] $ServiceAppProxiesToExclude, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Getting Service Application Proxy Group $Name" $nullReturn = @{ Name = $Name Ensure = $null ServiceAppProxies = $null ServiceAppProxiesToInclude = $null ServiceAppProxiesToExclude = $null } if (($Ensure -eq "Present") -and ` $ServiceAppProxies -and ` (($ServiceAppProxiesToInclude) -or ($ServiceAppProxiesToExclude))) { Write-Verbose -Message ("Cannot use the ServiceAppProxies parameter together " + ` "with the ServiceAppProxiesToInclude or " + ` "ServiceAppProxiesToExclude parameters") return $nullReturn } if (($Ensure -eq "Present") -and ` !$ServiceAppProxies -and ` !$ServiceAppProxiesToInclude -and ` !$ServiceAppProxiesToExclude) { Write-Verbose -Message ("At least one of the following parameters must be specified: " + ` "ServiceAppProxies, ServiceAppProxiesToInclude, " + ` "ServiceAppProxiesToExclude") return $nullReturn } $result = Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments $PSBoundParameters ` -ScriptBlock { $params = $args[0] #Try to get the proxy group if ($params.Name -eq "Default") { $ProxyGroup = Get-SPServiceApplicationProxyGroup -Default } else { $ProxyGroup = Get-SPServiceApplicationProxyGroup $params.Name -ErrorAction SilentlyContinue } if ($ProxyGroup) { $Ensure = "Present" } else { $Ensure = "Absent" } $ServiceAppProxies = $ProxyGroup.Proxies.DisplayName return @{ Name = $params.name Ensure = $Ensure ServiceAppProxies = $ServiceAppProxies ServiceAppProxiesToInclude = $params.ServiceAppProxiesToInclude ServiceAppProxiesToExclude = $params.ServiceAppProxiesToExclude } } return $result } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] [ValidateSet("Present", "Absent")] $Ensure = "Present", [Parameter()] [System.String[]] $ServiceAppProxies, [Parameter()] [System.String[]] $ServiceAppProxiesToInclude, [Parameter()] [System.String[]] $ServiceAppProxiesToExclude, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Setting Service Application Proxy Group $Name" if (($Ensure -eq "Present") -and ` $ServiceAppProxies -and ` (($ServiceAppProxiesToInclude) -or ($ServiceAppProxiesToExclude))) { $message = ("Cannot use the ServiceAppProxies parameter together " + ` "with the ServiceAppProxiesToInclude or " + ` "ServiceAppProxiesToExclude parameters") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } if (($Ensure -eq "Present") -and ` !$ServiceAppProxies -and ` !$ServiceAppProxiesToInclude -and ` !$ServiceAppProxiesToExclude) { $message = ("At least one of the following parameters must be specified: " + ` "ServiceAppProxies, ServiceAppProxiesToInclude, " + ` "ServiceAppProxiesToExclude") Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $MyInvocation.MyCommand.Source throw $message } Invoke-SPDscCommand -Credential $InstallAccount ` -Arguments @($PSBoundParameters, $MyInvocation.MyCommand.Source) ` -ScriptBlock { $params = $args[0] $eventSource = $args[1] if ($params.Ensure -eq "Present") { if ($params.Name -eq "Default") { $ProxyGroup = Get-SPServiceApplicationProxyGroup -Default } else { $ProxyGroup = Get-SPServiceApplicationProxyGroup -Identity $params.Name ` -ErrorAction SilentlyContinue } if (!($ProxyGroup)) { Write-Verbose -Message "Creating new Service Application Proxy Group $($params.Name)" $ProxyGroup = New-SPServiceApplicationProxyGroup -Name $params.Name } #Explicit Service Applications if ($params.ServiceAppProxies) { if ($ProxyGroup.Proxies.DisplayName) { $differences = Compare-Object -ReferenceObject $ProxyGroup.Proxies.DisplayName ` -DifferenceObject $params.ServiceAppProxies if ($null -eq $Differences) { Write-Verbose -Message ("Service Proxy Group $($params.name) " + ` "membership matches desired state") } else { foreach ($difference in $differences) { if ($difference.SideIndicator -eq "=>") { $ServiceProxyName = $difference.InputObject $ServiceProxy = Get-SPServiceApplicationProxy | ` Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose -Message "Adding $ServiceProxyName to $($params.name) Proxy Group" $ProxyGroup | Add-SPServiceApplicationProxyGroupMember -Member $ServiceProxy } elseif ($difference.SideIndicator -eq "<=") { $ServiceProxyName = $difference.InputObject $ServiceProxy = Get-SPServiceApplicationProxy | ` Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose -Message "Removing $ServiceProxyName from $($params.name) Proxy Group" $ProxyGroup | Remove-SPServiceApplicationProxyGroupMember -member $ServiceProxy } } } } else { foreach ($ServiceProxyName in $params.ServiceAppProxies) { $ServiceProxy = Get-SPServiceApplicationProxy | Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose -Message "Adding $ServiceProxyName to $($params.name) Proxy Group" $ProxyGroup | Add-SPServiceApplicationProxyGroupMember -member $ServiceProxy } } } if ($params.ServiceAppProxiesToInclude) { if ($ProxyGroup.Proxies.DisplayName) { $differences = Compare-Object -ReferenceObject $ProxyGroup.Proxies.DisplayName ` -DifferenceObject $params.ServiceAppProxiesToInclude if ($null -eq $Differences) { Write-Verbose -Message "Service Proxy Group $($params.name) Membership matches desired state" } else { foreach ($difference in $differences) { if ($difference.SideIndicator -eq "=>") { $ServiceProxyName = $difference.InputObject $ServiceProxy = Get-SPServiceApplicationProxy | ` Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose -Message "Adding $ServiceProxyName to $($params.name) Proxy Group" $ProxyGroup | Add-SPServiceApplicationProxyGroupMember -member $ServiceProxy } } } } else { foreach ($ServiceProxyName in $params.ServiceAppProxies) { $ServiceProxy = Get-SPServiceApplicationProxy | ` Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose "Adding $ServiceProxyName to $($params.name) Proxy Group" $ProxyGroup | Add-SPServiceApplicationProxyGroupMember -member $ServiceProxy } } } if ($params.ServiceAppProxiesToExclude) { if ($ProxyGroup.Proxies.Displayname) { $differences = Compare-Object -ReferenceObject $ProxyGroup.Proxies.DisplayName ` -DifferenceObject $params.ServiceAppProxiesToExclude ` -IncludeEqual if ($null -eq $Differences) { $message = "Error comparing ServiceAppProxiesToExclude for Service Proxy Group $($params.name)" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } else { foreach ($difference in $differences) { if ($difference.SideIndicator -eq "==") { $ServiceProxyName = $difference.InputObject $ServiceProxy = Get-SPServiceApplicationProxy | Where-Object -FilterScript { $_.DisplayName -eq $ServiceProxyName } if (!$ServiceProxy) { $message = "Invalid Service Application Proxy $ServiceProxyName" Add-SPDscEvent -Message $message ` -EntryType 'Error' ` -EventID 100 ` -Source $eventSource throw $message } Write-Verbose -Message "Removing $ServiceProxyName to $($params.name) Proxy Group" $ProxyGroup | Remove-SPServiceApplicationProxyGroupMember -member $ServiceProxy } } } } } } else { Write-Verbose "Removing $($params.name) Proxy Group" $ProxyGroup | Remove-SPServiceApplicationProxyGroup -confirm:$false } } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Name, [Parameter()] [System.String] [ValidateSet("Present", "Absent")] $Ensure = "Present", [Parameter()] [System.String[]] $ServiceAppProxies, [Parameter()] [System.String[]] $ServiceAppProxiesToInclude, [Parameter()] [System.String[]] $ServiceAppProxiesToExclude, [Parameter()] [System.Management.Automation.PSCredential] $InstallAccount ) Write-Verbose -Message "Testing Service Application Proxy Group $Name" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-SPDscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-SPDscHashtableToString -Hashtable $PSBoundParameters)" if ($CurrentValues.Ensure -ne $Ensure) { $message = "Ensure {$($CurrentValues.Ensure)} does not match the desired value {$Ensure}" Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } if ($ServiceAppProxies) { Write-Verbose -Message "Testing ServiceAppProxies property for $Name Proxy Group" if (-not $CurrentValues.ServiceAppProxies) { $message = "Proxy Group $Name does not contain any proxies" Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } $differences = Compare-Object -ReferenceObject $CurrentValues.ServiceAppProxies ` -DifferenceObject $ServiceAppProxies if ($null -eq $differences) { Write-Verbose -Message "ServiceAppProxies match" } else { $message = ("Proxies in proxy Group $Name does not match. Actual: " + ` "$($CurrentValues.$ServiceAppProxies -join ", "). Desired: " + ` "$($ServiceAppProxies -join ", ")") Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } } if ($ServiceAppProxiesToInclude) { Write-Verbose -Message "Testing ServiceAppProxiesToInclude property for $Name Proxy Group" if (-not $CurrentValues.ServiceAppProxies) { $message = "Proxy Group $Name does not contain any proxies" Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } $differences = Compare-Object -ReferenceObject $CurrentValues.ServiceAppProxies ` -DifferenceObject $ServiceAppProxiesToInclude if ($null -eq $differences) { Write-Verbose -Message "ServiceAppProxiesToInclude matches" } elseif ($differences.sideindicator -contains "=>") { $message = ("Included proxies in proxy Group $Name does not match. Actual: " + ` "$($CurrentValues.ServiceAppProxies -join ", "). Desired: " + ` "$($ServiceAppProxiesToInclude -join ", ")") Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } } if ($ServiceAppProxiesToExclude) { Write-Verbose -Message "Testing ServiceAppProxiesToExclude property for $Name Proxy Group" if (-not $CurrentValues.ServiceAppProxies) { Write-Verbose -Message "Test-TargetResource returned true" return $true } $differences = Compare-Object -ReferenceObject $CurrentValues.ServiceAppProxies ` -DifferenceObject $ServiceAppProxiesToExclude ` -IncludeEqual if ($null -eq $differences) { Write-Verbose -Message "Test-TargetResource returned false" return $false } elseif ($differences.sideindicator -contains "==") { $message = ("Excluded proxies in proxy Group $Name does not match. Actual: " + ` "$($CurrentValues.ServiceAppProxies -join ", "). Desired: " + ` "$($ServiceAppProxiesToExclude -join ", ")") Write-Verbose -Message $message Add-SPDscEvent -Message $message -EntryType 'Error' -EventID 1 -Source $MyInvocation.MyCommand.Source Write-Verbose -Message "Test-TargetResource returned false" return $false } } Write-Verbose -Message "Test-TargetResource returned true" return $true } |