Skip to content

Commit ad0073a

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#5716 from MicrosoftDocs/master
Master to Live
2 parents 60cfb36 + 2561ae0 commit ad0073a

15 files changed

+241
-201
lines changed

‎exchange/exchange-ps/exchange/Connect-ExchangeOnline.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,6 @@ Accept pipeline input: False
264264
Accept wildcard characters: False
265265
```
266266

267-
268267
### -PSSessionOption
269268
The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. You store the output of the [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable, for example:
270269

‎exchange/exchange-ps/exchange/Get-EXOCasMailbox.md

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

2525
### Identity (Default)
2626
```
27-
Get-EXOCasMailbox
28-
[[-Identity] <String>]
27+
Get-EXOCasMailbox [[-Identity] <String>]
2928
[-Filter <String>]
3029
[-ExternalDirectoryObjectId <Guid>]
3130
[-OrganizationalUnit <String>]
@@ -39,8 +38,7 @@ Get-EXOCasMailbox
3938

4039
### Anr
4140
```
42-
Get-EXOCasMailbox
43-
[-Anr <String>]
41+
Get-EXOCasMailbox [-Anr <String>]
4442
[-Filter <String>]
4543
[-OrganizationalUnit <String>]
4644
[-Properties <String[]>]
@@ -78,6 +76,44 @@ This example returns the values of the following client access settings for the
7876

7977
## PARAMETERS
8078

79+
### -Identity
80+
The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:
81+
82+
- User ID or user principal name (UPN)
83+
84+
- GUID
85+
86+
Otherwise, you can use any other value that uniquely identifies the mailbox. For example:
87+
88+
- Name
89+
90+
- Alias
91+
92+
- Distinguished name (DN)
93+
94+
- \<domain name\>\\\<account name\>
95+
96+
- Email address
97+
98+
- LegacyExchangeDN
99+
100+
- SamAccountName
101+
102+
You can't use this parameter with the Anr parameter.
103+
104+
```yaml
105+
Type: String
106+
Parameter Sets: Identity
107+
Aliases:
108+
Applicable: Exchange Online
109+
110+
Required: False
111+
Position: 0
112+
Default value: None
113+
Accept pipeline input: True (ByPropertyName, ByValue)
114+
Accept wildcard characters: False
115+
```
116+
81117
### -Anr
82118
The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:
83119
@@ -148,42 +184,6 @@ Accept pipeline input: False
148184
Accept wildcard characters: False
149185
```
150186

151-
### -Identity
152-
The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example:
153-
154-
- Distinguished name (DN)
155-
156-
- Canonical DN
157-
158-
- \<domain name\>\\\<account name\>
159-
160-
- Email address
161-
162-
- GUID
163-
164-
- LegacyExchangeDN
165-
166-
- SamAccountName
167-
168-
- User ID or user principal name (UPN)
169-
170-
**Note**: This parameter doesn't support Name or Alias values.
171-
172-
You can't use this parameter with the Anr parameter.
173-
174-
```yaml
175-
Type: String
176-
Parameter Sets: Identity
177-
Aliases:
178-
Applicable: Exchange Online
179-
180-
Required: False
181-
Position: 0
182-
Default value: None
183-
Accept pipeline input: True (ByPropertyName, ByValue)
184-
Accept wildcard characters: False
185-
```
186-
187187
### -OrganizationalUnit
188188
The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:
189189

‎exchange/exchange-ps/exchange/Get-EXOMailbox.md

Lines changed: 38 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,44 @@ This example returns the specified properties for the mailbox John@contoso.com.
9898

9999
## PARAMETERS
100100

101+
### -Identity
102+
The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:
103+
104+
- User ID or user principal name (UPN)
105+
106+
- GUID
107+
108+
Otherwise, you can use any value that uniquely identifies the mailbox. For example:
109+
110+
- Name
111+
112+
- Alias
113+
114+
- Distinguished name (DN)
115+
116+
- \<domain name\>\\\<account name\>
117+
118+
- Email address
119+
120+
- LegacyExchangeDN
121+
122+
- SamAccountName
123+
124+
You can't use this parameter with the Anr parameter.
125+
126+
```yaml
127+
Type: String
128+
Parameter Sets: Identity
129+
Aliases:
130+
Applicable: Exchange Online
131+
132+
Required: False
133+
Position: 0
134+
Default value: None
135+
Accept pipeline input: True (ByPropertyName, ByValue)
136+
Accept wildcard characters: False
137+
```
138+
101139
### -Anr
102140
The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:
103141
@@ -184,34 +222,6 @@ Accept pipeline input: False
184222
Accept wildcard characters: False
185223
```
186224

187-
### -Identity
188-
The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example:
189-
190-
- Email address
191-
192-
- GUID
193-
194-
- External Directory Object ID
195-
196-
- User Principal Name (UPN)
197-
198-
**Note**: This parameter doesn't support Name or Alias values.
199-
200-
You can't use this parameter with the Anr parameter.
201-
202-
```yaml
203-
Type: String
204-
Parameter Sets: Identity
205-
Aliases:
206-
Applicable: Exchange Online
207-
208-
Required: False
209-
Position: 0
210-
Default value: None
211-
Accept pipeline input: True (ByPropertyName, ByValue)
212-
Accept wildcard characters: False
213-
```
214-
215225
### -InactiveMailboxOnly
216226
The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.
217227

‎exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@ For information about the parameter sets in the Syntax section below, see [Excha
2323
## SYNTAX
2424

2525
```
26-
Get-EXOMailboxFolderPermission
26+
Get-EXOMailboxFolderPermission [[-Identity] <String>]
2727
[-User <String>]
2828
[-GroupMailbox]
29-
[[-Identity] <String>]
3029
[-ExternalDirectoryObjectId <Guid>]
3130
[-UserPrincipalName <String>]
3231
[<CommonParameters>]
@@ -52,58 +51,67 @@ Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -Us
5251

