Skip to content

Commit 0dfbf9f

Browse files
authored
Merge pull request #10773 from MicrosoftDocs/DLPNotify-chrisda
DLPNotify-chrisda to Main
2 parents e9b4c63 + c978b12 commit 0dfbf9f

File tree

2 files changed

+156
-75
lines changed

2 files changed

+156
-75
lines changed

exchange/exchange-ps/exchange/New-DlpComplianceRule.md

Lines changed: 75 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222

2323
```
2424
New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
25-
[-AccessScope <AccessScope>]
26-
[-ActivationDate <DateTime>]
25+
[-AccessScope <Microsoft.Office.CompliancePolicy.Tasks.AccessScope>]
26+
[-ActivationDate <System.DateTime>]
2727
[-AddRecipients <PswsHashtable>]
2828
[-AdvancedRule <String>]
2929
[-AlertProperties <PswsHashtable>]
3030
[-AnyOfRecipientAddressContainsWords <MultiValuedProperty>]
3131
[-AnyOfRecipientAddressMatchesPatterns <MultiValuedProperty>]
3232
[-ApplyHtmlDisclaimer <PswsHashtable>]
3333
[-BlockAccess <Boolean>]
34-
[-BlockAccessScope <BlockAccessScope>]
34+
[-BlockAccessScope <Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope>]
3535
[-Comment <String>]
3636
[-Confirm]
3737
[-ContentCharacterSetContainsWords <MultiValuedProperty>]
@@ -45,16 +45,16 @@ New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
4545
[-DocumentContainsWords <MultiValuedProperty>]
4646
[-DocumentCreatedBy <MultiValuedProperty>]
4747
[-DocumentCreatedByMemberOf <RecipientIdParameter[]>]
48-
[-DocumentIsPasswordProtected <Boolean>
48+
[-DocumentIsPasswordProtected <Boolean>]
4949
[-DocumentIsUnsupported <Boolean>]
5050
[-DocumentMatchesPatterns <MultiValuedProperty>]
5151
[-DocumentNameMatchesPatterns <MultiValuedProperty>]
5252
[-DocumentNameMatchesWords <MultiValuedProperty>]
53-
[-DocumentSizeOver <ByteQuantifiedSize>]
53+
[-DocumentSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
5454
[-EncryptRMSTemplate <RmsTemplateIdParameter>]
5555
[-EndpointDlpBrowserRestrictions <PswsHashtable[]>]
5656
[-EndpointDlpRestrictions <PswsHashtable[]>]
57-
[-ExceptIfAccessScope <AccessScope>]
57+
[-ExceptIfAccessScope <Microsoft.Office.CompliancePolicy.Tasks.AccessScope>]
5858
[-ExceptIfAnyOfRecipientAddressContainsWords <MultiValuedProperty>]
5959
[-ExceptIfAnyOfRecipientAddressMatchesPatterns <MultiValuedProperty>]
6060
[-ExceptIfContentCharacterSetContainsWords <MultiValuedProperty>]
@@ -71,17 +71,17 @@ New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
7171
[-ExceptIfDocumentMatchesPatterns <MultiValuedProperty>]
7272
[-ExceptIfDocumentNameMatchesPatterns <MultiValuedProperty>]
7373
[-ExceptIfDocumentNameMatchesWords <MultiValuedProperty>]
74-
[-ExceptIfDocumentSizeOver <ByteQuantifiedSize>]
74+
[-ExceptIfDocumentSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
7575
[-ExceptIfFrom <RecipientIdParameter[]>]
7676
[-ExceptIfFromAddressContainsWords <MultiValuedProperty>]
7777
[-ExceptIfFromAddressMatchesPatterns <MultiValuedProperty>]
7878
[-ExceptIfFromMemberOf <SmtpAddress[]>]
79-
[-ExceptIfFromScope <FromScope>]
79+
[-ExceptIfFromScope <Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope>]
8080
[-ExceptIfHasSenderOverride <Boolean>]
8181
[-ExceptIfHeaderContainsWords <PswsHashtable>]
8282
[-ExceptIfHeaderMatchesPatterns <PswsHashtable>]
83-
[-ExceptIfMessageSizeOver <ByteQuantifiedSize>]
84-
[-ExceptIfMessageTypeMatches <MessageTypes>]
83+
[-ExceptIfMessageSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
84+
[-ExceptIfMessageTypeMatches <Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes>]
8585
[-ExceptIfProcessingLimitExceeded <Boolean>]
8686
[-ExceptIfRecipientADAttributeContainsWords <PswsHashtable>]
8787
[-ExceptIfRecipientADAttributeMatchesPatterns <PswsHashtable>]
@@ -97,37 +97,39 @@ New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
9797
[-ExceptIfSubjectOrBodyContainsWords <MultiValuedProperty>]
9898
[-ExceptIfSubjectOrBodyMatchesPatterns <MultiValuedProperty>]
9999
[-ExceptIfUnscannableDocumentExtensionIs <MultiValuedProperty>]
100-
[-ExceptIfWithImportance <WithImportance>]
101-
[-ExpiryDate <DateTime>]
100+
[-ExceptIfWithImportance <Microsoft.Office.CompliancePolicy.Tasks.WithImportance>]
101+
[-ExpiryDate <System.DateTime>]
102102
[-From <RecipientIdParameter[]>]
103103
[-FromAddressContainsWords <MultiValuedProperty>]
104104
[-FromAddressMatchesPatterns <MultiValuedProperty>]
105105
[-FromMemberOf <SmtpAddress[]>]
106-
[-FromScope <FromScope>]
106+
[-FromScope <Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope>]
107107
[-GenerateAlert <MultiValuedProperty>]
108108
[-GenerateIncidentReport <MultiValuedProperty>]
109109
[-HasSenderOverride <Boolean>]
110110
[-HeaderContainsWords <PswsHashtable>]
111111
[-HeaderMatchesPatterns <PswsHashtable>]
112-
[-ImmutableId <Guid>]
112+
[-ImmutableId <System.Guid>]
113113
[-IncidentReportContent <ReportContentOption[]>]
114-
[-MessageSizeOver <ByteQuantifiedSize>]
114+
[-MessageSizeOver <Microsoft.Exchange.Data.ByteQuantifiedSize>]
115115
[-MessageTypeMatches <Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes>]
116116
[-Moderate <PswsHashtable>]
117117
[-ModifySubject <PswsHashtable>]
118-
[-NonBifurcatingAccessScope <NonBifurcatingAccessScope>]
118+
[-NonBifurcatingAccessScope <Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope>]
119119
[-NotifyAllowOverride <OverrideOption[]>]
120120
[-NotifyEmailCustomSubject <String>]
121121
[-NotifyEmailCustomText <String>]
122122
[-NotifyEndpointUser <PswsHashtable>]
123123
[-NotifyOverrideRequirements <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements>]
124124
[-NotifyPolicyTipCustomText <String>]
125125
[-NotifyPolicyTipCustomTextTranslations <MultiValuedProperty>]
126+
[-NotifyPolicyTipDisplayOption <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption>]
127+
[-NotifyPolicyTipUrl <String>]
126128
[-NotifyUser <MultiValuedProperty>]
127129
[-NotifyUserType <Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType>]
128130
[-OnPremisesScannerDlpRestrictions <PswsHashtable[]>]
129131
[-PrependSubject <String>]
130-
[-Priority <Int32>]
132+
[-Priority <System.Int32>]
131133
[-ProcessingLimitExceeded <Boolean>]
132134
[-Quarantine <Boolean>]
133135
[-RecipientADAttributeContainsWords <PswsHashtable>]
@@ -138,7 +140,7 @@ New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
138140
[-RemoveRMSTemplate <Boolean>]
139141
[-ReportSeverityLevel <RuleSeverity>]
140142
[-RestrictBrowserAccess <Boolean>]
141-
[-RuleErrorAction <PolicyRuleErrorAction>]
143+
[-RuleErrorAction <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction>]
142144
[-SenderADAttributeContainsWords <PswsHashtable>]
143145
[-SenderADAttributeMatchesPatterns <PswsHashtable>]
144146
[-SenderAddressLocation <Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation>]
@@ -155,7 +157,7 @@ New-DlpComplianceRule [-Name] <String> -Policy <PolicyIdParameter>
155157
[-ThirdPartyAppDlpRestrictions <PswsHashtable[]>]
156158
[-UnscannableDocumentExtensionIs <MultiValuedProperty>]
157159
[-WhatIf]
158-
[-WithImportance <WithImportance>]
160+
[-WithImportance <Microsoft.Office.CompliancePolicy.Tasks.WithImportance>]
159161
[<CommonParameters>]
160162
```
161163

