Skip to content

Commit b0a085a

Browse files
authored
Merge pull request MicrosoftDocs#6512 from Luspin/patch-1
Update Get-CASMailbox.md
2 parents 7aa6d61 + be94e48 commit b0a085a

File tree

1 file changed

+77
-36
lines changed

1 file changed

+77
-36
lines changed

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

Lines changed: 77 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Get-CASMailbox [-Anr <String>]
4040
[-SortBy <String>]
4141
[-ReadIsOptimizedForAccessibility]
4242
[-RecalculateHasActiveSyncDevicePartnership] [<CommonParameters>]
43+
[-RecipientTypeDetails <RecipientTypeDetails[]>]
4344
```
4445

4546
### Identity
@@ -59,6 +60,7 @@ Get-CASMailbox [[-Identity] <MailboxIdParameter>]
5960
[-SortBy <String>]
6061
[-ReadIsOptimizedForAccessibility]
6162
[-RecalculateHasActiveSyncDevicePartnership] [<CommonParameters>]
63+
[-RecipientTypeDetails <RecipientTypeDetails[]>]
6264
```
6365

6466
## DESCRIPTION
@@ -99,8 +101,52 @@ Get-CASMailbox [email protected] | Format-List Ews*
99101

100102
This example returns all Exchange Web Services settings for the user [email protected].
101103

104+
105+
### Example 4
106+
```powershell
107+
Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select *
108+
```
109+
110+
In Exchange Online, this example filters the cmdlet output to only include shared mailboxes.
111+
102112
## PARAMETERS
103113

114+
### -Identity
115+
The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example:
116+
117+
- Name
118+
119+
- Alias
120+
121+
- Distinguished name (DN)
122+
123+
- Canonical DN
124+
125+
- \<domain name\>\\\<account name\>
126+
127+
- Email address
128+
129+
- GUID
130+
131+
- LegacyExchangeDN
132+
133+
- SamAccountName
134+
135+
- User ID or user principal name (UPN)
136+
137+
```yaml
138+
Type: MailboxIdParameter
139+
Parameter Sets: Identity
140+
Aliases:
141+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
142+
143+
Required: False
144+
Position: 1
145+
Default value: None
146+
Accept pipeline input: True
147+
Accept wildcard characters: False
148+
```
149+
104150
### -ActiveSyncDebugLogging
105151
The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. If you don't use this switch, the value always appears as $false.
106152
@@ -225,42 +271,6 @@ Accept pipeline input: False
225271
Accept wildcard characters: False
226272
```
227273

228-
### -Identity
229-
The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example:
230-
231-
- Name
232-
233-
- Alias
234-
235-
- Distinguished name (DN)
236-
237-
- Canonical DN
238-
239-
- \<domain name\>\\\<account name\>
240-
241-
- Email address
242-
243-
- GUID
244-
245-
- LegacyExchangeDN
246-
247-
- SamAccountName
248-
249-
- User ID or user principal name (UPN)
250-
251-
```yaml
252-
Type: MailboxIdParameter
253-
Parameter Sets: Identity
254-
Aliases:
255-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
256-
257-
Required: False
258-
Position: 1
259-
Default value: None
260-
Accept pipeline input: True
261-
Accept wildcard characters: False
262-
```
263-
264274
### -IgnoreDefaultScope
265275
The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope.
266276

@@ -409,6 +419,37 @@ Accept pipeline input: False
409419
Accept wildcard characters: False
410420
```
411421

422+
### -RecipientTypeDetails
423+
This parameter is available only in the cloud-based service.
424+
425+
The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:
426+
427+
- DiscoveryMailbox
428+
- EquipmentMailbox
429+
- LegacyMailbox
430+
- LinkedMailbox
431+
- LinkedRoomMailbox
432+
- MailUser
433+
- RoomMailbox
434+
- SharedMailbox
435+
- TeamMailbox
436+
- UserMailbox
437+
438+
You can specify multiple values separated by commas.
439+
440+
```yaml
441+
Type: RecipientTypeDetails[]
442+
Parameter Sets: (All)
443+
Aliases:
444+
Applicable: Exchange Online
445+
446+
Required: False
447+
Position: Named
448+
Default value: None
449+
Accept pipeline input: False
450+
Accept wildcard characters: False
451+
```
452+
412453
### -ResultSize
413454
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
414455

0 commit comments

Comments
 (0)