Skip to content

Commit c63e794

Browse files
committed
Simulation mode
1 parent 5aeaf24 commit c63e794

File tree

3 files changed

+90
-5
lines changed

3 files changed

+90
-5
lines changed

exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Get-RetentionCompliancePolicy [[-Identity] <PolicyIdParameter>]
2525
[-DistributionDetail]
2626
[-ErrorPolicyOnly]
2727
[-ExcludeTeamsPolicy]
28+
[-IncludeTestModeResults]
2829
[-RetentionRuleTypes]
2930
[-TeamsPolicyOnly]
3031
[<CommonParameters>]
@@ -128,6 +129,24 @@ Accept pipeline input: False
128129
Accept wildcard characters: False
129130
```
130131
132+
### -IncludeTestModeResults
133+
The IncludeTestModeResults switch specifies whether to include simulation policy results. You don't need to specify a value with this switch.
134+
135+
For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode).
136+
137+
```yaml
138+
Type: SwitchParameter
139+
Parameter Sets: (All)
140+
Aliases:
141+
Applicable: Security & Compliance
142+
143+
Required: False
144+
Position: Named
145+
Default value: None
146+
Accept pipeline input: False
147+
Accept wildcard characters: False
148+
```
149+
131150
### -RetentionRuleTypes
132151
The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch.
133152

exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ New-RetentionCompliancePolicy [-Name] <String>
3030
[-ExchangeLocation <MultiValuedProperty>]
3131
[-ExchangeLocationException <MultiValuedProperty>]
3232
[-Force]
33+
[-IsSimulation]
3334
[-ModernGroupLocation <MultiValuedProperty>]
3435
[-ModernGroupLocationException <MultiValuedProperty>]
3536
[-OneDriveLocation <MultiValuedProperty>]
@@ -53,6 +54,7 @@ New-RetentionCompliancePolicy [-Name] <String>
5354
[-Confirm]
5455
[-Enabled <Boolean>]
5556
[-Force]
57+
[-IsSimulation]
5658
[-RestrictiveRetention <Boolean>]
5759
[-RetainCloudAttachment <Boolean>]
5860
[-TeamsChannelLocation <MultiValuedProperty>]
@@ -70,6 +72,7 @@ New-RetentionCompliancePolicy [-Name] <String> -AdaptiveScopeLocation <MultiValu
7072
[-Confirm]
7173
[-Enabled <Boolean>]
7274
[-Force]
75+
[-IsSimulation]
7376
[-RestrictiveRetention <Boolean>]
7477
[-RetainCloudAttachment <Boolean>]
7578
[-WhatIf]
@@ -101,7 +104,6 @@ This example creates a new auto-apply label policy targeted to cloud attachments
101104

102105
The next step is to use the New-RetentionComplianceRule cmdlet to add a retention label to the retention label policy.
103106

104-
105107
## PARAMETERS
106108

107109
### -Name
@@ -292,6 +294,24 @@ Accept pipeline input: False
292294
Accept wildcard characters: False
293295
```
294296

297+
### -IsSimulation
298+
The IsSimulation switch specifies the retention policy is a DLM simulation. You don't need to specify a value with this switch.
299+
300+
For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode).
301+
302+
```yaml
303+
Type: SwitchParameter
304+
Parameter Sets: (All)
305+
Aliases:
306+
Applicable: Security & Compliance
307+
308+
Required: False
309+
Position: Named
310+
Default value: None
311+
Accept pipeline input: False
312+
Accept wildcard characters: False
313+
```
314+
295315
### -ModernGroupLocation
296316
The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are:
297317