@@ -333,7 +335,7 @@ The AccessScope parameter specifies a condition for the DLP rule that's based on
333335
- None: The condition isn't used.
334336
335337
```yaml
336-
Type: AccessScope
338+
Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope
337339
Parameter Sets: (All)
338340
Aliases:
339341
Applicable: Security & Compliance
@@ -349,7 +351,7 @@ Accept wildcard characters: False
349351
This parameter is reserved for internal Microsoft use.
350352
351353
```yaml
352-
Type: DateTime
354+
Type: System.DateTime
353355
Parameter Sets: (All)
354356
Aliases:
355357
Applicable: Security & Compliance
@@ -511,7 +513,7 @@ The BlockAccessScope parameter specifies the scope of the block access action. V
511513
- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive.
512514

513515
```yaml
514-
Type: BlockAccessScope
516+
Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope
515517
Parameter Sets: (All)
516518
Aliases:
517519
Applicable: Security & Compliance
@@ -865,7 +867,7 @@ Unqualified values are typically treated as bytes, but small values may be round
865867
You can use this condition in DLP policies that are scoped only to Exchange.
866868

867869
```yaml
868-
Type: ByteQuantifiedSize
870+
Type: Microsoft.Exchange.Data.ByteQuantifiedSize
869871
Parameter Sets: (All)
870872
Aliases:
871873
Applicable: Security & Compliance
@@ -957,7 +959,7 @@ The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP
957959
- None: The exception isn't used.
958960

