Skip to content

Commit eda2c42

Browse files
chrisdaCopilot
andcommitted
Standardize parameter descriptions (batch 4)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 3805c0d commit eda2c42

98 files changed

Lines changed: 284 additions & 358 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

exchange/exchange-ps/ExchangePowerShell/New-PartnerApplication.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,6 @@ Accept wildcard characters: False
170170
171171
> Applicable: Exchange Server 2013
172172
173-
This parameter is available only in Exchange Server 2013.
174-
175173
This parameter is reserved for internal Microsoft use.
176174
177175
```yaml
@@ -190,8 +188,6 @@ Accept wildcard characters: False
190188
191189
> Applicable: Exchange Server 2013
192190
193-
This parameter is available only in Exchange Server 2013.
194-
195191
This parameter is reserved for internal Microsoft use.
196192
197193
```yaml
@@ -210,10 +206,10 @@ Accept wildcard characters: False
210206
211207
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
212208
213-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
209+
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.
214210
215211
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
216-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
212+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
217213

218214
```yaml
219215
Type: SwitchParameter
@@ -269,8 +265,6 @@ Accept wildcard characters: False
269265

270266
> Applicable: Exchange Server 2013
271267

272-
This parameter is available only in Exchange Server 2013.
273-
274268
This parameter is reserved for internal Microsoft use.
275269

276270
```yaml
@@ -349,7 +343,7 @@ Accept wildcard characters: False
349343

350344
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
351345

352-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
346+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
353347

354348
```yaml
355349
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PhishSimOverridePolicy.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ Accept wildcard characters: False
8484
8585
> Applicable: Exchange Online
8686
87-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
87+
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.
8888
8989
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
90-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
90+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
9191

9292
```yaml
9393
Type: SwitchParameter
@@ -164,9 +164,7 @@ Accept wildcard characters: False
164164

165165
> Applicable: Exchange Online
166166

167-
In Exchange Online PowerShell, the WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
168-
169-
The WhatIf switch doesn't work in Security & Compliance PowerShell.
167+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
170168

171169
```yaml
172170
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PolicyTipConfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ Accept wildcard characters: False
9797
9898
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
9999
100-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
100+
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.
101101
102102
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
103-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
103+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
104104

105105
```yaml
106106
Type: SwitchParameter
@@ -138,7 +138,7 @@ Accept wildcard characters: False
138138

139139
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
140140

141-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
141+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
142142

143143
```yaml
144144
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PowerShellVirtualDirectory.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ Accept wildcard characters: False
9393
9494
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
9595
96-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
96+
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.
9797
9898
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
99-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
99+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
100100

101101
```yaml
102102
Type: SwitchParameter
@@ -304,7 +304,7 @@ Accept wildcard characters: False
304304

305305
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
306306

307-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
307+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
308308

309309
```yaml
310310
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-ProtectionAlert.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,10 +252,10 @@ Accept wildcard characters: False
252252
253253
> Applicable: Security & Compliance
254254
255-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
255+
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.
256256
257257
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
258-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
258+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
259259

260260
```yaml
261261
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PublicFolder.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ Accept wildcard characters: False
8888
8989
> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
9090
91-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
91+
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.
9292
9393
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
94-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
94+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
9595

9696
```yaml
9797
Type: SwitchParameter
@@ -194,8 +194,6 @@ Accept wildcard characters: False
194194

195195
> Applicable: Exchange Server 2010
196196

197-
This parameter is available only in Exchange Server 2010.
198-
199197
The Server parameter specifies the Mailbox server where you want to create the new public folder. You can use any value that uniquely identifies the server. For example:
200198

201199
- Name
@@ -221,7 +219,7 @@ Accept wildcard characters: False
221219

222220
> Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
223221

224-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
222+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
225223

226224
```yaml
227225
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabase.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ Accept wildcard characters: False
9292
9393
> Applicable: Exchange Server 2010
9494
95-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
95+
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.
9696
9797
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
98-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
98+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
9999

100100
```yaml
101101
Type: SwitchParameter
@@ -167,7 +167,7 @@ Accept wildcard characters: False
167167

168168
> Applicable: Exchange Server 2010
169169

170-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
170+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
171171

172172
```yaml
173173
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PublicFolderDatabaseRepairRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ Accept wildcard characters: False
9797
9898
> Applicable: Exchange Server 2010
9999
100-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
100+
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.
101101
102102
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
103-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
103+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
104104

105105
```yaml
106106
Type: SwitchParameter
@@ -154,7 +154,7 @@ Accept wildcard characters: False
154154

155155
> Applicable: Exchange Server 2010
156156

157-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
157+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
158158

159159
```yaml
160160
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMigrationRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,10 @@ Accept wildcard characters: False
181181
182182
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
183183
184-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
184+
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.
185185
186186
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
187-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
187+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
188188

189189
```yaml
190190
Type: SwitchParameter
@@ -448,7 +448,7 @@ Accept wildcard characters: False
448448

449449
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
450450

451-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
451+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
452452

453453
```yaml
454454
Type: SwitchParameter

exchange/exchange-ps/ExchangePowerShell/New-PublicFolderMoveRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,10 @@ Accept wildcard characters: False
205205
206206
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
207207
208-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
208+
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.
209209
210210
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
211-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
211+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you to acknowledge the command before proceeding.
212212

213213
```yaml
214214
Type: SwitchParameter
@@ -414,7 +414,7 @@ Accept wildcard characters: False
414414

415415
> Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
416416

417-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
417+
The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.
418418

419419
```yaml
420420
Type: SwitchParameter

0 commit comments

Comments
 (0)