exchange/exchange-ps/exchange/Set-RetentionCompliancePolicy.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ For information about the parameter sets in the Syntax section below, see [Excha
2424

2525
### RetryDistribution
2626
```
27-
Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter>
28-
[-RetryDistribution]
27+
Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-RetryDistribution]
2928
[-Confirm]
29+
[-EnforceSimulationPolicy <Boolean>]
30+
[-StartSimulation <Boolean>]
3031
[-WhatIf]
3132
[<CommonParameters>]
3233
```
@@ -49,6 +50,7 @@ Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter>
4950
[-Comment <String>]
5051
[-Confirm]
5152
[-Enabled <Boolean>]
53+
[-EnforceSimulationPolicy <Boolean>]
5254
[-Force]
5355
[-PolicyTemplateInfo <PswsHashtable>]
5456
[-RemoveExchangeLocation <MultiValuedProperty>]
@@ -63,20 +65,22 @@ Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter>
6365
[-RemoveSkypeLocation <MultiValuedProperty>]
6466
[-RemoveSkypeLocationException <MultiValuedProperty>]
6567
[-RestrictiveRetention <Boolean>]
68+
[-StartSimulation <Boolean>]
6669
[-WhatIf]
6770
[<CommonParameters>]
6871
```
6972

7073
### AdaptiveScopeLocation
7174
```
72-
Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter>
73-
[-AddAdaptiveScopeLocation <MultiValuedProperty>]
75+
Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter> [-AddAdaptiveScopeLocation <MultiValuedProperty>]
7476
[-Applications <MultiValuedProperty>]
7577
[-Comment <String>]
7678
[-Confirm]
7779
[-Enabled <Boolean>]
80+
[-EnforceSimulationPolicy <Boolean>]
7881
[-Force]
7982
[-RemoveAdaptiveScopeLocation <MultiValuedProperty>]
83+
[-StartSimulation <Boolean>]
8084
[-WhatIf]
8185
[<CommonParameters>]
8286
```
@@ -91,11 +95,13 @@ Set-RetentionCompliancePolicy [-Identity] <PolicyIdParameter>
9195
[-Comment <String>]
9296
[-Confirm]
9397
[-Enabled <Boolean>]
98+
[-EnforceSimulationPolicy <Boolean>]
9499
[-Force]
95100
[-RemoveTeamsChannelLocation <MultiValuedProperty>]
96101
[-RemoveTeamsChannelLocationException <MultiValuedProperty>]
97102
[-RemoveTeamsChatLocation <MultiValuedProperty>]
98103
[-RemoveTeamsChatLocationException <MultiValuedProperty>]
104+
[-StartSimulation <Boolean>]
99105
[-WhatIf]
100106
[<CommonParameters>]
101107
```
@@ -586,6 +592,25 @@ Accept pipeline input: False
586592
Accept wildcard characters: False
587593
```
588594

595+
### -EnforceSimulationPolicy
596+
Use the EnforceSimulationPolicy parameter to promote a simulation policy to a regular auto-labeling policy. Valid values are:
597+
598+
- $true: Promote the simulation policy to a regular auto-labeling policy.
599+
- $false: Don't promote the simulation policy. This is the default value.
600+
601+
```yaml
602+
Type: Boolean
603+
Parameter Sets: (All)
604+
Aliases:
605+
Applicable: Security & Compliance
606+
607+
Required: False
608+
Position: Named
609+
Default value: None
610+
Accept pipeline input: False
611+
Accept wildcard characters: False
612+
```
613+
589614
### -Force
590615
The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
591616

@@ -993,6 +1018,27 @@ Accept pipeline input: False
9931018
Accept wildcard characters: False
9941019
```
9951020

1021+
### -StartSimulation
1022+
The StartSimulation parameter specifies whether to start a simulation job. Valid values are:
1023+
1024+
- $true: Start the simulation job.
1025+
- $false: Don't start the simulation job. This is the default value.
1026+
1027+
For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/microsoft-365/compliance/apply-retention-labels-automatically#learn-about-simulation-mode).
1028+
1029+
```yaml
1030+
Type: Boolean
1031+
Parameter Sets: (All)
1032+
Aliases:
1033+
Applicable: Security & Compliance
1034+
1035+
Required: False
1036+
Position: Named
1037+
Default value: None
1038+
Accept pipeline input: False
1039+
Accept wildcard characters: False
1040+
```
1041+
9961042
### -WhatIf
9971043
The WhatIf switch doesn't work in Security & Compliance PowerShell.
9981044

0 commit comments

Comments
 (0)