Skip to content

Commit e6bf070

Browse files
committed
Updates to mailbox type segregation parameters
Per Issue #2758
1 parent a35d7f7 commit e6bf070

21 files changed

+135
-137
lines changed

exchange/exchange-ps/exchange/client-access/Get-CASMailbox.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,9 @@ Accept wildcard characters: False
344344
### -Monitoring
345345
This parameter is available only in on-premises Exchange.
346346
347-
The Monitoring switch includes mailboxes that were created by monitoring accounts in the results. By default, these mailboxes aren't included in the results. You don't have to specify a value with this switch.
347+
The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch.
348+
349+
Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox.
348350
349351
```yaml
350352
Type: SwitchParameter

exchange/exchange-ps/exchange/devices/Get-ActiveSyncDevice.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,9 @@ Accept wildcard characters: False
203203
### -Monitoring
204204
This parameter is available only in on-premises Exchange.
205205
206-
The Monitoring parameter specifies whether mobile devices created by monitoring accounts are included in the Get-ActiveSyncDevice cmdlet output. The default value is $false.
206+
The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch.
207+
208+
Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox.
207209
208210
```yaml
209211
Type: SwitchParameter

exchange/exchange-ps/exchange/devices/Get-MobileDevice.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ Accept wildcard characters: False
234234
### -Monitoring
235235
This parameter is available only in on-premises Exchange.
236236
237-
The Monitoring parameter specifies whether mobile devices that are created by monitoring accounts are exposed by the Get-MobileDevice cmdlet. The default value is $false.
237+
The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch.
238+
239+
Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox.
238240
239241
```yaml
240242
Type: SwitchParameter

exchange/exchange-ps/exchange/federation-and-hybrid/Disable-RemoteMailbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Accept wildcard characters: False
8787
```
8888
8989
### -Archive
90-
The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox.
90+
The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. You don't need to specify a value with this switch.
9191
9292
The on-premises mail user and its associated cloud-based mailbox aren't removed if you use this switch.
9393

exchange/exchange-ps/exchange/federation-and-hybrid/Enable-RemoteMailbox.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,9 @@ Accept wildcard characters: False
122122
```
123123
124124
### -Equipment
125-
The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox.
125+
The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch.
126+
127+
Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers).
126128
127129
You can't use this switch with the Room or Shared switches.
128130
@@ -219,9 +221,7 @@ Accept wildcard characters: False
219221
```
220222
221223
### -Archive
222-
The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox created in the service.
223-
224-
You don't need to specify a value with this switch.
224+
The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox created in the service. You don't need to specify a value with this switch.
225225
226226
```yaml
227227
Type: SwitchParameter

exchange/exchange-ps/exchange/federation-and-hybrid/Get-RemoteMailbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Accept wildcard characters: False
103103
```
104104
105105
### -Archive
106-
The Archive switch specifies whether to return information about the recipient's archive mailbox.
106+
The Archive switch is required to return the user's archive mailbox in the results. You don't need to specify a value with this switch.
107107
108108
```yaml
109109
Type: SwitchParameter

exchange/exchange-ps/exchange/federation-and-hybrid/New-RemoteMailbox.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,9 @@ Accept wildcard characters: False
139139
### -Equipment
140140
The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox.
141141
142-
You can't use the Equipment switch if you specified the Room switch.
142+
Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers).
143+
144+
You can't use this switch with the Room switch.
143145
144146
```yaml
145147
Type: SwitchParameter
@@ -307,9 +309,7 @@ Accept wildcard characters: False
307309
```
308310
309311
### -Archive
310-
The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox that's created in the service.
311-
312-
You don't have to specify a value with this switch.
312+
The Archive switch specifies whether to also create an archive mailbox in the service. You don't need to specify a value with this switch.
313313
314314
```yaml
315315
Type: SwitchParameter

