DSCResources/MSFT_EXOTransportRule/MSFT_EXOTransportRule.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.String] $ADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ADComparisonOperator, [Parameter()] [System.String] $ActivationDate, [Parameter()] [ValidateSet('To', 'Cc', 'Bcc', 'Redirect')] [System.String] $AddManagerAsRecipientType, [Parameter()] [System.String[]] $AddToRecipients = @(), [Parameter()] [System.String[]] $AnyOfCcHeader = @(), [Parameter()] [System.String[]] $AnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $AnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $AnyOfToCcHeader = @(), [Parameter()] [System.String[]] $AnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfToHeader = @(), [Parameter()] [System.String[]] $AnyOfToHeaderMemberOf = @(), [Parameter()] [System.String] $ApplyClassification, [Parameter()] [ValidateSet('Wrap', 'Ignore', 'Reject')] [System.String] $ApplyHtmlDisclaimerFallbackAction, [Parameter()] [ValidateSet('Append', 'Prepend')] [System.String] $ApplyHtmlDisclaimerLocation, [Parameter()] [System.String] $ApplyHtmlDisclaimerText, [Parameter()] [System.Boolean] $ApplyOME, [Parameter()] [System.String] $ApplyRightsProtectionCustomizationTemplate, [Parameter()] [System.String] $ApplyRightsProtectionTemplate, [Parameter()] [System.String[]] $AttachmentContainsWords, [Parameter()] [System.String[]] $AttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $AttachmentHasExecutableContent, [Parameter()] [System.Boolean] $AttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $AttachmentIsUnsupported, [Parameter()] [System.String[]] $AttachmentMatchesPatterns, [Parameter()] [System.String[]] $AttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $AttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $AttachmentProcessingLimitExceeded, [Parameter()] [System.String] $AttachmentSizeOver, [Parameter()] [System.String[]] $BetweenMemberOf1 = @(), [Parameter()] [System.String[]] $BetweenMemberOf2 = @(), [Parameter()] [System.String[]] $BlindCopyTo = @(), [Parameter()] [ValidateLength(0, 1024)] [System.String] $Comments, [Parameter()] [System.String[]] $ContentCharacterSetContainsWords, [Parameter()] [System.String[]] $CopyTo = @(), [Parameter()] [System.Boolean] $DeleteMessage, [Parameter()] [System.String] $DlpPolicy, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ExceptIfADComparisonOperator, [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAttachmentContainsWords, [Parameter()] [System.String[]] $ExceptIfAttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentHasExecutableContent, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsUnsupported, [Parameter()] [System.String[]] $ExceptIfAttachmentMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentProcessingLimitExceeded, [Parameter()] [System.String] $ExceptIfAttachmentSizeOver, [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf1 = @(), [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf2 = @(), [Parameter()] [System.String[]] $ExceptIfContentCharacterSetContainsWords = @(), [Parameter()] [System.String[]] $ExceptIfFrom = @(), [Parameter()] [System.String[]] $ExceptIfFromAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfFromAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfFromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $ExceptIfFromScope, [Parameter()] [System.String] $ExceptIfHasClassification, [Parameter()] [System.Boolean] $ExceptIfHasNoClassification, [Parameter()] [System.Boolean] $ExceptIfHasSenderOverride, #DEPRECATED [Parameter()] [System.String] $ExceptIfHeaderContainsMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderContainsWords, [Parameter()] [System.String] $ExceptIfHeaderMatchesMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfManagerAddresses = @(), [Parameter()] [System.String] $ExceptIfManagerForEvaluatedUser, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $ExceptIfMessageTypeMatches, [Parameter()] [System.String[]] $ExceptIfMessageContainsDataClassifications = @(), #DEPRECATED [Parameter()] [System.String] $ExceptIfMessageSizeOver, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfRecipientInSenderList, [Parameter()] [System.String] $ExceptIfSCLOver, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSenderDomainIs, [Parameter()] [System.String[]] $ExceptIfSenderInRecipientList, [Parameter()] [System.String[]] $ExceptIfSenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $ExceptIfSenderManagementRelationship, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $ExceptIfSentToScope, [Parameter()] [System.String[]] $ExceptIfSubjectContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $ExceptIfWithImportance, [Parameter()] [System.String] $ExpiryDate, [Parameter()] [System.String[]] $From = @(), [Parameter()] [System.String[]] $FromAddressContainsWords, [Parameter()] [System.String[]] $FromAddressMatchesPatterns, [Parameter()] [System.String[]] $FromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $FromScope, [Parameter()] [System.String] $GenerateIncidentReport, [Parameter()] [System.String] $GenerateNotification, [Parameter()] [System.String] $HasClassification, [Parameter()] [System.Boolean] $HasNoClassification, [Parameter()] [System.Boolean] $HasSenderOverride, #DEPRECATED [Parameter()] [System.String] $HeaderContainsMessageHeader, [Parameter()] [System.String[]] $HeaderContainsWords, [Parameter()] [System.String] $HeaderMatchesMessageHeader, [Parameter()] [System.String[]] $HeaderMatchesPatterns, [Parameter()] [System.String[]] $IncidentReportContent = @(), [Parameter()] [System.String[]] $ManagerAddresses = @(), [Parameter()] [ValidateSet('Recipient', 'Sender')] [System.String] $ManagerForEvaluatedUser, [Parameter()] [System.String[]] $MessageContainsDataClassifications, #DEPRECATED [Parameter()] [System.String] $MessageSizeOver, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $MessageTypeMatches, [Parameter()] [ValidateSet('Audit', 'AuditAndNotify', 'Enforce')] [System.String] $Mode, [Parameter()] [System.Boolean] $ModerateMessageByManager, [Parameter()] [System.String[]] $ModerateMessageByUser = @(), [Parameter()] [ValidateSet('NotifyOnly', 'RejectMessage', 'RejectUnlessFalsePositiveOverride', 'RejectUnlessSilentOverride', 'RejectUnlessExplicitOverride')] [System.String] $NotifySender, #DEPRECATED [Parameter()] [System.String] $PrependSubject, [Parameter()] [System.UInt32] $Priority, [Parameter()] [System.Boolean] $Quarantine, [Parameter()] [System.String[]] $RecipientADAttributeContainsWords, [Parameter()] [System.String[]] $RecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $RecipientAddressContainsWords, [Parameter()] [System.String[]] $RecipientAddressMatchesPatterns, [Parameter()] [ValidateSet('Original', 'Resolved')] [System.String] $RecipientAddressType, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $RecipientInSenderList, [Parameter()] [System.String[]] $RedirectMessageTo = @(), [Parameter()] [System.String] $RejectMessageEnhancedStatusCode, [Parameter()] [System.String] $RejectMessageReasonText, [Parameter()] [System.String] $RemoveHeader, [Parameter()] [System.Boolean] $RemoveOME, [Parameter()] [System.Boolean] $RemoveOMEv2, [Parameter()] [System.Boolean] $RemoveRMSAttachmentEncryption, [Parameter()] [System.String] $RouteMessageOutboundConnector, [Parameter()] [System.Boolean] $RouteMessageOutboundRequireTls, [Parameter()] [ValidateSet('Ignore', 'Defer')] [System.String] $RuleErrorAction, [Parameter()] [ValidateSet('Dlp', 'None')] [System.String] $RuleSubType, [Parameter()] [System.String] $SCLOver, [Parameter()] [System.String[]] $SenderADAttributeContainsWords, [Parameter()] [System.String[]] $SenderADAttributeMatchesPatterns, [Parameter()] [ValidateSet('Header', 'Envelope', 'HeaderOrEnvelope')] [System.String] $SenderAddressLocation, [Parameter()] [System.String[]] $SenderDomainIs, [Parameter()] [System.String[]] $SenderInRecipientList, [Parameter()] [System.String[]] $SenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $SenderManagementRelationship, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $SentToScope, [Parameter()] [ValidateSet('DoNotAudit', 'Low', 'Medium', 'High')] [System.String] $SetAuditSeverity, [Parameter()] [System.String] $SetHeaderName, [Parameter()] [System.String] $SetHeaderValue, [Parameter()] [System.String] $SetSCL, [Parameter()] [System.Boolean] $StopRuleProcessing, [Parameter()] [System.String[]] $SubjectContainsWords, [Parameter()] [System.String[]] $SubjectMatchesPatterns, [Parameter()] [System.String[]] $SubjectOrBodyContainsWords, [Parameter()] [System.String[]] $SubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $WithImportance, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message "Getting Transport Rule configuration for $Name" if ($Global:CurrentModeIsExport) { $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true } else { $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 $TransportRule = Get-TransportRule -Identity $Name -ErrorAction 'SilentlyContinue' try { if ($null -eq $TransportRule) { Write-Verbose -Message "Transport Rule $($Name) does not exist." $nullReturn = $PSBoundParameters $nullReturn.Ensure = 'Absent' return $nullReturn } else { $MessageContainsDataClassificationsValue = $null if ($null -ne $TransportRule.MessageContainsDataClassifications) { $MessageContainsDataClassificationsValue = $TransportRule.MessageContainsDataClassifications.Replace('"', "'") } if ($TransportRule.State -eq 'Enabled') { $enabled = $true } else { $enabled = $false } $result = @{ Name = $TransportRule.Name ADComparisonAttribute = $TransportRule.ADComparisonAttribute ADComparisonOperator = $TransportRule.ADComparisonOperator ActivationDate = $TransportRule.ActivationDate AddManagerAsRecipientType = $TransportRule.AddManagerAsRecipientType AddToRecipients = $TransportRule.AddToRecipients AnyOfCcHeader = $TransportRule.AnyOfCcHeader AnyOfCcHeaderMemberOf = $TransportRule.AnyOfCcHeaderMemberOf AnyOfRecipientAddressContainsWords = $TransportRule.AnyOfRecipientAddressContainsWords AnyOfRecipientAddressMatchesPatterns = $TransportRule.AnyOfRecipientAddressMatchesPatterns AnyOfToCcHeader = $TransportRule.AnyOfToCcHeader AnyOfToCcHeaderMemberOf = $TransportRule.AnyOfToCcHeaderMemberOf AnyOfToHeader = $TransportRule.AnyOfToHeader AnyOfToHeaderMemberOf = $TransportRule.AnyOfToHeaderMemberOf ApplyClassification = $TransportRule.ApplyClassification ApplyHtmlDisclaimerFallbackAction = $TransportRule.ApplyHtmlDisclaimerFallbackAction ApplyHtmlDisclaimerLocation = $TransportRule.ApplyHtmlDisclaimerLocation ApplyHtmlDisclaimerText = $TransportRule.ApplyHtmlDisclaimerText ApplyOME = $TransportRule.ApplyOME ApplyRightsProtectionCustomizationTemplate = $TransportRule.ApplyRightsProtectionCustomizationTemplate ApplyRightsProtectionTemplate = $TransportRule.ApplyRightsProtectionTemplate AttachmentContainsWords = $TransportRule.AttachmentContainsWords AttachmentExtensionMatchesWords = $TransportRule.AttachmentExtensionMatchesWords AttachmentHasExecutableContent = $TransportRule.AttachmentHasExecutableContent AttachmentIsPasswordProtected = $TransportRule.AttachmentIsPasswordProtected AttachmentIsUnsupported = $TransportRule.AttachmentIsUnsupported AttachmentMatchesPatterns = $TransportRule.AttachmentMatchesPatterns AttachmentNameMatchesPatterns = $TransportRule.AttachmentNameMatchesPatterns AttachmentPropertyContainsWords = $TransportRule.AttachmentPropertyContainsWords AttachmentProcessingLimitExceeded = $TransportRule.AttachmentProcessingLimitExceeded AttachmentSizeOver = $TransportRule.AttachmentSizeOver BetweenMemberOf1 = $TransportRule.BetweenMemberOf1 BetweenMemberOf2 = $TransportRule.BetweenMemberOf2 BlindCopyTo = $TransportRule.BlindCopyTo Comments = $TransportRule.Comments ContentCharacterSetContainsWords = $TransportRule.ContentCharacterSetContainsWords CopyTo = $TransportRule.CopyTo DeleteMessage = $TransportRule.DeleteMessage DlpPolicy = $TransportRule.DlpPolicy Enabled = $enabled ExceptIfADComparisonAttribute = $TransportRule.ExceptIfADComparisonAttribute ExceptIfADComparisonOperator = $TransportRule.ExceptIfADComparisonOperator ExceptIfAnyOfCcHeader = $TransportRule.ExceptIfAnyOfCcHeader ExceptIfAnyOfCcHeaderMemberOf = $TransportRule.ExceptIfAnyOfCcHeaderMemberOf ExceptIfAnyOfRecipientAddressContainsWords = $TransportRule.ExceptIfAnyOfRecipientAddressContainsWords ExceptIfAnyOfRecipientAddressMatchesPatterns = $TransportRule.ExceptIfAnyOfRecipientAddressMatchesPatterns ExceptIfAnyOfToCcHeader = $TransportRule.ExceptIfAnyOfToCcHeader ExceptIfAnyOfToCcHeaderMemberOf = $TransportRule.ExceptIfAnyOfToCcHeaderMemberOf ExceptIfAnyOfToHeader = $TransportRule.ExceptIfAnyOfToHeader ExceptIfAnyOfToHeaderMemberOf = $TransportRule.ExceptIfAnyOfToHeaderMemberOf ExceptIfAttachmentContainsWords = $TransportRule.ExceptIfAttachmentContainsWords ExceptIfAttachmentExtensionMatchesWords = $TransportRule.ExceptIfAttachmentExtensionMatchesWords ExceptIfAttachmentHasExecutableContent = $TransportRule.ExceptIfAttachmentHasExecutableContent ExceptIfAttachmentIsPasswordProtected = $TransportRule.ExceptIfAttachmentIsPasswordProtected ExceptIfAttachmentIsUnsupported = $TransportRule.ExceptIfAttachmentIsUnsupported ExceptIfAttachmentMatchesPatterns = $TransportRule.ExceptIfAttachmentMatchesPatterns ExceptIfAttachmentNameMatchesPatterns = $TransportRule.ExceptIfAttachmentNameMatchesPatterns ExceptIfAttachmentPropertyContainsWords = $TransportRule.ExceptIfAttachmentPropertyContainsWords ExceptIfAttachmentProcessingLimitExceeded = $TransportRule.ExceptIfAttachmentProcessingLimitExceeded ExceptIfAttachmentSizeOver = $TransportRule.ExceptIfAttachmentSizeOver ExceptIfBetweenMemberOf1 = $TransportRule.ExceptIfBetweenMemberOf1 ExceptIfBetweenMemberOf2 = $TransportRule.ExceptIfBetweenMemberOf2 ExceptIfContentCharacterSetContainsWords = $TransportRule.ExceptIfContentCharacterSetContainsWords ExceptIfFrom = $TransportRule.ExceptIfFrom ExceptIfFromAddressContainsWords = $TransportRule.ExceptIfFromAddressContainsWords ExceptIfFromAddressMatchesPatterns = $TransportRule.ExceptIfFromAddressMatchesPatterns ExceptIfFromMemberOf = $TransportRule.ExceptIfFromMemberOf ExceptIfFromScope = $TransportRule.ExceptIfFromScope ExceptIfHasClassification = $TransportRule.ExceptIfHasClassification ExceptIfHasNoClassification = $TransportRule.ExceptIfHasNoClassification ExceptIfHeaderContainsMessageHeader = $TransportRule.ExceptIfHeaderContainsMessageHeader ExceptIfHeaderContainsWords = $TransportRule.ExceptIfHeaderContainsWords ExceptIfHeaderMatchesMessageHeader = $TransportRule.ExceptIfHeaderMatchesMessageHeader ExceptIfHeaderMatchesPatterns = $TransportRule.ExceptIfHeaderMatchesPatterns ExceptIfManagerAddresses = $TransportRule.ExceptIfManagerAddresses ExceptIfManagerForEvaluatedUser = $TransportRule.ExceptIfManagerForEvaluatedUser ExceptIfMessageTypeMatches = $TransportRule.ExceptIfMessageTypeMatches ExceptIfMessageSizeOver = $TransportRule.ExceptIfMessageSizeOver ExceptIfRecipientADAttributeContainsWords = $TransportRule.ExceptIfRecipientADAttributeContainsWords ExceptIfRecipientADAttributeMatchesPatterns = $TransportRule.ExceptIfRecipientADAttributeMatchesPatterns ExceptIfRecipientAddressContainsWords = $TransportRule.ExceptIfRecipientAddressContainsWords ExceptIfRecipientAddressMatchesPatterns = $TransportRule.ExceptIfRecipientAddressMatchesPatterns ExceptIfRecipientDomainIs = $TransportRule.ExceptIfRecipientDomainIs ExceptIfRecipientInSenderList = $TransportRule.ExceptIfRecipientInSenderList ExceptIfSCLOver = $TransportRule.ExceptIfSCLOver ExceptIfSenderADAttributeContainsWords = $TransportRule.ExceptIfSenderADAttributeContainsWords ExceptIfSenderADAttributeMatchesPatterns = $TransportRule.ExceptIfSenderADAttributeMatchesPatterns ExceptIfSenderDomainIs = $TransportRule.ExceptIfSenderDomainIs ExceptIfSenderInRecipientList = $TransportRule.ExceptIfSenderInRecipientList ExceptIfSenderIpRanges = $TransportRule.ExceptIfSenderIpRanges ExceptIfSenderManagementRelationship = $TransportRule.ExceptIfSenderManagementRelationship ExceptIfSentTo = $TransportRule.ExceptIfSentTo ExceptIfSentToMemberOf = $TransportRule.ExceptIfSentToMemberOf ExceptIfSentToScope = $TransportRule.ExceptIfSentToScope ExceptIfSubjectContainsWords = $TransportRule.ExceptIfSubjectContainsWords ExceptIfSubjectMatchesPatterns = $TransportRule.ExceptIfSubjectMatchesPatterns ExceptIfSubjectOrBodyContainsWords = $TransportRule.ExceptIfSubjectOrBodyContainsWords ExceptIfSubjectOrBodyMatchesPatterns = $TransportRule.ExceptIfSubjectOrBodyMatchesPatterns ExceptIfWithImportance = $TransportRule.ExceptIfWithImportance ExpiryDate = $TransportRule.ExpiryDate From = $TransportRule.From FromAddressContainsWords = $TransportRule.FromAddressContainsWords FromAddressMatchesPatterns = $TransportRule.FromAddressMatchesPatterns FromMemberOf = $TransportRule.FromMemberOf FromScope = $TransportRule.FromScope GenerateIncidentReport = $TransportRule.GenerateIncidentReport GenerateNotification = $TransportRule.GenerateNotification HasClassification = $TransportRule.HasClassification HasNoClassification = $TransportRule.HasNoClassification HeaderContainsMessageHeader = $TransportRule.HeaderContainsMessageHeader HeaderContainsWords = $TransportRule.HeaderContainsWords HeaderMatchesMessageHeader = $TransportRule.HeaderMatchesMessageHeader HeaderMatchesPatterns = $TransportRule.HeaderMatchesPatterns IncidentReportContent = $TransportRule.IncidentReportContent ManagerAddresses = $TransportRule.ManagerAddresses ManagerForEvaluatedUser = $TransportRule.ManagerForEvaluatedUser MessageSizeOver = $TransportRule.MessageSizeOver MessageTypeMatches = $TransportRule.MessageTypeMatches Mode = $TransportRule.Mode ModerateMessageByManager = $TransportRule.ModerateMessageByManager ModerateMessageByUser = $TransportRule.ModerateMessageByUser PrependSubject = $TransportRule.PrependSubject Priority = $TransportRule.Priority Quarantine = $TransportRule.Quarantine RecipientADAttributeContainsWords = $TransportRule.RecipientADAttributeContainsWords RecipientADAttributeMatchesPatterns = $TransportRule.RecipientADAttributeMatchesPatterns RecipientAddressContainsWords = $TransportRule.RecipientAddressContainsWords RecipientAddressMatchesPatterns = $TransportRule.RecipientAddressMatchesPatterns RecipientAddressType = $TransportRule.RecipientAddressType RecipientDomainIs = $TransportRule.RecipientDomainIs RecipientInSenderList = $TransportRule.RecipientInSenderList RedirectMessageTo = $TransportRule.RedirectMessageTo RejectMessageEnhancedStatusCode = $TransportRule.RejectMessageEnhancedStatusCode RejectMessageReasonText = $TransportRule.RejectMessageReasonText RemoveHeader = $TransportRule.RemoveHeader RemoveOME = $TransportRule.RemoveOME RemoveOMEv2 = $TransportRule.RemoveOMEv2 RemoveRMSAttachmentEncryption = $TransportRule.RemoveRMSAttachmentEncryption RouteMessageOutboundConnector = $TransportRule.RouteMessageOutboundConnector RouteMessageOutboundRequireTls = $TransportRule.RouteMessageOutboundRequireTls RuleErrorAction = $TransportRule.RuleErrorAction RuleSubType = $TransportRule.RuleSubType SCLOver = $TransportRule.SCLOver SenderADAttributeContainsWords = $TransportRule.SenderADAttributeContainsWords SenderADAttributeMatchesPatterns = $TransportRule.SenderADAttributeMatchesPatterns SenderAddressLocation = $TransportRule.SenderAddressLocation SenderDomainIs = $TransportRule.SenderDomainIs SenderInRecipientList = $TransportRule.SenderInRecipientList SenderIpRanges = $TransportRule.SenderIpRanges SenderManagementRelationship = $TransportRule.SenderManagementRelationship SentTo = $TransportRule.SentTo SentToMemberOf = $TransportRule.SentToMemberOf SentToScope = $TransportRule.SentToScope SetAuditSeverity = $TransportRule.SetAuditSeverity SetHeaderName = $TransportRule.SetHeaderName SetHeaderValue = $TransportRule.SetHeaderValue SetSCL = $TransportRule.SetSCL StopRuleProcessing = $TransportRule.StopRuleProcessing SubjectContainsWords = $TransportRule.SubjectContainsWords SubjectMatchesPatterns = $TransportRule.SubjectMatchesPatterns SubjectOrBodyContainsWords = $TransportRule.SubjectOrBodyContainsWords SubjectOrBodyMatchesPatterns = $TransportRule.SubjectOrBodyMatchesPatterns WithImportance = $TransportRule.WithImportance Ensure = 'Present' Credential = $Credential ApplicationId = $ApplicationId CertificateThumbprint = $CertificateThumbprint CertificatePath = $CertificatePath CertificatePassword = $CertificatePassword Managedidentity = $ManagedIdentity.IsPresent TenantId = $TenantId AccessTokens = $AccessTokens } $inputParams = (Get-Command 'Get-TargetResource').Parameters foreach ($key in $inputParams.Keys) { $propertyInfo = $inputParams.$key $curVar = Get-Variable -Name $key -ErrorAction SilentlyContinue if ($propertyInfo.ParameterType.Name -eq 'String[]' -and $curVar -ne $null -and $curVar.Value -eq $null) { $result.$key = @() } } # Formats DateTime as String if ($null -ne $result.ActivationDate) { $result.ActivationDate = $TransportRule.ActivationDate.ToUniversalTime().ToString() } if ($null -ne $result.ExpiryDate) { $result.ExpiryDate = $TransportRule.ExpiryDate.ToUniversalTime().ToString() } Write-Verbose -Message "Found Transport Rule $($Name)" return $result } } catch { New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return $nullReturn } } function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.String] $ADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ADComparisonOperator, [Parameter()] [System.String] $ActivationDate, [Parameter()] [ValidateSet('To', 'Cc', 'Bcc', 'Redirect')] [System.String] $AddManagerAsRecipientType, [Parameter()] [System.String[]] $AddToRecipients = @(), [Parameter()] [System.String[]] $AnyOfCcHeader = @(), [Parameter()] [System.String[]] $AnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $AnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $AnyOfToCcHeader = @(), [Parameter()] [System.String[]] $AnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfToHeader = @(), [Parameter()] [System.String[]] $AnyOfToHeaderMemberOf = @(), [Parameter()] [System.String] $ApplyClassification, [Parameter()] [ValidateSet('Wrap', 'Ignore', 'Reject')] [System.String] $ApplyHtmlDisclaimerFallbackAction, [Parameter()] [ValidateSet('Append', 'Prepend')] [System.String] $ApplyHtmlDisclaimerLocation, [Parameter()] [System.String] $ApplyHtmlDisclaimerText, [Parameter()] [System.Boolean] $ApplyOME, [Parameter()] [System.String] $ApplyRightsProtectionCustomizationTemplate, [Parameter()] [System.String] $ApplyRightsProtectionTemplate, [Parameter()] [System.String[]] $AttachmentContainsWords, [Parameter()] [System.String[]] $AttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $AttachmentHasExecutableContent, [Parameter()] [System.Boolean] $AttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $AttachmentIsUnsupported, [Parameter()] [System.String[]] $AttachmentMatchesPatterns, [Parameter()] [System.String[]] $AttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $AttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $AttachmentProcessingLimitExceeded, [Parameter()] [System.String] $AttachmentSizeOver, [Parameter()] [System.String[]] $BetweenMemberOf1 = @(), [Parameter()] [System.String[]] $BetweenMemberOf2 = @(), [Parameter()] [System.String[]] $BlindCopyTo = @(), [Parameter()] [ValidateLength(0, 1024)] [System.String] $Comments, [Parameter()] [System.String[]] $ContentCharacterSetContainsWords, [Parameter()] [System.String[]] $CopyTo = @(), [Parameter()] [System.Boolean] $DeleteMessage, [Parameter()] [System.String] $DlpPolicy, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ExceptIfADComparisonOperator, [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAttachmentContainsWords, [Parameter()] [System.String[]] $ExceptIfAttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentHasExecutableContent, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsUnsupported, [Parameter()] [System.String[]] $ExceptIfAttachmentMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentProcessingLimitExceeded, [Parameter()] [System.String] $ExceptIfAttachmentSizeOver, [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf1 = @(), [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf2 = @(), [Parameter()] [System.String[]] $ExceptIfContentCharacterSetContainsWords = @(), [Parameter()] [System.String[]] $ExceptIfFrom = @(), [Parameter()] [System.String[]] $ExceptIfFromAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfFromAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfFromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $ExceptIfFromScope, [Parameter()] [System.String] $ExceptIfHasClassification, [Parameter()] [System.Boolean] $ExceptIfHasNoClassification, [Parameter()] [System.Boolean] $ExceptIfHasSenderOverride, #DEPRECATED [Parameter()] [System.String] $ExceptIfHeaderContainsMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderContainsWords, [Parameter()] [System.String] $ExceptIfHeaderMatchesMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfManagerAddresses = @(), [Parameter()] [System.String] $ExceptIfManagerForEvaluatedUser, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $ExceptIfMessageTypeMatches, [Parameter()] [System.String[]] $ExceptIfMessageContainsDataClassifications = @(), #DEPRECATED [Parameter()] [System.String] $ExceptIfMessageSizeOver, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfRecipientInSenderList, [Parameter()] [System.String] $ExceptIfSCLOver, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSenderDomainIs, [Parameter()] [System.String[]] $ExceptIfSenderInRecipientList, [Parameter()] [System.String[]] $ExceptIfSenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $ExceptIfSenderManagementRelationship, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $ExceptIfSentToScope, [Parameter()] [System.String[]] $ExceptIfSubjectContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $ExceptIfWithImportance, [Parameter()] [System.String] $ExpiryDate, [Parameter()] [System.String[]] $From = @(), [Parameter()] [System.String[]] $FromAddressContainsWords, [Parameter()] [System.String[]] $FromAddressMatchesPatterns, [Parameter()] [System.String[]] $FromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $FromScope, [Parameter()] [System.String] $GenerateIncidentReport, [Parameter()] [System.String] $GenerateNotification, [Parameter()] [System.String] $HasClassification, [Parameter()] [System.Boolean] $HasNoClassification, [Parameter()] [System.Boolean] $HasSenderOverride, #DEPRECATED [Parameter()] [System.String] $HeaderContainsMessageHeader, [Parameter()] [System.String[]] $HeaderContainsWords, [Parameter()] [System.String] $HeaderMatchesMessageHeader, [Parameter()] [System.String[]] $HeaderMatchesPatterns, [Parameter()] [System.String[]] $IncidentReportContent = @(), [Parameter()] [System.String[]] $ManagerAddresses = @(), [Parameter()] [ValidateSet('Recipient', 'Sender')] [System.String] $ManagerForEvaluatedUser, [Parameter()] [System.String[]] $MessageContainsDataClassifications, #DEPRECATED [Parameter()] [System.String] $MessageSizeOver, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $MessageTypeMatches, [Parameter()] [ValidateSet('Audit', 'AuditAndNotify', 'Enforce')] [System.String] $Mode, [Parameter()] [System.Boolean] $ModerateMessageByManager, [Parameter()] [System.String[]] $ModerateMessageByUser = @(), [Parameter()] [ValidateSet('NotifyOnly', 'RejectMessage', 'RejectUnlessFalsePositiveOverride', 'RejectUnlessSilentOverride', 'RejectUnlessExplicitOverride')] [System.String] $NotifySender, #DEPRECATED [Parameter()] [System.String] $PrependSubject, [Parameter()] [System.UInt32] $Priority, [Parameter()] [System.Boolean] $Quarantine, [Parameter()] [System.String[]] $RecipientADAttributeContainsWords, [Parameter()] [System.String[]] $RecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $RecipientAddressContainsWords, [Parameter()] [System.String[]] $RecipientAddressMatchesPatterns, [Parameter()] [ValidateSet('Original', 'Resolved')] [System.String] $RecipientAddressType, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $RecipientInSenderList, [Parameter()] [System.String[]] $RedirectMessageTo = @(), [Parameter()] [System.String] $RejectMessageEnhancedStatusCode, [Parameter()] [System.String] $RejectMessageReasonText, [Parameter()] [System.String] $RemoveHeader, [Parameter()] [System.Boolean] $RemoveOME, [Parameter()] [System.Boolean] $RemoveOMEv2, [Parameter()] [System.Boolean] $RemoveRMSAttachmentEncryption, [Parameter()] [System.String] $RouteMessageOutboundConnector, [Parameter()] [System.Boolean] $RouteMessageOutboundRequireTls, [Parameter()] [ValidateSet('Ignore', 'Defer')] [System.String] $RuleErrorAction, [Parameter()] [ValidateSet('Dlp', 'None')] [System.String] $RuleSubType, [Parameter()] [System.String] $SCLOver, [Parameter()] [System.String[]] $SenderADAttributeContainsWords, [Parameter()] [System.String[]] $SenderADAttributeMatchesPatterns, [Parameter()] [ValidateSet('Header', 'Envelope', 'HeaderOrEnvelope')] [System.String] $SenderAddressLocation, [Parameter()] [System.String[]] $SenderDomainIs, [Parameter()] [System.String[]] $SenderInRecipientList, [Parameter()] [System.String[]] $SenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $SenderManagementRelationship, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $SentToScope, [Parameter()] [ValidateSet('DoNotAudit', 'Low', 'Medium', 'High')] [System.String] $SetAuditSeverity, [Parameter()] [System.String] $SetHeaderName, [Parameter()] [System.String] $SetHeaderValue, [Parameter()] [System.String] $SetSCL, [Parameter()] [System.Boolean] $StopRuleProcessing, [Parameter()] [System.String[]] $SubjectContainsWords, [Parameter()] [System.String[]] $SubjectMatchesPatterns, [Parameter()] [System.String[]] $SubjectOrBodyContainsWords, [Parameter()] [System.String[]] $SubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $WithImportance, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) Write-Verbose -Message "Setting Transport Rule configuration for $Name" $currentTransportRuleConfig = Get-TargetResource @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 $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' -InboundParameters $PSBoundParameters $NewTransportRuleParams = [System.Collections.Hashtable]($PSBoundParameters) $NewTransportRuleParams.Remove('Ensure') | Out-Null $NewTransportRuleParams.Remove('Credential') | Out-Null $NewTransportRuleParams.Remove('MakeDefault') | Out-Null $NewTransportRuleParams.Remove('ApplicationId') | Out-Null $NewTransportRuleParams.Remove('TenantId') | Out-Null $NewTransportRuleParams.Remove('CertificateThumbprint') | Out-Null $NewTransportRuleParams.Remove('CertificatePath') | Out-Null $NewTransportRuleParams.Remove('CertificatePassword') | Out-Null $NewTransportRuleParams.Remove('ManagedIdentity') | Out-Null $NewTransportRuleParams.Remove('AccessTokens') | Out-Null # check for deprecated DLP parameters and remove them if ($NewTransportRuleParams.ContainsKey('MessageContainsDataClassifications') ` -or $NewTransportRuleParams.ContainsKey('ExceptIfMessageContainsDataClassifications') ` -or $NewTransportRuleParams.ContainsKey('HasSenderOverride') ` -or $NewTransportRuleParams.ContainsKey('ExceptIfHasSenderOverride') ` -or $NewTransportRuleParams.ContainsKey('NotifySender')) { $NewTransportRuleParams.Remove('MessageContainsDataClassifications') | Out-Null $NewTransportRuleParams.Remove('ExceptIfMessageContainsDataClassifications') | Out-Null $NewTransportRuleParams.Remove('HasSenderOverride') | Out-Null $NewTransportRuleParams.Remove('ExceptIfHasSenderOverride') | Out-Null $NewTransportRuleParams.Remove('NotifySender') | Out-Null Write-Verbose -Message 'DEPRECATED - The DLP parameters (MessageContainsDataClassifications, ExceptIfMessageContainsDataClassifications, ExceptIfHasSenderOverride, HasSenderOverride and NotifySender) are deprecated and will be ignored.' } $SetTransportRuleParams = $NewTransportRuleParams.Clone() $SetTransportRuleParams.Add('Identity', $Name) $SetTransportRuleParams.Remove('Enabled') | Out-Null # CASE: Transport Rule doesn't exist but should; if ($Ensure -eq 'Present' -and $currentTransportRuleConfig.Ensure -eq 'Absent') { Write-Verbose -Message "Transport Rule '$($Name)' does not exist but it should. Create and configure it." $nullKeysToRemove = @() foreach ($key in $NewTransportRuleParams.Keys) { if ($NewTransportRuleParams.$key.GetType().Name -eq 'String[]' -and $NewTransportRuleParams.$key.Length -eq 0) { $nullKeysToRemove += $key } } foreach ($paramToRemove in $nullKeysToRemove) { $NewTransportRuleParams.Remove($paramToRemove) | Out-Null } # Create Transport Rule New-TransportRule @NewTransportRuleParams } # CASE: Transport Rule exists but it shouldn't; elseif ($Ensure -eq 'Absent' -and $currentTransportRuleConfig.Ensure -eq 'Present') { Write-Verbose -Message "Transport Rule '$($Name)' exists but it shouldn't. Remove it." Remove-TransportRule -Identity $Name -Confirm:$false } # CASE: Transport Rule exists and it should, but has different values than the desired ones elseif ($Ensure -eq 'Present' -and $currentTransportRuleConfig.Ensure -eq 'Present') { if ($null -ne $HeaderContainsMessageHeader -and $null -eq $currentTransportRuleConfig.HeaderContainsMessageHeader) { $SetTransportRuleParams.Add("HeaderContainsMessageHeader",$null) } if ($null -ne $HeaderMatchesPatterns -and $null -eq $currentTransportRuleConfig.HeaderMatchesMessageHeader) { $SetTransportRuleParams.Add("HeaderMatchesMessageHeader",$null) } if ($null -ne $ExceptIfHeaderContainsWords -and $null -eq $currentTransportRuleConfig.ExceptIfHeaderContainsMessageHeader) { $SetTransportRuleParams.Add("ExceptIfHeaderContainsMessageHeader",$null) } if ($null -ne $ExceptIfHeaderMatchesPatterns -and $null -eq $currentTransportRuleConfig.ExceptIfHeaderMatchesMessageHeader) { $SetTransportRuleParams.Add("ExceptIfHeaderMatchesMessageHeader",$null) } if ($null -ne $ApplyOME) { Write-Warning -Message "ApplyOME is deprecated. Use ApplyRightsProtectionTemplate instead." $SetTransportRuleParams.Remove("ApplyOME") | Out-Null } if ($null -ne $RemoveOME) { Write-Warning -Message "RemoveOME is deprecated. Use RemoveOMEv2 instead." $SetTransportRuleParams.Remove("RemoveOME") | Out-Null } Write-Verbose -Message "Transport Rule '$($Name)' already exists, but needs updating." Write-Verbose -Message "Setting Transport Rule $($Name) with values: $(Convert-M365DscHashtableToString -Hashtable $SetTransportRuleParams)" Set-TransportRule @SetTransportRuleParams } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateLength(1, 64)] [System.String] $Name, [Parameter()] [System.String] $ADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ADComparisonOperator, [Parameter()] [System.String] $ActivationDate, [Parameter()] [ValidateSet('To', 'Cc', 'Bcc', 'Redirect')] [System.String] $AddManagerAsRecipientType, [Parameter()] [System.String[]] $AddToRecipients = @(), [Parameter()] [System.String[]] $AnyOfCcHeader = @(), [Parameter()] [System.String[]] $AnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $AnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $AnyOfToCcHeader = @(), [Parameter()] [System.String[]] $AnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $AnyOfToHeader = @(), [Parameter()] [System.String[]] $AnyOfToHeaderMemberOf = @(), [Parameter()] [System.String] $ApplyClassification, [Parameter()] [ValidateSet('Wrap', 'Ignore', 'Reject')] [System.String] $ApplyHtmlDisclaimerFallbackAction, [Parameter()] [ValidateSet('Append', 'Prepend')] [System.String] $ApplyHtmlDisclaimerLocation, [Parameter()] [System.String] $ApplyHtmlDisclaimerText, [Parameter()] [System.Boolean] $ApplyOME, [Parameter()] [System.String] $ApplyRightsProtectionCustomizationTemplate, [Parameter()] [System.String] $ApplyRightsProtectionTemplate, [Parameter()] [System.String[]] $AttachmentContainsWords, [Parameter()] [System.String[]] $AttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $AttachmentHasExecutableContent, [Parameter()] [System.Boolean] $AttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $AttachmentIsUnsupported, [Parameter()] [System.String[]] $AttachmentMatchesPatterns, [Parameter()] [System.String[]] $AttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $AttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $AttachmentProcessingLimitExceeded, [Parameter()] [System.String] $AttachmentSizeOver, [Parameter()] [System.String[]] $BetweenMemberOf1 = @(), [Parameter()] [System.String[]] $BetweenMemberOf2 = @(), [Parameter()] [System.String[]] $BlindCopyTo = @(), [Parameter()] [ValidateLength(0, 1024)] [System.String] $Comments, [Parameter()] [System.String[]] $ContentCharacterSetContainsWords, [Parameter()] [System.String[]] $CopyTo = @(), [Parameter()] [System.Boolean] $DeleteMessage, [Parameter()] [System.String] $DlpPolicy, [Parameter()] [System.Boolean] $Enabled, [Parameter()] [System.String] $ExceptIfADComparisonAttribute, [Parameter()] [ValidateSet('Equal', 'NotEqual')] [System.String] $ExceptIfADComparisonOperator, [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfAnyOfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToCcHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeader = @(), [Parameter()] [System.String[]] $ExceptIfAnyOfToHeaderMemberOf = @(), [Parameter()] [System.String[]] $ExceptIfAttachmentContainsWords, [Parameter()] [System.String[]] $ExceptIfAttachmentExtensionMatchesWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentHasExecutableContent, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsPasswordProtected, [Parameter()] [System.Boolean] $ExceptIfAttachmentIsUnsupported, [Parameter()] [System.String[]] $ExceptIfAttachmentMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentNameMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfAttachmentPropertyContainsWords, [Parameter()] [System.Boolean] $ExceptIfAttachmentProcessingLimitExceeded, [Parameter()] [System.String] $ExceptIfAttachmentSizeOver, [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf1 = @(), [Parameter()] [System.String[]] $ExceptIfBetweenMemberOf2 = @(), [Parameter()] [System.String[]] $ExceptIfContentCharacterSetContainsWords = @(), [Parameter()] [System.String[]] $ExceptIfFrom = @(), [Parameter()] [System.String[]] $ExceptIfFromAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfFromAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfFromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $ExceptIfFromScope, [Parameter()] [System.String] $ExceptIfHasClassification, [Parameter()] [System.Boolean] $ExceptIfHasNoClassification, [Parameter()] [System.Boolean] $ExceptIfHasSenderOverride, #DEPRECATED [Parameter()] [System.String] $ExceptIfHeaderContainsMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderContainsWords, [Parameter()] [System.String] $ExceptIfHeaderMatchesMessageHeader, [Parameter()] [System.String[]] $ExceptIfHeaderMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfManagerAddresses = @(), [Parameter()] [System.String] $ExceptIfManagerForEvaluatedUser, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $ExceptIfMessageTypeMatches, [Parameter()] [System.String[]] $ExceptIfMessageContainsDataClassifications = @(), #DEPRECATED [Parameter()] [System.String] $ExceptIfMessageSizeOver, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientAddressContainsWords, [Parameter()] [System.String[]] $ExceptIfRecipientAddressMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfRecipientDomainIs, [Parameter()] [System.String[]] $ExceptIfRecipientInSenderList, [Parameter()] [System.String] $ExceptIfSCLOver, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeContainsWords, [Parameter()] [System.String[]] $ExceptIfSenderADAttributeMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSenderDomainIs, [Parameter()] [System.String[]] $ExceptIfSenderInRecipientList, [Parameter()] [System.String[]] $ExceptIfSenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $ExceptIfSenderManagementRelationship, [Parameter()] [System.String[]] $ExceptIfSentTo = @(), [Parameter()] [System.String[]] $ExceptIfSentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $ExceptIfSentToScope, [Parameter()] [System.String[]] $ExceptIfSubjectContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectMatchesPatterns, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyContainsWords, [Parameter()] [System.String[]] $ExceptIfSubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $ExceptIfWithImportance, [Parameter()] [System.String] $ExpiryDate, [Parameter()] [System.String[]] $From = @(), [Parameter()] [System.String[]] $FromAddressContainsWords, [Parameter()] [System.String[]] $FromAddressMatchesPatterns, [Parameter()] [System.String[]] $FromMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization')] [System.String] $FromScope, [Parameter()] [System.String] $GenerateIncidentReport, [Parameter()] [System.String] $GenerateNotification, [Parameter()] [System.String] $HasClassification, [Parameter()] [System.Boolean] $HasNoClassification, [Parameter()] [System.Boolean] $HasSenderOverride, #DEPRECATED [Parameter()] [System.String] $HeaderContainsMessageHeader, [Parameter()] [System.String[]] $HeaderContainsWords, [Parameter()] [System.String] $HeaderMatchesMessageHeader, [Parameter()] [System.String[]] $HeaderMatchesPatterns, [Parameter()] [System.String[]] $IncidentReportContent = @(), [Parameter()] [System.String[]] $ManagerAddresses = @(), [Parameter()] [ValidateSet('Recipient', 'Sender')] [System.String] $ManagerForEvaluatedUser, [Parameter()] [System.String[]] $MessageContainsDataClassifications, #DEPRECATED [Parameter()] [System.String] $MessageSizeOver, [Parameter()] [ValidateSet('OOF', 'AutoForward', 'Encrypted', 'Calendaring', 'PermissionControlled', 'Voicemail', 'Signed', 'ApprovalRequest', 'ReadReceipt')] [System.String] $MessageTypeMatches, [Parameter()] [ValidateSet('Audit', 'AuditAndNotify', 'Enforce')] [System.String] $Mode, [Parameter()] [System.Boolean] $ModerateMessageByManager, [Parameter()] [System.String[]] $ModerateMessageByUser = @(), [Parameter()] [ValidateSet('NotifyOnly', 'RejectMessage', 'RejectUnlessFalsePositiveOverride', 'RejectUnlessSilentOverride', 'RejectUnlessExplicitOverride')] [System.String] $NotifySender, #DEPRECATED [Parameter()] [System.String] $PrependSubject, [Parameter()] [System.UInt32] $Priority, [Parameter()] [System.Boolean] $Quarantine, [Parameter()] [System.String[]] $RecipientADAttributeContainsWords, [Parameter()] [System.String[]] $RecipientADAttributeMatchesPatterns, [Parameter()] [System.String[]] $RecipientAddressContainsWords, [Parameter()] [System.String[]] $RecipientAddressMatchesPatterns, [Parameter()] [ValidateSet('Original', 'Resolved')] [System.String] $RecipientAddressType, [Parameter()] [System.String[]] $RecipientDomainIs, [Parameter()] [System.String[]] $RecipientInSenderList, [Parameter()] [System.String[]] $RedirectMessageTo = @(), [Parameter()] [System.String] $RejectMessageEnhancedStatusCode, [Parameter()] [System.String] $RejectMessageReasonText, [Parameter()] [System.String] $RemoveHeader, [Parameter()] [System.Boolean] $RemoveOME, [Parameter()] [System.Boolean] $RemoveOMEv2, [Parameter()] [System.Boolean] $RemoveRMSAttachmentEncryption, [Parameter()] [System.String] $RouteMessageOutboundConnector, [Parameter()] [System.Boolean] $RouteMessageOutboundRequireTls, [Parameter()] [ValidateSet('Ignore', 'Defer')] [System.String] $RuleErrorAction, [Parameter()] [ValidateSet('Dlp', 'None')] [System.String] $RuleSubType, [Parameter()] [System.String] $SCLOver, [Parameter()] [System.String[]] $SenderADAttributeContainsWords, [Parameter()] [System.String[]] $SenderADAttributeMatchesPatterns, [Parameter()] [ValidateSet('Header', 'Envelope', 'HeaderOrEnvelope')] [System.String] $SenderAddressLocation, [Parameter()] [System.String[]] $SenderDomainIs, [Parameter()] [System.String[]] $SenderInRecipientList, [Parameter()] [System.String[]] $SenderIpRanges, [Parameter()] [ValidateSet('Manager', 'DirectReport')] [System.String] $SenderManagementRelationship, [Parameter()] [System.String[]] $SentTo = @(), [Parameter()] [System.String[]] $SentToMemberOf = @(), [Parameter()] [ValidateSet('InOrganization', 'NotInOrganization', 'ExternalPartner', 'ExternalNonPartner')] [System.String] $SentToScope, [Parameter()] [ValidateSet('DoNotAudit', 'Low', 'Medium', 'High')] [System.String] $SetAuditSeverity, [Parameter()] [System.String] $SetHeaderName, [Parameter()] [System.String] $SetHeaderValue, [Parameter()] [System.String] $SetSCL, [Parameter()] [System.Boolean] $StopRuleProcessing, [Parameter()] [System.String[]] $SubjectContainsWords, [Parameter()] [System.String[]] $SubjectMatchesPatterns, [Parameter()] [System.String[]] $SubjectOrBodyContainsWords, [Parameter()] [System.String[]] $SubjectOrBodyMatchesPatterns, [Parameter()] [ValidateSet('Low', 'Normal', 'High')] [System.String] $WithImportance, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Management.Automation.PSCredential] $Credential, [Parameter()] [System.String] $ApplicationId, [Parameter()] [System.String] $TenantId, [Parameter()] [System.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [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 Transport Rule configuration for $Name" $CurrentValues = Get-TargetResource @PSBoundParameters Write-Verbose -Message "Current Values: $(Convert-M365DscHashtableToString -Hashtable $CurrentValues)" Write-Verbose -Message "Target Values: $(Convert-M365DscHashtableToString -Hashtable $PSBoundParameters)" $ValuesToCheck = $PSBoundParameters $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.String] $CertificateThumbprint, [Parameter()] [System.String] $CertificatePath, [Parameter()] [System.Management.Automation.PSCredential] $CertificatePassword, [Parameter()] [Switch] $ManagedIdentity, [Parameter()] [System.String[]] $AccessTokens ) $InformationPreference = 'Continue' $ConnectionMode = New-M365DSCConnection -Workload 'ExchangeOnline' ` -InboundParameters $PSBoundParameters ` -SkipModuleReload $true #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]$AllTransportRules = Get-TransportRule $dscContent = '' $i = 1 if ($AllTransportRules.Length -eq 0) { Write-Host $Global:M365DSCEmojiGreenCheckMark } else { Write-Host "`r`n" -NoNewline } foreach ($TransportRule in $AllTransportRules) { if ($null -ne $Global:M365DSCExportResourceInstancesCount) { $Global:M365DSCExportResourceInstancesCount++ } Write-Host " |---[$i/$($AllTransportRules.Count)] $($TransportRule.Name)" -NoNewline $Params = @{ Name = $TransportRule.Name Credential = $Credential ApplicationId = $ApplicationId TenantId = $TenantId CertificateThumbprint = $CertificateThumbprint CertificatePassword = $CertificatePassword Managedidentity = $ManagedIdentity.IsPresent CertificatePath = $CertificatePath 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 Write-Host $Global:M365DSCEmojiGreenCheckMark $i++ } return $dscContent } catch { Write-Host $Global:M365DSCEmojiRedX New-M365DSCLogEntry -Message 'Error retrieving data:' ` -Exception $_ ` -Source $($MyInvocation.MyCommand.Source) ` -TenantId $TenantId ` -Credential $Credential return '' } } Export-ModuleMember -Function *-TargetResource |