Skip to content

Commit 795f601

Browse files
authored
Merge pull request #11977 from et1hugo/patch-1
Add dynamic watermarking parameters to Set-Label
2 parents 1bc5f75 + 7b5f9a4 commit 795f601

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

exchange/exchange-ps/exchange/Set-Label.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Set-Label [-Identity] <ComplianceRuleIdParameter>
3737
[-ApplyContentMarkingHeaderFontSize <System.Int32>]
3838
[-ApplyContentMarkingHeaderMargin <System.Int32>]
3939
[-ApplyContentMarkingHeaderText <String>]
40+
[-ApplyDynamicWatermarkingEnabled <System.Boolean>]
4041
[-ApplyWaterMarkingEnabled <System.Boolean>]
4142
[-ApplyWaterMarkingFontColor <String>]
4243
[-ApplyWaterMarkingFontName <String>]
@@ -50,6 +51,7 @@ Set-Label [-Identity] <ComplianceRuleIdParameter>
5051
[-ContentType <MipLabelContentType>]
5152
[-DefaultContentLabel <String>]
5253
[-DisplayName <String>]
54+
[-DynamicWatermarkDisplay <String>]
5355
[-EncryptionContentExpiredOnDateInDaysOrNever <String>]
5456
[-EncryptionDoNotForward <System.Boolean>]
5557
[-EncryptionDoubleKeyEncryptionUrl <String>]
@@ -452,6 +454,27 @@ Accept pipeline input: False
452454
Accept wildcard characters: False
453455
```
454456

457+
### -ApplyDynamicWatermarkingEnabled
458+
The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are:
459+
460+
- $true: Enables dynamic watermarking for a specific label.
461+
- $false: Disables dynamic watermarking for a specific label.
462+
463+
You set the watermark text with the DynamicWatermarkDisplay parameter. For more information about using dynamic watermarks for supported apps, see [Dynamic watermarks](https://learn.microsoft.com/purview/encryption-sensitivity-labels#dynamic-watermarks).
464+
465+
```yaml
466+
Type: System.Boolean
467+
Parameter Sets: (All)
468+
Aliases:
469+
Applicable: Security & Compliance
470+
471+
Required: False
472+
Position: Named
473+
Default value: None
474+
Accept pipeline input: False
475+
Accept wildcard characters: False
476+
```
477+
455478
### -ApplyWaterMarkingEnabled
456479
The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarking Header action for the label. Valid values are:
457480

@@ -689,6 +712,27 @@ Accept pipeline input: False
689712
Accept wildcard characters: False
690713
```
691714

715+
### -DynamicWatermarkDisplay
716+
The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens:
717+
718+
- `${Consumer.PrincipalName}`: Required. The value is the user principal name (UPN) of the user.
719+
- `${Device.DateTime}`: Optional. The value is current date/time of the device used to view the document.
720+
721+
This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled parameter value is $true.
722+
723+
```yaml
724+
Type: String
725+
Parameter Sets: (All)
726+
Aliases:
727+
Applicable: Security & Compliance
728+
729+
Required: False
730+
Position: Named
731+
Default value: None
732+
Accept pipeline input: False
733+
Accept wildcard characters: False
734+
```
735+
692736
### -EncryptionContentExpiredOnDateInDaysOrNever
693737
The EncryptionContentExpiredOnDateInDaysOrNever parameter specifies when the encrypted content expires. Valid values are:
694738

0 commit comments

Comments
 (0)