Commands › Exchange Online
New-DlpComplianceRule
For more information, see Security & Compliance PowerShell. Use the New-DlpComplianceRule to create data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule matches.
Quick start script
# New-DlpComplianceRule — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-DlpComplianceRule
$before | Format-List
# 3. Make the change (dry run first)
New-DlpComplianceRule -Name <String> -Policy <PolicyIdParameter> -WhatIf
New-DlpComplianceRule -Name <String> -Policy <PolicyIdParameter>
# 4. Verify and diff
$after = Get-DlpComplianceRule
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
[-AccessScope <Microsoft.Office.CompliancePolicy.Tasks.AccessScope>]
[-ActivationDate <System.DateTime>]
[-AddRecipients <PswsHashtable>]
[-AdvancedRule <String>]
[-AlertProperties <PswsHashtable>]
[-AnyOfRecipientAddressContainsWords <MultiValuedProperty>]
[-AnyOfRecipientAddressMatchesPatterns <MultiValuedProperty>]
[-ApplyBrandingTemplate <String>]
[-ApplyHtmlDisclaimer <PswsHashtable>]
[-AttachmentIsNotLabeled <Boolean>]
[-BlockAccess <Boolean>]
[-BlockAccessScope <Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope>]
[-Comment <String>]
[-Confirm]
[-ContentCharacterSetContainsWords <MultiValuedProperty>]
[-ContentContainsSensitiveInformation <PswsHashtable[]>]
[-ContentExtensionMatchesWords <MultiValuedProperty>]
[-ContentFileTypeMatches <MultiValuedProperty>]
[-ContentIsNotLabeled <Boolean>]
[-ContentIsShared <Boolean>]
[-ContentPropertyContainsWords <MultiValuedProperty>]
[-Disabled <Boolean>]
[-DisplayName <String>]
[-DocumentContainsWords <MultiValuedProperty>]
[-DocumentCreatedBy <MultiValuedProperty>]
[-DocumentCreatedByMemberOf <RecipientIdParameter[]>]
[-DocumentIsPasswordProtected <Boolean>]
[-DocumentIsUnsupported <Boolean>]
[-DocumentMatchesPatterns <MultiValuedProperty>]
[-DocumentNameMatchesPatterns <MultiValuedProperty>]
[-DocumentNameMatchesWords <MultiValuedProperty>]
[-DocumentSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
[-EncryptRMSTemplate <RmsTemplateIdParameter>]
[-EndpointDlpRestrictions <PswsHashtable[]>]
[-EnforcePortalAccess <Boolean>]
[-EvaluateRulePerComponent <Boolean>]
[-ExceptIfAccessScope <Microsoft.Office.CompliancePolicy.Tasks.AccessScope>]
[-ExceptIfAnyOfRecipientAddressContainsWords <MultiValuedProperty>]
[-ExceptIfAnyOfRecipientAddressMatchesPatterns <MultiValuedProperty>]
[-ExceptIfContentCharacterSetContainsWords <MultiValuedProperty>]
[-ExceptIfContentContainsSensitiveInformation <PswsHashtable[]>]
[-ExceptIfContentExtensionMatchesWords <MultiValuedProperty>]
[-ExceptIfContentFileTypeMatches <MultiValuedProperty>]
[-ExceptIfContentIsShared <Boolean>]
[-ExceptIfContentPropertyContainsWords <MultiValuedProperty>]
[-ExceptIfDocumentContainsWords <MultiValuedProperty>]
[-ExceptIfDocumentCreatedBy <MultiValuedProperty>]
[-ExceptIfDocumentCreatedByMemberOf <RecipientIdParameter[]>]
[-ExceptIfDocumentIsPasswordProtected <Boolean>]
[-ExceptIfDocumentIsUnsupported <Boolean>]
[-ExceptIfDocumentMatchesPatterns <MultiValuedProperty>]
[-ExceptIfDocumentNameMatchesPatterns <MultiValuedProperty>]
[-ExceptIfDocumentNameMatchesWords <MultiValuedProperty>]
[-ExceptIfDocumentSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
[-ExceptIfFrom <RecipientIdParameter[]>]
[-ExceptIfFromAddressContainsWords <MultiValuedProperty>]
[-ExceptIfFromAddressMatchesPatterns <MultiValuedProperty>]
[-ExceptIfFromMemberOf <SmtpAddress[]>]
[-ExceptIfFromScope <Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope>]
[-ExceptIfHasSenderOverride <Boolean>]
[-ExceptIfHeaderContainsWords <PswsHashtable>]
[-ExceptIfHeaderMatchesPatterns <PswsHashtable>]
[-ExceptIfMessageSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
[-ExceptIfMessageTypeMatches <Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes>]
[-ExceptIfProcessingLimitExceeded <Boolean>]
[-ExceptIfRecipientADAttributeContainsWords <PswsHashtable>]
[-ExceptIfRecipientADAttributeMatchesPatterns <PswsHashtable>]
[-ExceptIfRecipientDomainIs <MultiValuedProperty>]
[-ExceptIfSenderADAttributeContainsWords <PswsHashtable>]
[-ExceptIfSenderADAttributeMatchesPatterns <PswsHashtable>]
[-ExceptIfSenderDomainIs <MultiValuedProperty>]
[-ExceptIfSenderIPRanges <MultiValuedProperty>]
[-ExceptIfSentTo <MultiValuedProperty>]
[-ExceptIfSentToMemberOf <RecipientIdParameter[]>]
[-ExceptIfSubjectContainsWords <MultiValuedProperty>]
[-ExceptIfSubjectMatchesPatterns <MultiValuedProperty>]
[-ExceptIfSubjectOrBodyContainsWords <MultiValuedProperty>]
[-ExceptIfSubjectOrBodyMatchesPatterns <MultiValuedProperty>]
[-ExceptIfUnscannableDocumentExtensionIs <MultiValuedProperty>]
[-ExceptIfWithImportance <Microsoft.Office.CompliancePolicy.Tasks.WithImportance>]
[-ExpiryDate <System.DateTime>]
[-From <RecipientIdParameter[]>]
[-FromAddressContainsWords <MultiValuedProperty>]
[-FromAddressMatchesPatterns <MultiValuedProperty>]
[-FromMemberOf <SmtpAddress[]>]
[-FromScope <Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope>]
[-GenerateAlert <MultiValuedProperty>]
[-GenerateIncidentReport <MultiValuedProperty>]
[-HasActivity <Activity>]
[-HasSenderOverride <Boolean>]
[-HeaderContainsWords <PswsHashtable>]
[-HeaderMatchesPatterns <PswsHashtable>]
[-ImmutableId <System.Guid>]
[-IncidentReportContent <ReportContentOption[]>]
[-MessageIsNotLabeled <Boolean>]
[-MessageSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
[-MessageTypeMatches <Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes>]
[-MipRestrictAccess <PswsHashtable[]>]
[-Moderate <PswsHashtable>]
[-ModifySubject <PswsHashtable>]
[-NonBifurcatingAccessScope <Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope>]
[-NotifyAllowOverride <OverrideOption[]>]
[-NotifyEmailCustomSenderDisplayName <String>]
[-NotifyEmailCustomSubject <String>]
[-NotifyEmailCustomText <String>]
[-NotifyEmailExchangeIncludeAttachment <Boolean>]
[-NotifyEmailOnedriveRemediationActions <NotifyEmailRemediationActions>]
[-NotifyOverrideRequirements <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements>]
[-NotifyPolicyTipCustomDialog <String>]
[-NotifyPolicyTipCustomText <String>]
[-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>]
[-NotifyPolicyTipDisplayOption <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption>]
[-NotifyPolicyTipUrl <String>]
[-NotifyUser <MultiValuedProperty>]
[-NotifyUserType <Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType>]
[-OnPremisesScannerDlpRestrictions <PswsHashtable[]>]
[-PrependSubject <String>]
[-Priority <System.Int32>]
[-ProcessingLimitExceeded <Boolean>]
[-Quarantine <Boolean>]
[-RecipientADAttributeContainsWords <PswsHashtable>]
[-RecipientADAttributeMatchesPatterns <PswsHashtable>]
[-RecipientDomainIs <MultiValuedProperty>]
[-RedirectMessageTo <RecipientIdParameter[]>]
[-RemoveHeader <MultiValuedProperty>]
[-RemoveRMSTemplate <Boolean>]
[-ReportSeverityLevel <RuleSeverity>]
[-RestrictAccess <System.Collections.Hashtable[]>]
[-RestrictWebGrounding <Boolean>]
[-RuleErrorAction <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction>]
[-SenderADAttributeContainsWords <PswsHashtable>]
[-SenderADAttributeMatchesPatterns <PswsHashtable>]
[-SenderAddressLocation <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation>]
[-SenderDomainIs <MultiValuedProperty>]
[-SenderIPRanges <MultiValuedProperty>]
[-SentTo <MultiValuedProperty>]
[-SentToMemberOf <RecipientIdParameter[]>]
[-SetHeader <PswsHashtable>]
[-SharedByIRMUserRisk <MultiValuedProperty>]
[-SharepointMoveToQuarantineLocation <Boolean>]
[-StopPolicyProcessing <Boolean>]
[-SubjectContainsWords <MultiValuedProperty>]
[-SubjectMatchesPatterns <MultiValuedProperty>]
[-SubjectOrBodyContainsWords <MultiValuedProperty>]
[-SubjectOrBodyMatchesPatterns <MultiValuedProperty>]
[-TriggerPowerAutomateFlow <String>]
[-UnscannableDocumentExtensionIs <MultiValuedProperty>]
[-ValidateRule]
[-WhatIf]
[-WithImportance <Microsoft.Office.CompliancePolicy.Tasks.WithImportance>]
[<CommonParameters>]Parameters (152)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Name | String | yes | The Name parameter specifies the unique name of the new DLP rule. If the value contains spaces, enclose the value in quotation marks. |
| -Policy | PolicyIdParameter | yes | The Policy parameter specifies the existing DLP policy that contains the new DLP rule. You can use any value that uniquely identifies the policy. For example: |
| -AccessScope | AccessScope | The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: | |
| -ActivationDate | DateTime | This parameter is reserved for internal Microsoft use. | |
| -AddRecipients | PswsHashtable | The AddRecipients parameter specifies an action for the DLP rule that adds the specified recipients to email messages. This parameter uses the following syntax: | |
| -AdvancedRule | String | The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. | |
| -AlertProperties | PswsHashtable | {{ Fill AlertProperties Description }} | |
| -AnyOfRecipientAddressContainsWords | MultiValuedProperty | The AnyOfRecipientAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. | |
| -AnyOfRecipientAddressMatchesPatterns | MultiValuedProperty | The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns... | |
| -ApplyBrandingTemplate | String | The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding... | |
| -ApplyHtmlDisclaimer | PswsHashtable | The ApplyHtmlDisclaimer parameter specifies an action for the rule that adds disclaimer text to messages.This parameter uses the syntax: `@{Text = "Disclaimer text"; Location = <Append | Prepend>; FallbackAction =... | |
| -AttachmentIsNotLabeled | Boolean | {{ Fill AttachmentIsNotLabeled Description }} | |
| -BlockAccess | Boolean | The BlockAccess parameter specifies an action for the DLP rule that blocks access to the source item when the conditions of the rule are met. Valid values are: | |
| -BlockAccessScope | BlockAccessScope | The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: | |
| -Comment | String | The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -ContentCharacterSetContainsWords | MultiValuedProperty | The ContentCharacterSetContainsWords parameter specifies a condition for the rule that looks for character set names in messages. You can specify multiple values separated by commas. | |
| -ContentContainsSensitiveInformation | PswsHashtable[] | The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive... | |
| -ContentExtensionMatchesWords | MultiValuedProperty | The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type,... | |
| -ContentFileTypeMatches | MultiValuedProperty | {{ Fill ContentFileTypeMatches Description }} | |
| -ContentIsNotLabeled | Boolean | The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: | |
| -ContentIsShared | Boolean | The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: | |
| -ContentPropertyContainsWords | MultiValuedProperty | The ContentPropertyContainsWords parameter specifies a condition for the DLP rule that's based on a property match in content. The rule is applied to content that contains the specified property. | |
| -Disabled | Boolean | The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: | |
| -DisplayName | String | {{ Fill DisplayName Description }} | |
| -DocumentContainsWords | MultiValuedProperty | The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. | |
| -DocumentCreatedBy | MultiValuedProperty | The DocumentCreatedBy parameter specifies a condition for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. | |
| -DocumentCreatedByMemberOf | RecipientIdParameter[] | The DocumentCreatedByMemberOf parameter specifies a condition for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. | |
| -DocumentIsPasswordProtected | Boolean | The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office... | |
| -DocumentIsUnsupported | Boolean | The DocumentIsUnsupported parameter specifies a condition for the DLP rule that looks for files that can't be scanned. Valid values are: | |
| -DocumentMatchesPatterns | MultiValuedProperty | The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. | |
| -DocumentNameMatchesPatterns | MultiValuedProperty | The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by... | |
| -DocumentNameMatchesWords | MultiValuedProperty | The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. | |
| -DocumentSizeOver | ByteQuantifiedSize | The DocumentSizeOver parameter specifies a condition for the DLP rule that looks for messages where any attachment is greater than the specified size. | |
| -EncryptRMSTemplate | RmsTemplateIdParameter | The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the... | |
| -EndpointDlpRestrictions | PswsHashtable[] | **Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. | |
| -EnforcePortalAccess | Boolean | The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: | |
| -EvaluateRulePerComponent | Boolean | The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: | |
| -ExceptIfAccessScope | AccessScope | The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid... | |
| -ExceptIfAnyOfRecipientAddressContainsWords | MultiValuedProperty | The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. | |
| -ExceptIfAnyOfRecipientAddressMatchesPatterns | MultiValuedProperty | The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text... | |
| -ExceptIfContentCharacterSetContainsWords | MultiValuedProperty | The ExceptIfContentCharacterSetContainsWords parameter specifies an exception for the rule that looks for character set names in messages. | |
| -ExceptIfContentContainsSensitiveInformation | PswsHashtable[] | The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the... | |
| -ExceptIfContentExtensionMatchesWords | MultiValuedProperty | The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the... | |
| -ExceptIfContentFileTypeMatches | MultiValuedProperty | {{ Fill ExceptIfContentFileTypeMatches Description }} | |
| -ExceptIfContentIsShared | Boolean | The ContentIsNotLabeled parameter specifies an exception for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: | |
| -ExceptIfContentPropertyContainsWords | MultiValuedProperty | The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. | |
| -ExceptIfDocumentContainsWords | MultiValuedProperty | The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. | |
| -ExceptIfDocumentCreatedBy | MultiValuedProperty | The DocumentCreatedBy parameter specifies an exception for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. | |
| -ExceptIfDocumentCreatedByMemberOf | RecipientIdParameter[] | The DocumentCreatedByMemberOf parameter specifies an exception for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. | |
| -ExceptIfDocumentIsPasswordProtected | Boolean | The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for... | |
| -ExceptIfDocumentIsUnsupported | Boolean | The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: | |
| -ExceptIfDocumentNameMatchesPatterns | MultiValuedProperty | The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text... | |
| -ExceptIfDocumentMatchesPatterns | MultiValuedProperty | The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types... | |
| -ExceptIfDocumentNameMatchesWords | MultiValuedProperty | The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. | |
| -ExceptIfDocumentSizeOver | ByteQuantifiedSize | The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. | |
| -ExceptIfFrom | RecipientIdParameter[] | The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. | |
| -ExceptIfFromAddressContainsWords | MultiValuedProperty | The ExceptIfFromAddressContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. | |
| -ExceptIfFromAddressMatchesPatterns | MultiValuedProperty | The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns... | |
| -ExceptIfFromMemberOf | SmtpAddress[] | The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. | |
| -ExceptIfFromScope | FromScope | The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: | |
| -ExceptIfHasSenderOverride | Boolean | The ExceptIfHasSenderOverride parameter specifies an exception for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: | |
| -ExceptIfHeaderContainsWords | PswsHashtable | The HeaderContainsWords parameter specifies an exception for the DLP rule that looks for words in a header field. | |
| -ExceptIfHeaderMatchesPatterns | PswsHashtable | The HeaderMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following... | |
| -ExceptIfMessageSizeOver | ByteQuantifiedSize | The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. | |
| -ExceptIfMessageTypeMatches | MessageTypes | The ExceptIfMessageTypeMatches parameter specifies an exception for the rule that looks for messages of the specified type. Valid values are: | |
| -ExceptIfProcessingLimitExceeded | Boolean | The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP rule that looks for files where scanning couldn't complete. Valid values are: | |
| -ExceptIfRecipientADAttributeContainsWords | PswsHashtable | The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active... | |
| -ExceptIfRecipientADAttributeMatchesPatterns | PswsHashtable | The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You... | |
| -ExceptIfRecipientDomainIs | MultiValuedProperty | The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. | |
| -ExceptIfSenderADAttributeContainsWords | PswsHashtable | The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory... | |
| -ExceptIfSenderADAttributeMatchesPatterns | PswsHashtable | The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use... | |
| -ExceptIfSenderDomainIs | MultiValuedProperty | The ExceptIfSenderDomainIs parameter specifies an exception for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. | |
| -ExceptIfSenderIPRanges | MultiValuedProperty | The ExceptIfSenderIpRanges parameter specifies an exception for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: | |
| -ExceptIfSentTo | MultiValuedProperty | The ExceptIfSentTo parameter specifies an exception for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. | |
| -ExceptIfSentToMemberOf | RecipientIdParameter[] | The ExceptIfSentToMemberOf parameter specifies an exception for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify... | |
| -ExceptIfSubjectContainsWords | MultiValuedProperty | The ExceptIfSubjectContainsWords parameter specifies an exception for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. | |
| -ExceptIfSubjectMatchesPatterns | MultiValuedProperty | The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns... | |
| -ExceptIfSubjectOrBodyContainsWords | <MultiValuedProperty> | The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the rule that looks for words in the Subject field or body of messages. | |
| -ExceptIfSubjectOrBodyMatchesPatterns | <MultiValuedProperty> | The ExceptIfSubjectOrBodyMatchesPatterns parameter specifies an exception for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the... | |
| -ExceptIfUnscannableDocumentExtensionIs | MultiValuedProperty | The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of what the original file type... | |
| -ExceptIfWithImportance | WithImportance | The ExceptIfWithImportance parameter specifies an exception for the rule that looks for messages with the specified importance level. Valid values are: | |
| -ExpiryDate | DateTime | This parameter is reserved for internal Microsoft use. | |
| -From | RecipientIdParameter[] | The From parameter specifies a condition for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. | |
| -FromAddressContainsWords | MultiValuedProperty | The FromAddressContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. | |
| -FromAddressMatchesPatterns | MultiValuedProperty | The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using... | |
| -FromMemberOf | SmtpAddress[] | The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. | |
| -FromScope | FromScope | The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: | |
| -GenerateAlert | MultiValuedProperty | The GenerateAlert parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: | |
| -GenerateIncidentReport | MultiValuedProperty | The GenerateIncidentReport parameter specifies an action for the DLP rule that sends an incident report to the specified users when the conditions of the rule are met. Valid values are: | |
| -HasActivity | Activity | {{ Fill HasActivity Description }} | |
| -HasSenderOverride | Boolean | The SenderOverride parameter specifies a condition for the rule that looks for messages where the sender chose to override a DLP policy. Valid values are: | |
| -HeaderContainsWords | PswsHashtable | The HeaderContainsWords parameter specifies a condition for the DLP rule that looks for words in a header field. | |
| -HeaderMatchesPatterns | PswsHashtable | The HeaderMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following... | |
| -ImmutableId | Guid | This parameter is reserved for internal Microsoft use. | |
| -IncidentReportContent | ReportContentOption[] | The IncidentReportContent parameter specifies the content to include in the report when you use the GenerateIncidentReport parameter. Valid values are: | |
| -MessageIsNotLabeled | Boolean | {{ Fill MessageIsNotLabeled Description }} | |
| -MessageSizeOver | ByteQuantifiedSize | The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. | |
| -MessageTypeMatches | MessageTypes | The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: | |
| -MipRestrictAccess | PswsHashtable[] | {{ Fill MipRestrictAccess Description }} | |
| -Moderate | PswsHashtable | The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser =... | |
| -ModifySubject | PswsHashtable | The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax:... | |
| -NonBifurcatingAccessScope | NonBifurcatingAccessScope | The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: | |
| -NotifyAllowOverride | OverrideOption[] | The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: | |
| -NotifyEmailCustomSenderDisplayName | String | {{ Fill NotifyEmailCustomSenderDisplayName Description }} | |
| -NotifyEmailCustomSubject | String | The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. | |
| -NotifyEmailCustomText | String | The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. | |
| -NotifyEmailExchangeIncludeAttachment | Boolean | {{ Fill NotifyEmailExchangeIncludeAttachment Description }} | |
| -NotifyEmailOnedriveRemediationActions | NotifyEmailRemediationActions | {{ Fill NotifyEmailOnedriveRemediationActions Description }} | |
| -NotifyOverrideRequirements | PolicyOverrideRequirements | {{ Fill NotifyOverrideRequirements Description }} | |
| -NotifyPolicyTipCustomDialog | String | {{ Fill NotifyPolicyTipCustomDialog Description }} | |
| -NotifyPolicyTipCustomText | String | The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML... | |
| -NotifyPolicyTipCustomTextTranslations | MultiValuedProperty | The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax... | |
| -NotifyPolicyTipDisplayOption | PolicyTipDisplayOption | The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: | |
| -NotifyPolicyTipUrl | String | The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. | |
| -NotifyUser | MultiValuedProperty | The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: | |
| -NotifyUserType | NotifyUserType | The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: | |
| -OnPremisesScannerDlpRestrictions | PswsHashtable[] | {{ Fill OnPremisesScannerDlpRestrictions Description }} | |
| -PrependSubject | String | The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains... | |
| -Priority | Int32 | The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority,... | |
| -ProcessingLimitExceeded | Boolean | The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and... | |
| -Quarantine | Boolean | This parameter specifies an action or part of an action for the rule. | |
| -RecipientADAttributeContainsWords | PswsHashtable | The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: | |
| -RecipientADAttributeMatchesPatterns | PswsHashtable | The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any... | |
| -RecipientDomainIs | MultiValuedProperty | The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. | |
| -RedirectMessageTo | RecipientIdParameter[] | The RedirectMessageTo parameter specifies an action for the DLP rule that redirects the message to the specified email address. You can specify multiple values separated by commas. | |
| -RemoveHeader | MultiValuedProperty | The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple... | |
| -RemoveRMSTemplate | Boolean | The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: | |
| -ReportSeverityLevel | RuleSeverity | The ReportSeverityLevel parameter specifies the severity level of the incident report for content detections based on the rule. Valid values are: | |
| -RestrictAccess | Hashtable[] | {{ Fill RestrictAccess Description }} | |
| -RestrictWebGrounding | Boolean | The RestrictWebGrounding parameter specifies an action for the DLP rule that blocks web grounding. Valid values are: | |
| -RuleErrorAction | PolicyRuleErrorAction | The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: | |
| -SenderADAttributeContainsWords | PswsHashtable | The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: | |
| -SenderADAttributeMatchesPatterns | PswsHashtable | The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of... | |
| -SenderAddressLocation | PolicySenderAddressLocation | The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: | |
| -SenderDomainIs | MultiValuedProperty | The SenderDomainIs parameter specifies a condition for the DLP rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. | |
| -SenderIPRanges | MultiValuedProperty | The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: | |
| -SentTo | MultiValuedProperty | The SentTo parameter specifies a condition for the DLP rule that looks for recipients in messages. You identify the recipients by email address. You can specify multiple values separated by commas. | |
| -SentToMemberOf | RecipientIdParameter[] | The SentToMemberOf parameter specifies a condition for the DLP rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the... | |
| -SetHeader | PswsHashtable | The SetHeader parameter specifies an action for the DLP rule that adds or modifies a header field and value in the message header. This parameter uses the syntax `"HeaderName:HeaderValue"`. You can specify multiple... | |
| -SharedByIRMUserRisk | MultiValuedProperty | The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: | |
| -SharepointMoveToQuarantineLocation | Boolean | {{ Fill SharepointMoveToQuarantineLocation Description }} | |
| -StopPolicyProcessing | Boolean | The StopPolicyProcessing parameter specifies an action that stops processing more DLP policy rules. Valid values are: | |
| -SubjectContainsWords | MultiValuedProperty | The SubjectContainsWords parameter specifies a condition for the DLP rule that looks for words or phrases in the Subject field of messages. You can specify multiple words or phrases separated by commas. | |
| -SubjectMatchesPatterns | MultiValuedProperty | The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using... | |
| -SubjectOrBodyContainsWords | <MultiValuedProperty> | The SubjectOrBodyContainsWords parameter specifies a condition for the rule that looks for words in the Subject field or body of messages. | |
| -SubjectOrBodyMatchesPatterns | <MultiValuedProperty> | The SubjectOrBodyMatchesPatterns parameter specifies a condition for the rule that looks for text patterns in the Subject field or body of messages. You can specify multiple text patterns by using the following... | |
| -TriggerPowerAutomateFlow | String | {{ Fill TriggerPowerAutomateFlow Description }} | |
| -UnscannableDocumentExtensionIs | MultiValuedProperty | The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicate... | |
| -ValidateRule | SwitchParameter | {{ Fill ValidateRule Description }} | |
| -WhatIf | SwitchParameter | The WhatIf switch doesn't work in Security & Compliance PowerShell. | |
| -WithImportance | WithImportance | The WithImportance parameter specifies a condition for the rule that looks for messages with the specified importance level. Valid values are: |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.