Skip to content

Commit 01f6df1

Browse files
committed
General formatting fixes
In syntax blocks and parameter order
1 parent 65cd396 commit 01f6df1

File tree

1,157 files changed

+7688
-3301
lines changed

Some content is hidden

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

1,157 files changed

+7688
-3301
lines changed

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,17 @@ Add-ADPermission [-Identity] <ADRawEntryIdParameter> -User <SecurityPrincipalIdP
3232
[-InheritanceType <ActiveDirectorySecurityInheritance>]
3333
[-InheritedObjectType <ADSchemaObjectIdParameter>]
3434
[-Properties <ADSchemaObjectIdParameter[]>]
35-
[-WhatIf] [<CommonParameters>]
35+
[-WhatIf]
36+
[<CommonParameters>]
3637
```
3738

3839
### Owner
3940
```
4041
Add-ADPermission [-Identity] <ADRawEntryIdParameter> -Owner <SecurityPrincipalIdParameter>
4142
[-Confirm]
4243
[-DomainController <Fqdn>]
43-
[-WhatIf] [<CommonParameters>]
44+
[-WhatIf]
45+
[<CommonParameters>]
4446
```
4547

4648
### Instance
@@ -57,7 +59,8 @@ Add-ADPermission -Instance <ADAcePresentationObject>
5759
[-InheritedObjectType <ADSchemaObjectIdParameter>]
5860
[-Properties <ADSchemaObjectIdParameter[]>]
5961
[-User <SecurityPrincipalIdParameter>]
60-
[-WhatIf] [<CommonParameters>]
62+
[-WhatIf]
63+
[<CommonParameters>]
6164
```
6265

6366
## DESCRIPTION

