DSCResources/MSFT_EXOSafeLinksRule/MSFT_EXOSafeLinksRule.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.String] $SafeLinksPolicy, [Parameter()] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled = $true, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs = @(), [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [uint32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs = @(), [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) $InformationPreference = 'Continue' Write-Verbose -Message "Setting configuration of SafeLinksRule for $Identity" #region Telemetry $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $MyInvocation.MyCommand.ModuleName) $data.Add("Method", $MyInvocation.MyCommand) Add-M365DSCTelemetryEvent -Data $data #endregion Test-MSCloudLogin -CloudCredential $GlobalAdminAccount ` -Platform ExchangeOnline $SafeLinksRules = Get-SafeLinksRule $SafeLinksRule = $SafeLinksRules | Where-Object -FilterScript { $_.Identity -eq $Identity } if (-not $SafeLinksRule) { Write-Verbose -Message "SafeLinksRule $($Identity) does not exist." $result = $PSBoundParameters $result.Ensure = 'Absent' return $result } else { $result = @{ Identity = $SafeLinksRule.Identity SafeLinksPolicy = $SafeLinksRule.SafeLinksPolicy Comments = $SafeLinksRule.Comments Enabled = $true ExceptIfRecipientDomainIs = $SafeLinksRule.ExceptIfRecipientDomainIs ExceptIfSentTo = $SafeLinksRule.ExceptIfSentTo ExceptIfSentToMemberOf = $SafeLinksRule.ExceptIfSentToMemberOf Priority = $SafeLinksRule.Priority RecipientDomainIs = $SafeLinksRule.RecipientDomainIs SentTo = $SafeLinksRule.SentTo SentToMemberOf = $SafeLinksRule.SentToMemberOf GlobalAdminAccount = $GlobalAdminAccount Ensure = 'Present' } if ('Enabled' -eq $SafeLinksRule.State) { # Accounts for Get-SafeLinksRule returning 'State' instead of 'Enabled' used by New/Set $result.Enabled = $true } else { $result.Enabled = $false } Write-Verbose -Message "Found SafeLinksRule $($Identity)" Write-Verbose -Message "Get-TargetResource Result: `n $(Convert-M365DscHashtableToString -Hashtable $result)" return $result } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.String] $SafeLinksPolicy, [Parameter()] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled = $true, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs = @(), [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [uint32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs = @(), [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Setting configuration of SafeLinksRule for $Identity" #region Telemetry $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $MyInvocation.MyCommand.ModuleName) $data.Add("Method", $MyInvocation.MyCommand) Add-M365DSCTelemetryEvent -Data $data #endregion Test-MSCloudLogin -CloudCredential $GlobalAdminAccount ` -Platform ExchangeOnline $SafeLinksRules = Get-SafeLinksRule $SafeLinksRule = $SafeLinksRules | Where-Object -FilterScript { $_.Identity -eq $Identity } if (('Present' -eq $Ensure ) -and (-not $SafeLinksRule)) { New-EXOSafeLinksRule -SafeLinksRuleParams $PSBoundParameters } if (('Present' -eq $Ensure ) -and ($SafeLinksRule)) { if ($PSBoundParameters.Enabled -and ('Disabled' -eq $SafeLinksRule.State)) { # New-SafeLinksRule has the Enabled parameter, Set-SafeLinksRule does not. # There doesn't appear to be any way to change the Enabled state of a rule once created. Write-Verbose -Message "Removing SafeLinksRule $($Identity) in order to change Enabled state." Remove-SafeLinksRule -Identity $Identity -Confirm:$false New-EXOSafeLinksRule -SafeLinksRuleParams $PSBoundParameters } else { Set-EXOSafeLinksRule -SafeLinksRuleParams $PSBoundParameters } } if (('Absent' -eq $Ensure ) -and ($SafeLinksRule)) { Write-Verbose -Message "Removing SafeLinksRule $($Identity)" Remove-SafeLinksRule -Identity $Identity -Confirm:$false } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.String] $SafeLinksPolicy, [Parameter()] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled = $true, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs = @(), [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [uint32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs = @(), [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Testing configuration of SafeLinksRule for $Identity" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $ValuesToCheck = $PSBoundParameters $ValuesToCheck.Remove('GlobalAdminAccount') | Out-Null $TestResult = Test-Microsoft365DSCParameterState -CurrentValues $CurrentValues ` -Source $($MyInvocation.MyCommand.Source) ` -DesiredValues $PSBoundParameters ` -ValuesToCheck $ValuesToCheck.Keys Write-Verbose -Message "Test-TargetResource returned $TestResult" return $TestResult } function Export-TargetResource { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) $InformationPreference = 'Continue' #region Telemetry $data = [System.Collections.Generic.Dictionary[[String], [String]]]::new() $data.Add("Resource", $MyInvocation.MyCommand.ModuleName) $data.Add("Method", $MyInvocation.MyCommand) Add-M365DSCTelemetryEvent -Data $data #endregion Test-MSCloudLogin -CloudCredential $GlobalAdminAccount ` -Platform ExchangeOnline ` -ErrorAction SilentlyContinue $content = '' if (Confirm-ImportedCmdletIsAvailable -CmdletName Get-SafeLinksRule) { [array]$SafeLinksRules = Get-SafeLinksRule $i = 1 foreach ($SafeLinksRule in $SafeLinksRules) { Write-Information " [$i/$($SafeLinksRules.Length)] $($SafeLinksRule.Identity)" $params = @{ Identity = $SafeLinksRule.Identity SafeLinksPolicy = $SafeLinksRule.SafeLinksPolicy GlobalAdminAccount = $GlobalAdminAccount } $result = Get-TargetResource @params $result.GlobalAdminAccount = Resolve-Credentials -UserName "globaladmin" $content += " EXOSafeLinksRule " + (New-GUID).ToString() + "`r`n" $content += " {`r`n" $currentDSCBlock = Get-DSCBlock -Params $result -ModulePath $PSScriptRoot $content += Convert-DSCStringParamToVariable -DSCBlock $currentDSCBlock -ParameterName "GlobalAdminAccount" $content += " }`r`n" $i++ } } else { Write-Information "The current tenant is not registered to allow for Safe Links Rules." } return $content } Export-ModuleMember -Function *-TargetResource |