959961
```yaml
960-
Type: AccessScope
962+
Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope
961963
Parameter Sets: (All)
962964
Aliases:
963965
Applicable: Security & Compliance
@@ -1285,7 +1287,7 @@ Unqualified values are typically treated as bytes, but small values may be round
12851287
You can use this exception in DLP policies that are scoped only to Exchange.
12861288

12871289
```yaml
1288-
Type: ByteQuantifiedSize
1290+
Type: Microsoft.Exchange.Data.ByteQuantifiedSize
12891291
Parameter Sets: (All)
12901292
Aliases:
12911293
Applicable: Security & Compliance
@@ -1386,7 +1388,7 @@ The ExceptIfFromScope parameter specifies an exception for the rule that looks f
13861388
You can use this exception in DLP policies that are scoped only to Exchange.
13871389

13881390
```yaml
1389-
Type: FromScope
1391+
Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope
13901392
Parameter Sets: (All)
13911393
Aliases:
13921394
Applicable: Security & Compliance
@@ -1473,7 +1475,7 @@ Unqualified values are typically treated as bytes, but small values may be round
14731475
You can use this exception in DLP policies that are scoped only to Exchange.
14741476

14751477
```yaml
1476-
Type: ByteQuantifiedSize
1478+
Type: Microsoft.Exchange.Data.ByteQuantifiedSize
14771479
Parameter Sets: (All)
14781480
Aliases:
14791481
Applicable: Security & Compliance
@@ -1500,7 +1502,7 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha
15001502
You can use this exception in DLP policies that are scoped only to Exchange.
15011503

15021504
```yaml
1503-
Type: MessageTypes
1505+
Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes
15041506
Parameter Sets: (All)
15051507
Aliases:
15061508
Applicable: Security & Compliance
@@ -1933,7 +1935,7 @@ The ExceptIfWithImportance parameter specifies an exception for the rule that lo
19331935
You can use this exception in DLP policies that are scoped only to Exchange.
19341936

19351937
```yaml
1936-
Type: WithImportance
1938+
Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance
19371939
Parameter Sets: (All)
19381940
Aliases:
19391941
Applicable: Security & Compliance
@@ -1949,7 +1951,7 @@ Accept wildcard characters: False
19491951
This parameter is reserved for internal Microsoft use.
19501952