exchange/exchange-ps/exchange/Add-AttachmentFilterEntry.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ For information about the parameter sets in the Syntax section below, see [Excha
2424
Add-AttachmentFilterEntry -Name <String> -Type <AttachmentType>
2525
[-Confirm]
2626
[-DomainController <Fqdn>]
27-
[-WhatIf] [<CommonParameters>]
27+
[-WhatIf]
28+
[<CommonParameters>]
2829
```
2930

3031
## DESCRIPTION

exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md

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

2525
```
26-
Add-AvailabilityAddressSpace -AccessMethod <AvailabilityAccessMethod>
27-
-ForestName <String> [-Confirm] [-Credentials <PSCredential>] [-DomainController <Fqdn>] [-ProxyUrl <Uri>]
28-
[-UseServiceAccount <Boolean>] [-WhatIf] [-TargetAutodiscoverEpr <Uri>] [<CommonParameters>]
26+
Add-AvailabilityAddressSpace -AccessMethod <AvailabilityAccessMethod> -ForestName <String>
27+
[-Confirm]
28+
[-Credentials <PSCredential>]
29+
[-DomainController <Fqdn>]
30+
[-ProxyUrl <Uri>]
31+
[-TargetAutodiscoverEpr <Uri>]
32+
[-UseServiceAccount <Boolean>]
33+
[-WhatIf]
34+
[<CommonParameters>]
2935
```
3036

3137
## DESCRIPTION
@@ -171,6 +177,22 @@ Accept pipeline input: False
171177
Accept wildcard characters: False
172178
```
173179

180+
### -TargetAutodiscoverEpr
181+
The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.xml`. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests.
182+
183+
```yaml
184+
Type: Uri
185+
Parameter Sets: (All)
186+
Aliases:
187+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
188+
189+
Required: False
190+
Position: Named
191+
Default value: None
192+
Accept pipeline input: False
193+
Accept wildcard characters: False
194+
```
195+
174196
### -UseServiceAccount
175197
This parameter is available only in on-premises Exchange.
176198

@@ -208,22 +230,6 @@ Accept pipeline input: False
208230
Accept wildcard characters: False
209231
```
210232

211-
### -TargetAutodiscoverEpr
212-
The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.xml`. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests.
213-
214-
```yaml
215-
Type: Uri
216-
Parameter Sets: (All)
217-
Aliases:
218-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
219-
220-
Required: False
221-
Position: Named
222-
Default value: None
223-
Accept pipeline input: False
224-
Accept wildcard characters: False
225-
```
226-
227233
### CommonParameters
228234
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).
229235

exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md

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

2323
```
24-
Add-ComplianceCaseMember [-Case] <String> -Member <String> [-Confirm] [-WhatIf] [<CommonParameters>]
24+
Add-ComplianceCaseMember [-Case] <String> -Member <String>
25+
[-Confirm]
26+
[-WhatIf]
27+
[<CommonParameters>]
2528
```
2629

2730
## DESCRIPTION

exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md

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

2323
```
24-
Add-ContentFilterPhrase [-Phrase] <String> -Influence <Influence> [-Confirm]
25-
[-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>]
24+
Add-ContentFilterPhrase [-Phrase] <String> -Influence <Influence>
25+
[-Confirm]
26+
[-DomainController <Fqdn>]
27+
[-WhatIf]
28+
[<CommonParameters>]
2629
```
2730

2831
## DESCRIPTION
@@ -41,35 +44,35 @@ This example adds the phrase Free credit report to the Block phrase list. Any me
4144

4245
## PARAMETERS
4346

44-
### -Influence
45-
The Influence parameter specifies whether the phrase being added will cause the messages that contain the phrase to be allowed or blocked. Valid values are GoodWord and BadWord.
46-
47-
A message that contains a custom word or phrase that has an Influence value of GoodWord is automatically assigned a spam confidence level (SCL) rating of 0 and therefore bypasses downstream spam processing. A message that contains a custom word or phrase that has an Influence value of BadWord is automatically assigned an SCL rating of 9 and therefore is treated as spam.
47+
### -Phrase
48+
The Phrase parameter specifies a custom word or phrase for the Content Filter agent. When you pass an argument, you must enclose the Phrase parameter in quotation marks (") if the phrase contains spaces, for example: "This is a bad phrase". Custom phrases must be less than 257 characters in length.
4849

4950
```yaml
50-
Type: Influence
51+
Type: String
5152
Parameter Sets: (All)
5253
Aliases:
5354
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
5455

5556
Required: True
56-
Position: Named
57+
Position: 1
5758
Default value: None
5859
Accept pipeline input: True
5960
Accept wildcard characters: False
6061
```
6162
62-
### -Phrase
63-
The Phrase parameter specifies a custom word or phrase for the Content Filter agent. When you pass an argument, you must enclose the Phrase parameter in quotation marks (") if the phrase contains spaces, for example: "This is a bad phrase". Custom phrases must be less than 257 characters in length.
63+
### -Influence
64+
The Influence parameter specifies whether the phrase being added will cause the messages that contain the phrase to be allowed or blocked. Valid values are GoodWord and BadWord.
65+
66+
A message that contains a custom word or phrase that has an Influence value of GoodWord is automatically assigned a spam confidence level (SCL) rating of 0 and therefore bypasses downstream spam processing. A message that contains a custom word or phrase that has an Influence value of BadWord is automatically assigned an SCL rating of 9 and therefore is treated as spam.
6467
6568
```yaml
66-
Type: String
69+
Type: Influence
6770
Parameter Sets: (All)
6871
Aliases:
6972
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
7073

7174
Required: True
72-
Position: 1
75+
Position: Named
7376
Default value: None
7477
Accept pipeline input: True
7578
Accept wildcard characters: False

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

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

2323
```
24-
Add-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter> [-MailboxServer] <ServerIdParameter>
24+
Add-DatabaseAvailabilityGroupServer [-Identity] <DatabaseAvailabilityGroupIdParameter>
25+
[-MailboxServer] <ServerIdParameter>
2526
[-Confirm]
2627
[-DomainController <Fqdn>]
2728
[-SkipDagValidation]
28-
[-WhatIf] [<CommonParameters>]
29+
[-WhatIf]
30+
[<CommonParameters>]
2931
```
3032

3133
## DESCRIPTION

exchange/exchange-ps/exchange/Add-DistributionGroupMember.md

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

2323
```
24-
Add-DistributionGroupMember [-Identity] <DistributionGroupIdParameter> [-BypassSecurityGroupManagerCheck]
25-
[-Confirm] [-DomainController <Fqdn>] [-Member <RecipientWithAdUserGroupIdParameter>] [-WhatIf]
24+
Add-DistributionGroupMember [-Identity] <DistributionGroupIdParameter>
25+
[-BypassSecurityGroupManagerCheck]
26+
[-Confirm]
27+
[-DomainController <Fqdn>]
28+
[-Member <RecipientWithAdUserGroupIdParameter>]
29+
[-WhatIf]
2630
[<CommonParameters>]
2731
```
2832

exchange/exchange-ps/exchange/Add-FederatedDomain.md

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

2525
```
26-
Add-FederatedDomain [[-Identity] <OrganizationIdParameter>] -DomainName <SmtpDomain> [-Confirm]
27-
[-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>]
26+
Add-FederatedDomain [[-Identity] <OrganizationIdParameter>] -DomainName <SmtpDomain>
27+
[-Confirm]
28+
[-DomainController <Fqdn>]
29+
[-WhatIf]
30+
[<CommonParameters>]
2831
```
2932

3033
## DESCRIPTION
@@ -45,6 +48,22 @@ This example adds the domain Contoso.co.uk to the existing federation trust.
4548

4649
## PARAMETERS
4750

51+
### -Identity
52+
This parameter is reserved for internal Microsoft use.
53+
54+
```yaml
55+
Type: OrganizationIdParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
59+
60+
Required: False
61+
Position: 1
62+
Default value: None
63+
Accept pipeline input: True
64+
Accept wildcard characters: False
65+
```
66+
4867
### -DomainName
4968
The DomainName parameter specifies the secondary domain to be configured.
5069
@@ -96,22 +115,6 @@ Accept pipeline input: False
96115
Accept wildcard characters: False
97116
```
98117

99-
### -Identity
100-
This parameter is reserved for internal Microsoft use.
101-
102-
```yaml
103-
Type: OrganizationIdParameter
104-
Parameter Sets: (All)
105-
Aliases:
106-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
107-
108-
Required: False
109-
Position: 1
110-
Default value: None
111-
Accept pipeline input: True
112-
Accept wildcard characters: False
113-
```
114-
115118
### -WhatIf
116119
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.
117120

exchange/exchange-ps/exchange/Add-GlobalMonitoringOverride.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,20 @@ Add-GlobalMonitoringOverride [-Identity] <String> -ApplyVersion <Version> -ItemT
2626
[-Confirm]
2727
[-DomainController <Fqdn>]
2828
[-Roles <String>]
29-
[-WhatIf] [<CommonParameters>]
29+
[-WhatIf]
30+
[<CommonParameters>]
3031
```
3132

3233
### Duration
3334
```
34-
Add-GlobalMonitoringOverride [-Identity] <String> -ItemType <MonitoringItemTypeEnum> -PropertyName <String> -PropertyValue <String> [-BuildRange <String>] [-Duration <EnhancedTimeSpan>]
35+
Add-GlobalMonitoringOverride [-Identity] <String> -ItemType <MonitoringItemTypeEnum> -PropertyName <String> -PropertyValue <String>
36+
[-BuildRange <String>]
37+
[-Duration <EnhancedTimeSpan>]
3538
[-Confirm]
3639
[-DomainController <Fqdn>]
3740
[-Roles <String>]
38-
[-WhatIf] [<CommonParameters>]
41+
[-WhatIf]
42+
[<CommonParameters>]
3943
```
4044

4145
## DESCRIPTION
@@ -59,37 +63,37 @@ This example adds a global monitoring override that disables the StorageLogicalD
5963

6064
## PARAMETERS
6165

62-
### -ApplyVersion
63-
The ApplyVersion parameter specifies the version of Exchange that gets the override. If an Exchange server is older or newer than the version you specify, the override isn't applied to the server. Typically, you increase the Exchange version by applying Cumulative Updates or Service Packs.
64-
65-
Valid input for this parameter is an Exchange version number in the format 15.0x.xxxx.xxx.
66-
67-
You can't use this parameter with the Duration parameter.
66+
### -Identity
67+
The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax \<HealthSetName\>\\\<MonitoringItemName\>[\\\<TargetResource\>]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityServerReboot", not "ad\\activedirectoryconnectivityserverreboot".
6868

6969
```yaml
70-
Type: Version
71-
Parameter Sets: ApplyVersion
70+
Type: String
71+
Parameter Sets: (All)
7272
Aliases:
7373
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
7474

7575
Required: True
76-
Position: Named
76+
Position: 1
7777
Default value: None
7878
Accept pipeline input: False
7979
Accept wildcard characters: False
8080
```
8181
82-
### -Identity
83-
The Identity parameter specifies the identity of the probe, monitor, or responder. This parameter uses the syntax \<HealthSetName\>\\\<MonitoringItemName\>[\\\<TargetResource\>]. Note that the values are case sensitive. For example, use "AD\\ActiveDirectoryConnectivityServerReboot", not "ad\\activedirectoryconnectivityserverreboot".
82+
### -ApplyVersion
83+
The ApplyVersion parameter specifies the version of Exchange that gets the override. If an Exchange server is older or newer than the version you specify, the override isn't applied to the server. Typically, you increase the Exchange version by applying Cumulative Updates or Service Packs.
84+
85+
Valid input for this parameter is an Exchange version number in the format 15.0x.xxxx.xxx.
86+
87+
You can't use this parameter with the Duration parameter.
8488
8589
```yaml
86-
Type: String
87-
Parameter Sets: (All)
90+
Type: Version
91+
Parameter Sets: ApplyVersion
8892
Aliases:
8993
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
9094

9195
Required: True
92-
Position: 1
96+
Position: Named
9397
Default value: None
9498
Accept pipeline input: False
9599
Accept wildcard characters: False

exchange/exchange-ps/exchange/Add-IPAllowListEntry.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ Add-IPAllowListEntry -IPAddress <IPAddress>
2727
[-Confirm]
2828
[-ExpirationTime <DateTime>]
2929
[-Server <ServerIdParameter>]
30-
[-WhatIf] [<CommonParameters>]
30+
[-WhatIf]
31+
[<CommonParameters>]
3132
```
3233

3334
### IPRange
@@ -37,7 +38,8 @@ Add-IPAllowListEntry -IPRange <IPRange>
3738
[-Confirm]
3839
[-ExpirationTime <DateTime>]
3940
[-Server <ServerIdParameter>]
40-
[-WhatIf] [<CommonParameters>]
41+
[-WhatIf]
42+
[<CommonParameters>]
4143
```
4244

4345
## DESCRIPTION

0 commit comments

Comments
 (0)