exchange/exchange-ps/exchange/mailboxes/Connect-Mailbox.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,9 @@ Accept wildcard characters: False
207207
```
208208
209209
### -Equipment
210-
The Equipment switch specifies that you are connecting an equipment mailbox, if this mailbox is a resource mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a resource mailbox
210+
The Equipment switch is required to connect equipment mailboxes. You don't need to specify a value with this switch.
211+
212+
Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers).
211213
212214
```yaml
213215
Type: SwitchParameter
@@ -268,7 +270,9 @@ Accept wildcard characters: False
268270
```
269271
270272
### -Room
271-
The Room switch specifies that you are connecting a room mailbox, if this mailbox is a resource mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a resource mailbox.
273+
The Room switch is required to connect room mailboxes. You don't need to specify a value with this switch.
274+
275+
Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms).
272276
273277
```yaml
274278
Type: SwitchParameter
@@ -283,7 +287,7 @@ Accept wildcard characters: False
283287
```
284288
285289
### -Shared
286-
The Shared switch specifies that you are connecting a shared mailbox. You don't need to specify a value with this switch. This switch is required only if you're connecting a shared mailbox.
290+
The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch.
287291
288292
A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. This mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account.
289293

exchange/exchange-ps/exchange/mailboxes/Disable-Mailbox.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,9 @@ Accept wildcard characters: False
125125
### -Arbitration
126126
This parameter is available only in on-premises Exchange.
127127
128-
The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.
128+
The Arbitration switch is required to mailbox-disable arbitration mailboxes. You don't need to specify a value with this switch.
129+
130+
Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow.
129131
130132
```yaml
131133
Type: SwitchParameter
@@ -142,6 +144,8 @@ Accept wildcard characters: False
142144
### -Archive
143145
The Archive switch specifies whether to disconnect the archive mailbox from the associated user. You don't need to specify a value with this switch.
144146
147+
You can't use this switch with the RemoteArchive switch.
148+
145149
```yaml
146150
Type: SwitchParameter
147151
Parameter Sets: Archive
@@ -286,7 +290,7 @@ Accept wildcard characters: False
286290
### -PublicFolder
287291
This parameter is available only in on-premises Exchange.
288292
289-
The PublicFolderswitch specifies that the mailbox to mailbox-disable is a public folder mailbox. You need to use this switch to mailbox-disable a public folder mailbox. You don't need to specify a value with this switch.
293+
The PublicFolder switch is required to mailbox-disable public folder mailboxes. You don't need to specify a value with this switch.
290294
291295
Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders.
292296
@@ -305,7 +309,7 @@ Accept wildcard characters: False
305309
### -RemoteArchive
306310
This parameter is available only in on-premises Exchange.
307311
308-
The RemoteArchiveswitch specifies whether to disconnect the remote archive for this mailbox. A remote archive exists in the cloud-based service. When you use this switch, the RemoteRecipientType property for the mailbox is reset to specify that this mailbox doesn't have a remote archive. You don't need to specify a value with this switch.
312+
The RemoteArchive switch specifies whether to disconnect the remote archive for this mailbox. Remote archives exist in the cloud-based service. When you use this switch, the RemoteRecipientType property for the mailbox is reset to specify that this mailbox doesn't have a remote archive. You don't need to specify a value with this switch.
309313
310314
You can't use this switch with the Archive switch.
311315

exchange/exchange-ps/exchange/mailboxes/Enable-Mailbox.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,9 @@ Accept wildcard characters: False
308308
### -Arbitration
309309
This parameter is available only in on-premises Exchange.
310310
311-
The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.
311+
The Arbitration switch is required to mailbox-enable arbitration mailboxes. You don't need to specify a value with this switch.
312+
313+
Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow.
312314
313315
```yaml
314316
Type: SwitchParameter
@@ -342,7 +344,7 @@ Accept wildcard characters: False
342344
```
343345
344346
### -Discovery
345-
The Discoveryswitch specifies that the mailbox is a Discovery mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a Discovery mailbox.
347+
The Discovery switch is required to mailbox-enable Discovery mailboxes. You don't need to specify a value with this switch.
346348
347349
Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox. For more information, see In-Place eDiscovery (https://technet.microsoft.com/library/dd298021.aspx).
348350
@@ -361,7 +363,9 @@ Accept wildcard characters: False
361363
### -Equipment
362364
This parameter is available only in on-premises Exchange.
363365
364-
The Equipment parameter specifies that the resource mailbox is an equipment mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling an equipment resource mailbox.
366+
The Equipment switch is required to mailbox-enable equipment mailboxes. You don't need to specify a value with this switch.
367+
368+
Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers).
365369
366370
```yaml
367371
Type: SwitchParameter
@@ -428,7 +432,7 @@ Accept wildcard characters: False
428432
### -LinkedRoom
429433
This parameter is available only in on-premises Exchange.
430434
431-
The LinkedRoomswitchspecifies that the mailbox is a linked resource mailbox. You don't need to specify a value with this switch.
435+
The LinkedRoom switch is required to mailbox-enable linked resource mailboxes. You don't need to specify a value with this switch.
432436
433437
A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest.
434438
@@ -447,7 +451,7 @@ Accept wildcard characters: False
447451
### -PublicFolder
448452
This parameter is available only in on-premises Exchange.
449453
450-
The PublicFolderswitch specifies that the mailbox is a public folder mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a public folder mailbox.
454+
The PublicFolder switch is required to mailbox-enable public folder mailboxes. You don't need to specify a value with this switch.
451455
452456
Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders.
453457
@@ -466,7 +470,9 @@ Accept wildcard characters: False
466470
### -Room
467471
This parameter is available only in on-premises Exchange.
468472
469-
The Roomswitch specifies that the resource mailbox is a room mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a room resource mailbox.
473+
The Room switch is required to mailbox-enable room mailboxes. You don't need to specify a value with this switch.
474+
475+
Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms).
470476
471477
```yaml
472478
Type: SwitchParameter
@@ -483,7 +489,7 @@ Accept wildcard characters: False
483489
### -Shared
484490
This parameter is available only in on-premises Exchange.
485491
486-
The Sharedswitch specifies that the mailbox is a shared mailbox. You don't need to specify a value with this switch. This switch is required only if you're enabling a shared mailbox.
492+
The Shared switch is required to connect shared mailboxes. You don't need to specify a value with this switch.
487493
488494
A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. The mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account.
489495
@@ -581,7 +587,7 @@ Accept wildcard characters: False
581587
```
582588
583589
### -Archive
584-
The Archiveswitchcreates an archive mailbox for an existing user that already has a mailbox. You don't need to specify a value with this switch.
590+
The Archive switch creates an archive mailbox for an existing user that already has a mailbox. You don't need to specify a value with this switch.
585591
586592
```yaml
587593
Type: SwitchParameter
@@ -786,7 +792,7 @@ Accept wildcard characters: False
786792
### -HoldForMigration
787793
This parameter is available only in on-premises Exchange.
788794
789-
The HoldForMigrationswitch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch.
795+
The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch.
790796
791797
You need to use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization.
792798
@@ -881,7 +887,7 @@ Accept wildcard characters: False
881887
### -RemoteArchive
882888
This parameter is available only in on-premises Exchange.
883889
884-
The RemoteArchiveswitch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch.
890+
The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch.
885891
886892
You need to use this parameter with the ArchiveDomain parameter, and you can't use this parameter with the Archive parameter.
887893

0 commit comments

Comments
 (0)