DSCResources/MSFT_EXOMalwareFilterRule/MSFT_EXOMalwareFilterRule.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter()] [ValidateLength (0, 1024)] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [System.String] $MalwareFilterPolicy, [Parameter()] [System.String] $Priority, [Parameter()] [System.String] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Getting configuration of Malwarefilterrule 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 $MalwareFilterRules = Get-MalwareFilterRule $MalwareFilterRule = $MalwareFilterRules | Where-Object -FilterScript { $_.Identity -eq $Identity } if ($null -eq $MalwareFilterRule) { Write-Verbose -Message "MalwareFilterRule $($Identity) does not exist." $result = $PSBoundParameters $result.Ensure = 'Absent' return $result } else { $result = @{ Identity = $Identity Comments = $MalwareFilterRule.Comments Enabled = $MalwareFilterRule.Enabled ExceptIfRecipientDomainIs = $MalwareFilterRule.ExceptIfRecipientDomainIs ExceptIfSentTo = $MalwareFilterRule.ExceptIfSentTo ExceptIfSentToMemberOf = $MalwareFilterRule.ExceptIfSentToMemberOf MalwareFilterPolicy = $MalwareFilterRule.MalwareFilterPolicy Priority = $MalwareFilterRule.Priority RecipientDomainIs = $MalwareFilterRule.RecipientDomainIs SentTo = $MalwareFilterRule.SentTo SentToMemberOf = $MalwareFilterRule.SentToMemberOf GlobalAdminAccount = $GlobalAdminAccount Ensure = 'Present' } Write-Verbose -Message "Found MalwareFilterRule $($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()] [ValidateLength (0, 1024)] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [System.String] $MalwareFilterPolicy, [Parameter()] [System.String] $Priority, [Parameter()] [System.String] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Setting configuration of MalwareFilterRule for $($Identity)" Test-MSCloudLogin -CloudCredential $GlobalAdminAccount ` -Platform ExchangeOnline $MalwareFilterRules = Get-MalwareFilterRule $MalwareFilterRule = $MalwareFilterRules | Where-Object -FilterScript { $_.Identity -eq $Identity } $MalwareFilterRuleParams = $PSBoundParameters $MalwareFilterRuleParams.Remove('Ensure') | Out-Null $MalwareFilterRuleParams.Remove('GlobalAdminAccount') | Out-Null if (('Present' -eq $Ensure ) -and ($null -eq $MalwareFilterRule)) { Write-Verbose -Message "Creating MalwareFilterRule $($Identity)." $MalwareFilterRuleParams.Add("Name", $Identity) $MalwareFilterRuleParams.Remove('Identity') | Out-Null New-MalwareFilterRule @MalwareFilterRuleParams } elseif (('Present' -eq $Ensure ) -and ($Null -ne $MalwareFilterRule)) { $MalwareFilterRuleParams.Remove('Enabled') | Out-Null Write-Verbose -Message "Setting MalwareFilterRule $($Identity) with values: $(Convert-M365DscHashtableToString -Hashtable $MalwareFilterRuleParams)" Set-MalwareFilterRule @MalwareFilterRuleParams -Confirm:$false } elseif (('Absent' -eq $Ensure ) -and ($null -ne $MalwareFilterRule)) { Write-Verbose -Message "Removing MalwareFilterRule $($Identity)" Remove-MalwareFilterRule -Identity $Identity -Confirm:$false } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter()] [ValidateLength (0, 1024)] [System.String] $Comments, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [System.String] $MalwareFilterPolicy, [Parameter()] [System.String] $Priority, [Parameter()] [System.String] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet("Present", "Absent")] [System.String] $Ensure = "Present", [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $GlobalAdminAccount ) Write-Verbose -Message "Testing configuration of MalwareFilterRule 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 ` -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" Test-MSCloudLogin -CloudCredential $GlobalAdminAccount ` -Platform ExchangeOnline ` -ErrorAction SilentlyContinue [array]$MalwareFilterRules = Get-MalwareFilterRule $content = "" $i = 1 foreach ($MalwareFilterRule in $MalwareFilterRules) { Write-Information " [$i/$($MalwareFilterRules.length)] $($MalwareFilterRule.Identity)" $Params = @{ Identity = $MalwareFilterRule.Identity GlobalAdminAccount = $GlobalAdminAccount } $result = Get-TargetResource @Params $result.GlobalAdminAccount = Resolve-Credentials -UserName "globaladmin" $content += " EXOMalwareFilterRule " + (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++ } return $content } Export-ModuleMember -Function *-TargetResource |