5352
This example returns the permissions for the same folder in John's mailbox, but only for the user Kim.
5453

55-
5654
## PARAMETERS
5755

58-
### -ExternalDirectoryObjectId
59-
The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.
56+
### -Identity
57+
The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:\<Folder>`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.
58+
59+
Otherwise, you can use any value that uniquely identifies the mailbox. For example:
60+
61+
- Name
62+
63+
- Alias
64+
65+
- Distinguished name (DN)
66+
67+
- Email address
68+
69+
- LegacyExchangeDN
70+
71+
- SamAccountName
6072

6173
```yaml
62-
Type: Guid
74+
Type: String
6375
Parameter Sets: (All)
6476
Aliases:
6577
Applicable: Exchange Online
6678

6779
Required: False
68-
Position: Named
80+
Position: 0
6981
Default value: None
70-
Accept pipeline input: True (ByPropertyName)
82+
Accept pipeline input: True (ByPropertyName, ByValue)
7183
Accept wildcard characters: False
7284
```
7385
74-
### -GroupMailbox
75-
The GroupMailbox switch is required to return Office 365 groups in the results. You don't need to specify a value with this switch.
86+
### -ExternalDirectoryObjectId
87+
The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.
7688
7789
```yaml
78-
Type: SwitchParameter
90+
Type: Guid
7991
Parameter Sets: (All)
8092
Aliases:
8193
Applicable: Exchange Online
8294

8395
Required: False
8496
Position: Named
8597
Default value: None
86-
Accept pipeline input: False
98+
Accept pipeline input: True (ByPropertyName)
8799
Accept wildcard characters: False
88100
```
89101
90-
### -Identity
91-
The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:\<Folder>`. For the value of \<Mailbox\>, you can use any value that uniquely identifies the mailbox. For example:
92-
93-
- `<UPN>:<FolderPath>` (for example`john@contoso.com:\Calendar` or `John:\Marketing\Reports`).
94-
95-
- `<ExternalDirectoryObjectId>:<FolderPath>`
102+
### -GroupMailbox
103+
The GroupMailbox switch is required to return Office 365 groups in the results. You don't need to specify a value with this switch.
96104
97105
```yaml
98-
Type: String
106+
Type: SwitchParameter
99107
Parameter Sets: (All)
100108
Aliases:
101109
Applicable: Exchange Online
102110

103111
Required: False
104-
Position: 0
112+
Position: Named
105113
Default value: None
106-
Accept pipeline input: True (ByPropertyName, ByValue)
114+
Accept pipeline input: False
107115
Accept wildcard characters: False
108116
```
109117
@@ -122,6 +130,8 @@ The User parameter filters the results by the specified mailbox, mail user, or m
122130
123131
- GUID
124132
133+
**Note**: If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception.
134+
125135
```yaml
126136
Type: String
127137
Parameter Sets: (All)

‎exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ Get-EXOMailboxFolderStatistics
2828
[-ExternalDirectoryObjectId <Guid>]
2929
[-Folderscope <ElcFolderType>]
3030
[-Identity <String>]
31-
[-IncludeAnalysis]
3231
[-IncludeOldestAndNewestItems]
3332
[-IncludeSoftDeletedRecipients]
3433
[-ResultSize <Unlimited>]
@@ -154,44 +153,30 @@ Accept wildcard characters: False
154153
```
155154
156155
### -Identity
157-
The Identity parameter specifies the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user. For example:
156+
The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.
158157
159-
- GUID
160-
161-
- User Principal Name (UPN)
158+
Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example:
162159
163160
- Name
164161
165162
- Alias
166163
167-
```yaml
168-
Type: String
169-
Parameter Sets: (All)
170-
Aliases:
171-
Applicable: Exchange Online
164+
- Distinguished name (DN)
172165
173-
Required: False
174-
Position: Named
175-
Default value: None
176-
Accept pipeline input: True (ByPropertyName)
177-
Accept wildcard characters: False
178-
```
179-
180-
### -IncludeAnalysis
181-
The IncludeAnalysis switch specifies whether to scan all items within a folder and return statistics related to the folder and item size. You don't need to specify a value with this switch.
166+
- LegacyExchangeDN
182167
183-
You should use this switch for troubleshooting purposes, because the command might take a long time to complete.
168+
- SamAccountName
184169
185170
```yaml
186-
Type: SwitchParameter
171+
Type: String
187172
Parameter Sets: (All)
188173
Aliases:
189174
Applicable: Exchange Online
190175

191176
Required: False
192177
Position: Named
193178
Default value: None
194-
Accept pipeline input: False
179+
Accept pipeline input: True (ByPropertyName)
195180
Accept wildcard characters: False
196181
```
197182

‎exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -95,28 +95,20 @@ Accept wildcard characters: False
9595
```
9696
9797
### -Identity
98-
The Identity parameter specifies the mailbox you want to view. You can use any value that uniquely identifies the mailbox. For example:
98+
The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.
99+
100+
Otherwise, you can use any value that uniquely identifies the mailbox. For example:
99101
100102
- Name
101103
102104
- Alias
103105
104106
- Distinguished name (DN)
105107
106-
- Canonical DN
107-
108-
- \<domain name\>\\\<account name\>
109-
110-
- Email address
111-
112-
- GUID
113-
114108
- LegacyExchangeDN
115109
116110
- SamAccountName
117111
118-
- User ID or user principal name (UPN)
119-
120112
```yaml
121113
Type: String
122114
Parameter Sets: Identity

0 commit comments

Comments
 (0)