Skip to content

Commit a67f0b8

Browse files
committed
Fixes for Parameter Sets
1 parent 1ddf88e commit a67f0b8

File tree

44 files changed

+579
-594
lines changed

Some content is hidden

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

44 files changed

+579
-594
lines changed

exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md

Lines changed: 182 additions & 132 deletions
Large diffs are not rendered by default.

exchange/exchange-ps/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
###
2120
```
2221
Set-MailboxDatabaseCopy [-Identity] <DatabaseCopyIdParameter> [-ActivationPreference <UInt32>] [-Confirm] [-DatabaseCopyAutoActivationPolicy <DatabaseCopyAutoActivationPolicyType>] [-DomainController <Fqdn>] [-ReplayLagMaxDelay <EnhancedTimeSpan>] [-ReplayLagTime <EnhancedTimeSpan>] [-TruncationLagTime <EnhancedTimeSpan>] [-WhatIf] [<CommonParameters>]
2322
```

exchange/exchange-ps/exchange/devices/Set-ActiveSyncOrganizationSettings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
###
2120
```
2221
Set-ActiveSyncOrganizationSettings [[-Identity] <ActiveSyncOrganizationSettingsIdParameter>] [-AdminMailRecipients <MultiValuedProperty>] [-AllowAccessForUnSupportedPlatform <$true | $false>] [-AllowRMSSupportForUnenlightenedApps <$true | $false>] [-Confirm] [-DefaultAccessLevel <Allow | Block | Quarantine>] [-DomainController <Fqdn>] [-OtaNotificationMailInsert <String>] [-UserMailInsert <String>] [-WhatIf] [<CommonParameters>]
2322
```

exchange/exchange-ps/exchange/mailboxes/Remove-UserPhoto.md

Lines changed: 56 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,22 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
### (Default)
20+
### Identity
2121
```
22-
Remove-UserPhoto [-Identity] <MailboxIdParameter> [-Confirm] [-DomainController <Fqdn>] [-IgnoreDefaultScope]
22+
Remove-UserPhoto [-Identity] <MailboxIdParameter>
23+
[-Confirm]
24+
[-DomainController <Fqdn>]
25+
[-IgnoreDefaultScope]
2326
[-WhatIf] [<CommonParameters>]
2427
```
2528

26-
### Set2
29+
### ClearMailboxPhoto
2730
```
28-
Remove-UserPhoto [-Identity] <MailboxIdParameter> [-ClearMailboxPhotoRecord] [-Confirm]
29-
[-DomainController <Fqdn>] [-GroupMailbox] [-IgnoreDefaultScope] [-PhotoType <String>] [-WhatIf]
30-
[<CommonParameters>]
31+
Remove-UserPhoto [-Identity] <MailboxIdParameter> [-ClearMailboxPhotoRecord] [-GroupMailbox] [-PhotoType <String>]
32+
[-Confirm]
33+
[-DomainController <Fqdn>]
34+
[-IgnoreDefaultScope]
35+
[-WhatIf] [<CommonParameters>]
3136
```
3237

3338
## DESCRIPTION
@@ -85,6 +90,29 @@ Accept pipeline input: True
8590
Accept wildcard characters: False
8691
```
8792
93+
### -ClearMailboxPhotoRecord
94+
The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted.
95+
96+
By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to:
97+
98+
- Return a blank photo.
99+
100+
- Prevent searching Active Directory for a photo.
101+
102+
Using this switch allows photo requests to search Active Directory for a photo. You don't have to specify a value with this switch.
103+
104+
```yaml
105+
Type: SwitchParameter
106+
Parameter Sets: ClearMailboxPhoto
107+
Aliases:
108+
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
88116
### -Confirm
89117
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
90118
@@ -121,73 +149,48 @@ Accept pipeline input: False
121149
Accept wildcard characters: False
122150
```
123151
124-
### -IgnoreDefaultScope
125-
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.
126-
127-
Using the IgnoreDefaultScope switch introduces the following restrictions:
128-
129-
- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
130-
131-
- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.
152+
### -GroupMailbox
153+
The GroupMailbox switch indicates the specified user is an Office 365 Group. You don't need to specify a value with this switch.
132154
133155
```yaml
134156
Type: SwitchParameter
135-
Parameter Sets: (All)
157+
Parameter Sets: ClearMailboxPhoto
136158
Aliases:
137-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
138-
Required: False
139-
Position: Named
140-
Default value: None
141-
Accept pipeline input: False
142-
Accept wildcard characters: False
143-
```
144-
145-
### -WhatIf
146-
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.
147-
148-
```yaml
149-
Type: SwitchParameter
150-
Parameter Sets: (All)
151-
Aliases: wi
152-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
159+
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
153160
Required: False
154161
Position: Named
155162
Default value: None
156163
Accept pipeline input: False
157164
Accept wildcard characters: False
158165
```
159166
160-
### -ClearMailboxPhotoRecord
161-
This parameter is available only in the cloud-based service.
162-
163-
The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted.
164-
165-
By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to:
167+
### -IgnoreDefaultScope
168+
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.
166169
167-
- Return a blank photo.
170+
Using the IgnoreDefaultScope switch introduces the following restrictions:
168171
169-
- Prevent searching Active Directory for a photo.
172+
- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
170173
171-
Using this switch allows photo requests to search Active Directory for a photo. You don't have to specify a value with this switch.
174+
- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.
172175
173176
```yaml
174177
Type: SwitchParameter
175-
Parameter Sets: Set2
178+
Parameter Sets: (All)
176179
Aliases:
177-
Applicable: Exchange Online
178-
Required: True
180+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
181+
Required: False
179182
Position: Named
180183
Default value: None
181184
Accept pipeline input: False
182185
Accept wildcard characters: False
183186
```
184187
185-
### -GroupMailbox
186-
The GroupMailbox switch indicates the specified user is an Office 365 Group. You don't need to specify a value with this switch.
188+
### -PhotoType
189+
This parameter is reserved for internal Microsoft use.
187190
188191
```yaml
189-
Type: SwitchParameter
190-
Parameter Sets: Set2
192+
Type: String
193+
Parameter Sets: ClearMailboxPhoto
191194
Aliases:
192195
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
193196
Required: False
@@ -197,14 +200,14 @@ Accept pipeline input: False
197200
Accept wildcard characters: False
198201
```
199202
200-
### -PhotoType
201-
This parameter is reserved for internal Microsoft use.
203+
### -WhatIf
204+
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.
202205
203206
```yaml
204-
Type: String
205-
Parameter Sets: Set2
206-
Aliases:
207-
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
207+
Type: SwitchParameter
208+
Parameter Sets: (All)
209+
Aliases: wi
210+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
208211
Required: False
209212
Position: Named
210213
Default value: None

exchange/exchange-ps/exchange/organization/Set-PerimeterConfig.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ For information about the parameter sets in the Syntax section below, see Exchan
1717

1818
## SYNTAX
1919

20-
### Set1
2120
```
2221
Set-PerimeterConfig [-Confirm] [-GatewayIPAddresses <MultiValuedProperty>] [-WhatIf] [<CommonParameters>]
2322
```

0 commit comments

Comments
 (0)