DSCResources/MSFT_EXOEOPProtectionPolicyRule/MSFT_EXOEOPProtectionPolicyRule.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter()] [System.String] $Comments, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo, [Parameter()] [System.String[]] $ExceptIfSentToMemberOf, [Parameter(Mandatory = $true)] [System.Object] $Identity, [Parameter()] [System.String] $State, [Parameter()] [System.String] $Name, [Parameter()] [System.Int32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo, [Parameter()] [System.String[]] $SentToMemberOf, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String[]] $AccessTokens ) New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters | Out-Null #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace('MSFT_', '') $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $nullResult = $PSBoundParameters $nullResult.Ensure = 'Absent' try { $instance = Get-EOPProtectionPolicyRule -Identity $Identity -ErrorAction SilentlyContinue if ($null -eq $instance) { return $nullResult } Write-Verbose -Message "Found an instance with Identity {$Identity}" $results = @{ Comments = $instance.Comments ExceptIfRecipientDomainIs = $instance.ExceptIfRecipientDomainIs ExceptIfSentTo = $instance.ExceptIfSentTo ExceptIfSentToMemberOf = $instance.ExceptIfSentToMemberOf Identity = $instance.Identity State = $instance.State Name = $instance.Name Priority = $instance.Priority RecipientDomainIs = $instance.RecipientDomainIs SentTo = $instance.SentTo SentToMemberOf = $instance.SentToMemberOf Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint ApplicationSecret = $ApplicationSecret AccessTokens = $AccessTokens } return [System.Collections.Hashtable] $results } catch { New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return $nullResult } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter()] [System.String] $Comments, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo, [Parameter()] [System.String[]] $ExceptIfSentToMemberOf, [Parameter(Mandatory = $true)] [System.Object] $Identity, [Parameter()] [System.String] $State, [Parameter()] [System.String] $Name, [Parameter()] [System.Int32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo, [Parameter()] [System.String[]] $SentToMemberOf, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String[]] $AccessTokens ) New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters | Out-Null #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace('MSFT_', '') $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion $currentInstance = Get-TargetResource @PSBoundParameters $BoundParameters = Remove-M365DSCAuthenticationParameter -BoundParameters $PSBoundParameters if ($Ensure -eq 'Present' -and $currentInstance.Ensure -eq 'Absent') { #following Microsoft recommendation, we will not create new EOPProtectionPolicyRule, instead we will enable the rule if not already done Write-Verbose -Message 'We not create new EOPProtectionPolicyRule if it is not present' } elseif ($Ensure -eq 'Present' -and $currentInstance.Ensure -eq 'Present') { Write-Verbose -Message "Updating {$Identity}" $UpdateParameters = ([Hashtable]$BoundParameters).Clone() $UpdateParameters.Remove('State') | Out-Null $keys = $UpdateParameters.Keys foreach ($key in $keys) { if ($null -ne $UpdateParameters.$key -and $UpdateParameters.$key.GetType().Name -like '*cimInstance*') { $keyValue = Convert-M365DSCDRGComplexTypeToHashtable -ComplexObject $UpdateParameters.$key $UpdateParameters.Remove($key) | Out-Null $UpdateParameters.Add($keyName, $keyValue) } } if ($currentInstance.State -ne $State) { if ($State -eq 'Enabled') { Enable-EOPProtectionPolicyRule -Identity $Identity } else { Disable-EOPProtectionPolicyRule -Identity $Identity } } Set-EOPProtectionPolicyRule @UpdateParameters } elseif ($Ensure -eq 'Absent' -and $currentInstance.Ensure -eq 'Present') { #following Microsoft recommendation, we will not remove EOPProtectionPolicyRules. Write-Verbose -Message 'We will not remove EOPProtectionPolicyRules' } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter()] [System.String] $Comments, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfSentTo, [Parameter()] [System.String[]] $ExceptIfSentToMemberOf, [Parameter(Mandatory = $true)] [System.Object] $Identity, [Parameter()] [System.String] $State, [Parameter()] [System.String] $Name, [Parameter()] [System.Int32] $Priority, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $SentTo, [Parameter()] [System.String[]] $SentToMemberOf, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure, [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String[]] $AccessTokens ) #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace('MSFT_', '') $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion Write-Verbose -Message "Testing configuration of {$Identity}" $CurrentValues = Get-TargetResource @PSBoundParameters $ValuesToCheck = ([Hashtable]$PSBoundParameters).Clone() $ValuesToCheck.Remove('Identity') | Out-Null if ($CurrentValues.Ensure -eq 'Absent') { Write-Verbose -Message "Test-TargetResource returned $false" return $false } Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $ValuesToCheck)" foreach ($key in $ValuesToCheck.Keys) { # Convert any DateTime to String if (($null -ne $CurrentValues[$key]) ` -and ($CurrentValues[$key].GetType().Name -eq 'DateTime')) { $CurrentValues[$key] = $CurrentValues[$key].toString() continue } if ($null -eq $CurrentValues[$key]) { switch -regex ($key) { '^ExceptIf\w+$|^RecipientDomainIs$|^SentTo(\w+)?$' { $CurrentValues[$key] = @() break } } } } $testResult = Test-M365DSCParameterState -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()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.Management.Automation.PSCredential] $ApplicationSecret, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters #Ensure the proper dependencies are installed in the current environment. Confirm-M365DSCDependencies #region Telemetry $ResourceName = $MyInvocation.MyCommand.ModuleName.Replace('MSFT_', '') $CommandName = $MyInvocation.MyCommand $data = Format-M365DSCTelemetryParameters -ResourceName $ResourceName ` -CommandName $CommandName ` -Parameters $PSBoundParameters Add-M365DSCTelemetryEvent -Data $data #endregion try { [array]$getValue = Get-EOPProtectionPolicyRule -ErrorAction Stop $i = 1 $dscContent = '' if ($getValue.Length -eq 0) { Write-Host $Global:M365DSCEmojiGreenCheckMark } else { Write-Host "`r`n" -NoNewline } foreach ($config in $getValue) { if ($null -ne $Global:M365DSCExportResourceInstancesCount) { $Global:M365DSCExportResourceInstancesCount++ } $displayedKey = $config.Identity if (-not [String]::IsNullOrEmpty($config.displayName)) { $displayedKey = $config.displayName } Write-Host " |---[$i/$($getValue.Count)] $displayedKey" -NoNewline $params = @{ Identity = $config.Identity Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint ApplicationSecret = $ApplicationSecret AccessTokens = $AccessTokens } $Results = Get-TargetResource @Params $Results = Update-M365DSCExportAuthenticationResults -ConnectionMode $ConnectionMode ` -Results $Results $currentDSCBlock = Get-M365DSCExportContentForResource -ResourceName $ResourceName ` -ConnectionMode $ConnectionMode ` -ModulePath $PSScriptRoot ` -Results $Results ` -Credential $Credential $dscContent += $currentDSCBlock Save-M365DSCPartialExport -Content $currentDSCBlock ` -FileName $Global:PartialExportFileName $i++ Write-Host $Global:M365DSCEmojiGreenCheckMark } return $dscContent } catch { Write-Host $Global:M365DSCEmojiRedX New-M365DSCLogEntry -Message 'Error during Export:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return '' } } Export-ModuleMember -Function *-TargetResource |