DSCResources/MSFT_AdfsOrganization/MSFT_AdfsOrganization.psm1
|
<#
.SYNOPSIS DSC module for the ADFS Organization resource .DESCRIPTION The AdfsOrganization DSC resource manages the ADFS Organization information that is published in the federation metadata for the Federation Service. .PARAMETER FederationServiceName Key - String Specifies the DNS name of the federation service. .PARAMETER DisplayName Key - String Specifies the display name of the organization. .PARAMETER Name Key - String Specifies the name of the organization. .PARAMETER OrganizationUrl Key - String Specifies the URL of the organization. #> Set-StrictMode -Version 2.0 $script:dscModuleName = 'AdfsDsc' $script:psModuleName = 'ADFS' $script:dscResourceName = [System.IO.Path]::GetFileNameWithoutExtension($MyInvocation.MyCommand.Name) $script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent $script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules' $script:localizationModulePath = Join-Path -Path $script:modulesFolderPath -ChildPath "$($script:DSCModuleName).Common" Import-Module -Name (Join-Path -Path $script:localizationModulePath -ChildPath "$($script:dscModuleName).Common.psm1") $script:localizedData = Get-LocalizedData -ResourceName $script:dscResourceName function Get-TargetResource { <# .SYNOPSIS Get-TargetResource .NOTES Used Cmdlets/Functions: Name | Module -------------------------|---------------- Get-AdfsProperties | Adfs Assert-Module | AdfsDsc.Common Assert-AdfsService | AdfsDsc.Common #> [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $FederationServiceName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $DisplayName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $Name, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $OrganizationUrl ) # Set Verbose and Debug parameters $commonParms = @{ Verbose = $VerbosePreference Debug = $DebugPreference } Write-Verbose -Message ($script:localizedData.GettingResourceMessage -f $FederationServiceName) # Check of the ADFS PowerShell module is installed Assert-Module -ModuleName $script:psModuleName # Check if the ADFS Service is present and running Assert-AdfsService @commonParms try { $targetResource = (Get-AdfsProperties).OrganizationInfo } catch { $errorMessage = $script:localizedData.GettingResourceErrorMessage -f $FederationServiceName New-InvalidOperationException -Message $errorMessage -Error $_ } if ($targetResource -is [Microsoft.IdentityServer.Management.Resources.Organization]) { $returnValue = @{ FederationServiceName = $FederationServiceName Name = $targetResource.Name DisplayName = $targetResource.DisplayName OrganizationUrl = $targetResource.OrganizationUrl } } else { $returnValue = @{ FederationServiceName = $FederationServiceName Name = '' DisplayName = '' OrganizationUrl = '' } } $returnValue } function Set-TargetResource { <# .SYNOPSIS Get-TargetResource .NOTES Used Cmdlets/Functions: Name | Module ------------------------------|---------------- New-AdfsOrganization | Adfs Set-AdfsProperties | Adfs Compare-ResourcePropertyState | AdfsDsc.Common #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $FederationServiceName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $DisplayName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $Name, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $OrganizationUrl ) # Set Verbose and Debug parameters $commonParms = @{ Verbose = $VerbosePreference Debug = $DebugPreference } Write-Verbose -Message ($script:localizedData.SettingResourceMessage -f $FederationServiceName) # Remove any parameters not used in Splats [HashTable]$parameters = $PSBoundParameters $parameters.Remove('FederationServiceName') $parameters.Remove('Verbose') $getTargetResourceParms = @{ FederationServiceName = $FederationServiceName Name = $Name DisplayName = $DisplayName OrganizationUrl = $OrganizationUrl } $targetResource = Get-TargetResource @getTargetResourceParms $propertiesNotInDesiredState = ( Compare-ResourcePropertyState -CurrentValues $targetResource -DesiredValues $parameters ` @commonParms | Where-Object -Property InDesiredState -eq $false) foreach ($property in $propertiesNotInDesiredState) { Write-Verbose -Message ($script:localizedData.SettingResourcePropertyMessage -f $FederationServiceName, $property.ParameterName, ($property.Expected -join ', ')) } # Set organization to $null if all parameters are empty if ([System.String]::IsNullOrEmpty($DisplayName) -and [System.String]::IsNullOrEmpty($Name) -and [System.String]::IsNullOrEmpty($OrganizationUrl)) { $organizationInfo = $null } else { try { $organizationInfo = New-AdfsOrganization @parameters } catch { $errorMessage = $script:localizedData.NewAdfsOrganizationErrorMessage -f $FederationServiceName New-InvalidOperationException -Message $errorMessage -Error $_ } } try { Set-AdfsProperties -OrganizationInfo $organizationInfo } catch { $errorMessage = $script:localizedData.SettingResourceErrorMessage -f $FederationServiceName New-InvalidOperationException -Message $errorMessage -Error $_ } } function Test-TargetResource { <# .SYNOPSIS Test-TargetResource .NOTES Used Cmdlets/Functions: Name | Module ------------------------------|------------------ Compare-ResourcePropertyState | AdfsDsc.Common #> [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $FederationServiceName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $DisplayName, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $Name, [Parameter(Mandatory = $true)] [AllowEmptyString()] [System.String] $OrganizationUrl ) # Set Verbose and Debug parameters $commonParms = @{ Verbose = $VerbosePreference Debug = $DebugPreference } Write-Verbose -Message ($script:localizedData.TestingResourceMessage -f $FederationServiceName) $getTargetResourceParms = @{ FederationServiceName = $FederationServiceName DisplayName = $DisplayName Name = $Name OrganizationUrl = $OrganizationUrl } $targetResource = Get-TargetResource @getTargetResourceParms $propertiesNotInDesiredState = ( Compare-ResourcePropertyState -CurrentValues $targetResource -DesiredValues $PSBoundParameters ` @commonParms | Where-Object -Property InDesiredState -eq $false) if ($propertiesNotInDesiredState) { Write-Verbose -Message ($script:localizedData.ResourceNotInDesiredStateMessage -f $FederationServiceName) $inDesiredState = $false } else { # Resource is in desired state Write-Verbose -Message ($script:localizedData.ResourceInDesiredStateMessage -f $FederationServiceName) $inDesiredState = $true } $inDesiredState } Export-ModuleMember -Function *-TargetResource |