Skip to content

Commit eca19fc

Browse files
authored
Merge pull request MicrosoftDocs#6792 from MicrosoftDocs/chrisda
Identity param position in syntax blocks
2 parents 1495c29 + 70dcb43 commit eca19fc

23 files changed

+173
-267
lines changed

exchange/exchange-ps/exchange/Add-ADPermission.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,13 @@ Add-ADPermission [-Identity] <ADRawEntryIdParameter> -Owner <SecurityPrincipalId
4747

4848
### Instance
4949
```
50-
Add-ADPermission -Instance <ADAcePresentationObject>
50+
Add-ADPermission [[-Identity] <ADRawEntryIdParameter>] -Instance <ADAcePresentationObject>
5151
[-AccessRights <ActiveDirectoryRights[]>]
5252
[-ChildObjectTypes <ADSchemaObjectIdParameter[]>]
5353
[-Confirm]
5454
[-Deny]
5555
[-DomainController <Fqdn>]
5656
[-ExtendedRights <ExtendedRightIdParameter[]>]
57-
[[-Identity] <ADRawEntryIdParameter>]
5857
[-InheritanceType <ActiveDirectorySecurityInheritance>]
5958
[-InheritedObjectType <ADSchemaObjectIdParameter>]
6059
[-Properties <ADSchemaObjectIdParameter[]>]

exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121
## SYNTAX
2222

2323
```
24-
Add-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter>
25-
[-MailboxServer] <ServerIdParameter>
24+
Add-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter> [-MailboxServer] <ServerIdParameter>
2625
[-Confirm]
2726
[-DomainController <Fqdn>]
2827
[-SkipDagValidation]

exchange/exchange-ps/exchange/Add-MailboxPermission.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,13 @@ Add-MailboxPermission [-Identity] <MailboxIdParameter> -Owner <SecurityPrincipal
4545

4646
### Instance
4747
```
48-
Add-MailboxPermission -Instance <MailboxAcePresentationObject>
48+
Add-MailboxPermission [[-Identity] <MailboxIdParameter>] -Instance <MailboxAcePresentationObject>
4949
[-AccessRights <MailboxRights[]>]
5050
[-User <SecurityPrincipalIdParameter>]
5151
[-AutoMapping <Boolean>]
5252
[-Confirm]
5353
[-Deny]
5454
[-DomainController <Fqdn>]
55-
[[-Identity] <MailboxIdParameter>]
5655
[-IgnoreDefaultScope]
5756
[-InheritanceType <ActiveDirectorySecurityInheritance>]
5857
[-WhatIf]

exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,12 @@ Add-PublicFolderAdministrativePermission [-Identity] <PublicFolderIdParameter> -
3434

3535
### Instance
3636
```
37-
Add-PublicFolderAdministrativePermission -Instance <PublicFolderAdministrativeAceObject>
37+
Add-PublicFolderAdministrativePermission [[-Identity] <PublicFolderIdParameter>] -Instance <PublicFolderAdministrativeAceObject>
3838
[-AccessRights <MultiValuedProperty>]
3939
[-User <SecurityPrincipalIdParameter>]
4040
[-Confirm]
4141
[-Deny]
4242
[-DomainController <Fqdn>]
43-
[[-Identity] <PublicFolderIdParameter>]
4443
[-InheritanceType <ActiveDirectorySecurityInheritance>]
4544
[-Server <ServerIdParameter>]
4645
[-WhatIf]

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

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222

2323
### Equipment
2424
```
25-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
26-
[-Database] <DatabaseIdParameter>
27-
[-Equipment]
25+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> [-Equipment]
2826
[-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>]
2927
[-Alias <String>]
3028
[-Confirm]
@@ -40,14 +38,12 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
4038

4139
### Linked
4240
```
43-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
44-
[-Database] <DatabaseIdParameter> -LinkedDomainController <Fqdn> -LinkedMasterAccount <UserIdParameter>
41+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> -LinkedDomainController <Fqdn> -LinkedMasterAccount <UserIdParameter> [-LinkedCredential <PSCredential>]
4542
[-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>]
4643
[-Alias <String>]
4744
[-Confirm]
4845
[-DomainController <Fqdn>]
4946
[-Force]
50-
[-LinkedCredential <PSCredential>]
5147
[-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>]
5248
[-ManagedFolderMailboxPolicyAllowed]
5349
[-RetentionPolicy <MailboxPolicyIdParameter>]
@@ -58,9 +54,7 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
5854

5955
### Room
6056
```
61-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
62-
[-Database] <DatabaseIdParameter>
63-
[-Room]
57+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> [-Room]
6458
[-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>]
6559
[-Alias <String>]
6660
[-Confirm]
@@ -76,9 +70,7 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
7670

7771
### Shared
7872
```
79-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
80-
[-Database] <DatabaseIdParameter>
81-
[-Shared]
73+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> [-Shared]
8274
[-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>]
8375
[-Alias <String>]
8476
[-Confirm]
@@ -94,9 +86,7 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
9486