19511953
```yaml
1952-
Type: DateTime
1954+
Type: System.DateTime
19531955
Parameter Sets: (All)
19541956
Aliases:
19551957
Applicable: Security & Compliance
@@ -2050,7 +2052,7 @@ The FromScope parameter specifies a condition for the rule that looks for the lo
20502052
You can use this condition in DLP policies that are scoped only to Exchange.
20512053

20522054
```yaml
2053-
Type: FromScope
2055+
Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope
20542056
Parameter Sets: (All)
20552057
Aliases:
20562058
Applicable: Security & Compliance
@@ -2169,7 +2171,7 @@ Accept wildcard characters: False
21692171
This parameter is reserved for internal Microsoft use.
21702172

21712173
```yaml
2172-
Type: Guid
2174+
Type: System.Guid
21732175
Parameter Sets: (All)
21742176
Aliases:
21752177
Applicable: Security & Compliance
@@ -2236,7 +2238,7 @@ Unqualified values are typically treated as bytes, but small values may be round
22362238
You can use this condition in DLP policies that are scoped only to Exchange.
22372239

22382240
```yaml
2239-
Type: ByteQuantifiedSize
2241+
Type: Microsoft.Exchange.Data.ByteQuantifiedSize
22402242
Parameter Sets: (All)
22412243
Aliases:
22422244
Applicable: Security & Compliance
@@ -2327,7 +2329,7 @@ The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule t
23272329
You can use this condition in DLP policies that are scoped only to Exchange.
23282330

23292331
```yaml
2330-
Type: NonBifurcatingAccessScope
2332+
Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope
23312333
Parameter Sets: (All)
23322334
Aliases:
23332335
Applicable: Security & Compliance
@@ -2343,6 +2345,7 @@ Accept wildcard characters: False
23432345
The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are:
23442346

23452347
- FalsePositive: Allows overrides in the case of false positives.
2348+
- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only)
23462349
- WithoutJustification: Allows overrides without justification.
23472350
- WithJustification: Allows overrides with justification.
23482351

@@ -2472,6 +2475,41 @@ Accept pipeline input: False
24722475
Accept wildcard characters: False
24732476
```
24742477

2478+
### -NotifyPolicyTipDisplayOption
2479+
The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are:
2480+
2481+
- Tip: Displays policy tip at the top of the mail. This is the default value.
2482+
- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only)
2483+
2484+
```yaml
2485+
Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption
2486+
Parameter Sets: Default
2487+
Aliases:
2488+
Applicable: Security & Compliance
2489+
2490+
Required: False
2491+
Position: Named
2492+
Default value: None
2493+
Accept pipeline input: False
2494+
Accept wildcard characters: False
2495+
```
2496+
2497+
### -NotifyPolicyTipUrl
2498+
The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`.
2499+
2500+
```yaml
2501+
Type: String
2502+
Parameter Sets: Default
2503+
Aliases:
2504+
Applicable: Security & Compliance
2505+
2506+
Required: False
2507+
Position: Named
2508+
Default value: None
2509+
Accept pipeline input: False
2510+
Accept wildcard characters: False
2511+
```
2512+
24752513
### -NotifyUser
24762514
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:
24772515

@@ -2564,7 +2602,7 @@ Valid values and the default value for this parameter depend on the number of ex
25642602
If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1.
25652603

25662604
```yaml
2567-
Type: Int32
2605+
Type: System.Int32
25682606
Parameter Sets: (All)
25692607
Aliases:
25702608
Applicable: Security & Compliance
@@ -2836,7 +2874,7 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du
28362874
- Blank (the value $null): This is the default value.
28372875

28382876
```yaml
2839-
Type: PolicyRuleErrorAction
2877+
Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction
28402878
Parameter Sets: (All)
28412879
Aliases:
28422880
Applicable: Security & Compliance
@@ -3233,7 +3271,7 @@ The WithImportance parameter specifies a condition for the rule that looks for m
32333271
You can use this condition in DLP policies that are scoped only to Exchange.
32343272

32353273
```yaml
3236-
Type: WithImportance
3274+
Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance
32373275
Parameter Sets: (All)
32383276
Aliases:
32393277
Applicable: Security & Compliance

0 commit comments

Comments
 (0)