9587
### ValidateOnly
9688
```
97-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
98-
[-Database] <DatabaseIdParameter>
99-
[-ValidateOnly]
89+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> [-ValidateOnly]
10090
[-Confirm]
10191
[-DomainController <Fqdn>]
10292
[-Force]
@@ -106,8 +96,7 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
10696

10797
### User
10898
```
109-
Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
110-
[-Database] <DatabaseIdParameter>
99+
Connect-Mailbox [-Identity] <StoreMailboxIdParameter> [-Database] <DatabaseIdParameter> [-User <UserIdParameter>]
111100
[-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>]
112101
[-AllowLegacyDNMismatch]
113102
[-Archive]
@@ -119,7 +108,6 @@ Connect-Mailbox [-Identity] <StoreMailboxIdParameter>
119108
[-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>]
120109
[-ManagedFolderMailboxPolicyAllowed]
121110
[-RetentionPolicy <MailboxPolicyIdParameter>]
122-
[-User <UserIdParameter>]
123111
[-WhatIf]
124112
[<CommonParameters>]
125113
```

exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121
## SYNTAX
2222

2323
```
24-
Get-InformationBarrierRecipientStatus [-Identity] <RecipientIdParameter>
25-
[[-Identity2] <RecipientIdParameter>]
24+
Get-InformationBarrierRecipientStatus [-Identity] <RecipientIdParameter> [[-Identity2] <RecipientIdParameter>]
2625
[<CommonParameters>]
2726
```
2827

exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,9 @@ Get-MailboxFolderStatistics [-Identity] <GeneralMailboxOrMailUserIdParameter>
3737

3838
### AuditLog
3939
```
40-
Get-MailboxFolderStatistics [-AuditLog]
40+
Get-MailboxFolderStatistics [[-Identity] <GeneralMailboxOrMailUserIdParameter>] [-AuditLog]
4141
[-DomainController <Fqdn>]
4242
[-FolderScope <Microsoft.Exchange.Data.Directory.SystemConfiguration.ElcFolderType>]
43-
[[-Identity] <GeneralMailboxOrMailUserIdParameter>]
4443
[-IncludeAnalysis]
4544
[-IncludeOldestAndNewestItems]
4645
[-DiagnosticInfo <String>]

exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,21 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222

2323
### Database
2424
```
25-
Get-MailboxRepairRequest [-Database] <DatabaseIdParameter>
26-
[[-StoreMailbox] <StoreMailboxIdParameter>]
25+
Get-MailboxRepairRequest [-Database] <DatabaseIdParameter> [[-StoreMailbox] <StoreMailboxIdParameter>]
2726
[-DomainController <Fqdn>]
2827
[<CommonParameters>]
2928
```
3029

3130
### Identity
3231
```
33-
Get-MailboxRepairRequest [-Identity] <StoreIntegrityCheckJobIdParameter>
34-
[-Detailed]
32+
Get-MailboxRepairRequest [-Identity] <StoreIntegrityCheckJobIdParameter> [-Detailed]
3533
[-DomainController <Fqdn>]
3634
[<CommonParameters>]
3735
```
3836

3937
### Mailbox
4038
```
41-
Get-MailboxRepairRequest [-Mailbox] <MailboxIdParameter>
42-
[-Archive]
39+
Get-MailboxRepairRequest [-Mailbox] <MailboxIdParameter> [-Archive]
4340
[-DomainController <Fqdn>]
4441
[<CommonParameters>]
4542
```
@@ -81,18 +78,12 @@ This example uses the Database and StoreMailbox parameters to display the Identi
8178

8279
## PARAMETERS
8380

84-
### -Database
85-
The Database parameter returns mailbox repair requests for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example:
86-
87-
- Name
88-
- Distinguished name (DN)
89-
- GUID
90-
91-
You can't use this parameter with the Mailbox parameter.
81+
### -Identity
82+
The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\>.
9283

9384
```yaml
94-
Type: DatabaseIdParameter
95-
Parameter Sets: Database
85+
Type: StoreIntegrityCheckJobIdParameter
86+
Parameter Sets: Identity
9687
Aliases:
9788
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
9889

@@ -103,12 +94,18 @@ Accept pipeline input: True
10394
Accept wildcard characters: False
10495
```
10596
106-
### -Identity
107-
The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is \<DatabaseGuid\>\\\<RequestGuid\>\\\<JobGuid\>.
97+
### -Database
98+
The Database parameter returns mailbox repair requests for all mailboxes on the specified database. You can use any value that uniquely identifies the database. For example:
99+
100+
- Name
101+
- Distinguished name (DN)
102+
- GUID
103+
104+
You can't use this parameter with the Mailbox parameter.
108105
109106
```yaml
110-
Type: StoreIntegrityCheckJobIdParameter
111-
Parameter Sets: Identity
107+
Type: DatabaseIdParameter
108+
Parameter Sets: Database
112109
Aliases:
113110
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
114111

exchange/exchange-ps/exchange/Get-MailboxStatistics.md

Lines changed: 24 additions & 25 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
### Database
2626
```
27-
Get-MailboxStatistics -Database <DatabaseIdParameter>
28-
[[-StoreMailboxIdentity] <StoreMailboxIdParameter>]
27+
Get-MailboxStatistics -Database <DatabaseIdParameter> [[-StoreMailboxIdentity] <StoreMailboxIdParameter>]
2928
[-CopyOnServer <ServerIdParameter>]
3029
[-DomainController <Fqdn>]
3130
[-Filter <String>]
@@ -168,6 +167,29 @@ Accept pipeline input: True
168167
Accept wildcard characters: False
169168
```
170169
170+
### -StoreMailboxIdentity
171+
This parameter is available only in on-premises Exchange.
172+
173+
The StoreMailboxIdentity parameter specifies the mailbox identity when used with the Database parameter to return statistics for a single mailbox on the specified database. You can use one of the following values:
174+
175+
- MailboxGuid
176+
- LegacyDN
177+
178+
Use this syntax to retrieve information about disconnected mailboxes, which don't have a corresponding Active Directory object or that has a corresponding Active Directory object that doesn't point to the disconnected mailbox in the mailbox database.
179+
180+
```yaml
181+
Type: StoreMailboxIdParameter
182+
Parameter Sets: Database
183+
Aliases:
184+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
185+
186+
Required: False
187+
Position: 1
188+
Default value: None
189+
Accept pipeline input: True
190+
Accept wildcard characters: False
191+
```
192+
171193
### -Archive
172194
The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch.
173195
@@ -416,29 +438,6 @@ Accept pipeline input: True
416438
Accept wildcard characters: False
417439
```
418440

419-
### -StoreMailboxIdentity
420-
This parameter is available only in on-premises Exchange.
421-
422-
The StoreMailboxIdentity parameter specifies the mailbox identity when used with the Database parameter to return statistics for a single mailbox on the specified database. You can use one of the following values:
423-
424-
- MailboxGuid
425-
- LegacyDN
426-
427-
Use this syntax to retrieve information about disconnected mailboxes, which don't have a corresponding Active Directory object or that has a corresponding Active Directory object that doesn't point to the disconnected mailbox in the mailbox database.
428-
429-
```yaml
430-
Type: StoreMailboxIdParameter
431-
Parameter Sets: Database
432-
Aliases:
433-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
434-
435-
Required: False
436-
Position: 1
437-
Default value: None
438-
Accept pipeline input: True
439-
Accept wildcard characters: False
440-
```
441-
442441
### CommonParameters
443442
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
444443

exchange/exchange-ps/exchange/Import-ContactList.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ For information about the parameter sets in the Syntax section below, see [Excha
2626
```
2727
Import-ContactList [-Identity] <MailboxIdParameter> -CSVData <Byte[]>
2828
[-CSV]
29-
[-DateCultureName] <String>
3029
[-Confirm]
30+
[-DateCultureName <String>]
3131
[-WhatIf]
3232
[<CommonParameters>]
3333
```
@@ -36,8 +36,8 @@ Import-ContactList [-Identity] <MailboxIdParameter> -CSVData <Byte[]>
3636
```
3737
Import-ContactList [-Identity] <MailboxIdParameter> -CSVStream <Stream>
3838
[-CSV]
39-
[-DateCultureName] <String>
4039
[-Confirm]
40+
[-DateCultureName <String>]
4141
[-WhatIf]
4242
[<CommonParameters>]
4343
```

exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121
## SYNTAX
2222

2323
```
24-
Import-DlpPolicyCollection [-FileData] <Byte[]>
25-
[[-Identity] <DlpPolicyIdParameter>]
24+
Import-DlpPolicyCollection [[-Identity] <DlpPolicyIdParameter>] [-FileData] <Byte[]>
2625
[-Confirm]
2726
[-DomainController <Fqdn>]
2827
[-Force]

exchange/exchange-ps/exchange/Import-JournalRuleCollection.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2121
## SYNTAX
2222

2323
```
24-
Import-JournalRuleCollection [-FileData] <Byte[]>
25-
[[-Identity] <RuleIdParameter>]
24+
Import-JournalRuleCollection [[-Identity] <RuleIdParameter>] [-FileData] <Byte[]>
2625
[-Confirm]
2726
[-DomainController <Fqdn>]
2827
[-WhatIf]

0 commit comments

Comments
 (0)