Skip to content

Commit d523bfa

Browse files
chrisdachrisda
committed
Updated Connect-ExchangeOnline and Connect-IPPSSession
To match current v2.0.3 reality.
1 parent 8fe1cea commit d523bfa

File tree

2 files changed

+120
-68
lines changed

2 files changed

+120
-68
lines changed

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

Lines changed: 67 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -22,24 +22,29 @@ For information about the parameter sets in the Syntax section below, see [Excha
2222
## SYNTAX
2323

2424
```
25-
Connect-ExchangeOnline [[-ConnectionUri] <String>] [[-AzureADAuthorizationEndpointUri] <String>] [[-ExchangeEnvironmentName] <ExchangeEnvironment>] [[-PSSessionOption] <PSSessionOption>] [[-DelegatedOrganization] <String>]
25+
Connect-ExchangeOnline
26+
[[-ConnectionUri] <String>]
27+
[[-AzureADAuthorizationEndpointUri] <String>]
28+
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
29+
[[-PSSessionOption] <PSSessionOption>]
30+
[[-DelegatedOrganization] <String>]
31+
[[-Prefix <String>]]
32+
[[-CommandName <String[]>]]
33+
[[-FormatTypeName <String[]>]]
2634
[-AppId <String>]
2735
[-BypassMailboxAnchoring]
2836
[-Certificate <X509Certificate2>]
2937
[-CertificateFilePath <String>]
3038
[-CertificatePassword <SecureString>]
3139
[-CertificateThumbprint <String>]
32-
[-CommandName <String[]>]
3340
[-Credential <PSCredential>]
3441
[-Device]
3542
[-EnableErrorReporting]
36-
[-FormatTypeName <String[]>]
3743
[-InlineCredential]
3844
[-LogDirectoryPath <String>]
3945
[-LogLevel <LogLevel>]
4046
[-Organization <String>]
4147
[-PageSize <UInt32>]
42-
[-Prefix <String>]
4348
[-ShowBanner]
4449
[-ShowProgress <Boolean>]
4550
[-TrackPerformance <Boolean>]
@@ -133,7 +138,7 @@ Aliases:
133138
Applicable: Exchange Online
134139

135140
Required: False
136-
Position: 1
141+
Position: 0
137142
Default value: None
138143
Accept pipeline input: False
139144
Accept wildcard characters: False
@@ -157,7 +162,7 @@ Aliases:
157162
Applicable: Exchange Online
158163
159164
Required: False
160-
Position: 2
165+
Position: 1
161166
Default value: None
162167
Accept pipeline input: False
163168
Accept wildcard characters: False
@@ -179,7 +184,7 @@ Aliases:
179184
Applicable: Exchange Online
180185
181186
Required: False
182-
Position: 3
187+
Position: 2
183188
Default value: O365Default
184189
Accept pipeline input: False
185190
Accept wildcard characters: False
@@ -199,7 +204,7 @@ Aliases:
199204
Applicable: Exchange Online
200205
201206
Required: False
202-
Position: 4
207+
Position: 3
203208
Default value: None
204209
Accept pipeline input: False
205210
Accept wildcard characters: False
@@ -216,13 +221,63 @@ Parameter Sets: (All)
216221
Aliases:
217222
Applicable: Exchange Online
218223
224+
Required: False
225+
Position: 4
226+
Default value: None
227+
Accept pipeline input: False
228+
Accept wildcard characters: False
229+
```
230+
231+
### -Prefix
232+
The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets).
233+
234+
```yaml
235+
Type: String
236+
Parameter Sets: (All)
237+
Aliases:
238+
Applicable: Exchange Online
239+
219240
Required: False
220241
Position: 5
221242
Default value: None
222243
Accept pipeline input: False
223244
Accept wildcard characters: False
224245
```
225246

247+
### -CommandName
248+
**Note**: This parameter is available in version 2.0.3 or later.
249+
250+
The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script.
251+
252+
```yaml
253+
Type: String[]
254+
Parameter Sets: (All)
255+
Aliases:
256+
Applicable: Exchange Online
257+
258+
Required: False
259+
Position: 6
260+
Default value: None
261+
Accept pipeline input: False
262+
Accept wildcard characters: False
263+
```
264+
265+
### -FormatTypeName
266+
The FormatTypeName parameter specifies the output format of the cmdlet.
267+
268+
```yaml
269+
Type: String[]
270+
Parameter Sets: (All)
271+
Aliases:
272+
Applicable: Exchange Online
273+
274+
Required: False
275+
Position: 7
276+
Default value: None
277+
Accept pipeline input: False
278+
Accept wildcard characters: False
279+
```
280+
226281
### -AppId
227282
**Note**: This parameter is available in version 2.0.3 or later.
228283

@@ -347,24 +402,6 @@ Accept pipeline input: False
347402
Accept wildcard characters: False
348403
```
349404

350-
### -CommandName
351-
**Note**: This parameter is available in version 2.0.3 or later.
352-
353-
The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script.
354-
355-
```yaml
356-
Type: String[]
357-
Parameter Sets: (All)
358-
Aliases:
359-
Applicable: Exchange Online
360-
361-
Required: False
362-
Position: Named
363-
Default value: None
364-
Accept pipeline input: False
365-
Accept wildcard characters: False
366-
```
367-
368405
### -Credential
369406
The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. You don't use this parameter for accounts with multi-factor authentication (MFA).
370407

@@ -405,29 +442,11 @@ Accept pipeline input: False
405442
Accept wildcard characters: False
406443
```
407444

408-
### -Credential
409-
The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.
410-
411-
A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential).
412-
413-
```yaml
414-
Type: PSCredential
415-
Parameter Sets: (All)
416-
Aliases:
417-
Applicable: Exchange Online
418-
419-
Required: False
420-
Position: Named
421-
Default value: None
422-
Accept pipeline input: False
423-
Accept wildcard characters: False
424-
```
425-
426-
### -FormatTypeName
427-
The FormatTypeName parameter specifies the output format of the cmdlet.
445+
### -EnableErrorReporting
446+
The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch.
428447

429448
```yaml
430-
Type: String[]
449+
Type: SwitchParameter
431450
Parameter Sets: (All)
432451
Aliases:
433452
Applicable: Exchange Online
@@ -494,7 +513,7 @@ Accept wildcard characters: False
494513
```
495514

496515
### -Organization
497-
This parameter is available only in the module version 2.0.3 or later.
516+
**Note**: This parameter is available only in the module version 2.0.3 or later.
498517

499518
The Organization parameter specifies the organization that's used in app-only authentication.
500519

@@ -526,27 +545,10 @@ Accept pipeline input: False
526545
Accept wildcard characters: False
527546
```
528547

529-
### -Prefix
530-
The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets).
531-
532-
```yaml
533-
Type: String
534-
Parameter Sets: (All)
535-
Aliases:
536-
Applicable: Exchange Online
537-
538-
Required: False
539-
Position: Named
540-
Default value: None
541-
Accept pipeline input: False
542-
Accept wildcard characters: False
543-
```
544-
545548
### -ShowBanner
546549
The ShowBanner switch shows or hides the banner message that's displayed when you run Connect-ExchangeOnline. You don't need to specify a value with this switch.
547550

548551
- To show the banner, you don't need to use this switch (the banner is displayed by default).
549-
550552
- To hide the banner, use this exact syntax: `-ShowBanner:$false`.
551553

552554
```yaml
@@ -566,7 +568,6 @@ Accept wildcard characters: False
566568
The ShowProgress parameter shows a visual progress bar in the PowerShell client module. The progress bar shows number of objects received and total number of objects requested. Valid values are:
567569

568570
- $true: The progress bar is displayed.
569-
570571
- $false: The progress bar isn't displayed.
571572

572573
```yaml
@@ -586,7 +587,6 @@ Accept wildcard characters: False
586587
The TrackPerformance parameter measures additional events (for example, CPU load and memory consumed). Valid values are:
587588

588589
- $true: Performance tracking is enabled.
589-
590590
- $false: Performance tracking is disabled. This is the default value.
591591

592592
This parameter only when works when logging is enabled.
@@ -608,7 +608,6 @@ Accept wildcard characters: False
608608
The UseMultithreading parameter specifies whether to disable or enable multi-threading in the EXO V2 module. Valid values are:
609609

610610
- $true: Enable multi-threading. This is the default value.
611-
612611
- $false: Disable multi-threading. Note this value will degrade performance of V2 cmdlets.
613612

614613
```yaml

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

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Connect-IPPSSession
2929
[[-AzureADAuthorizationEndpointUri] <String>]
3030
[[-DelegatedOrganization] <String>]
3131
[[-PSSessionOption] <PSSessionOption>]
32+
[[-Prefix] <String>]
33+
[[-CommandName] <String[]>]
34+
[[-FormatTypeName] <String[]>]
3235
[-BypassMailboxAnchoring]
3336
[-Credential <PSCredential>]
3437
[-UserPrincipalName <String>]
@@ -139,6 +142,56 @@ Accept pipeline input: False
139142
Accept wildcard characters: False
140143
```
141144

145+
### -Prefix
146+
The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets).
147+
148+
```yaml
149+
Type: String
150+
Parameter Sets: (All)
151+
Aliases:
152+
Applicable: Exchange Online
153+
154+
Required: False
155+
Position: 4
156+
Default value: None
157+
Accept pipeline input: False
158+
Accept wildcard characters: False
159+
```
160+
161+
### -CommandName
162+
**Note**: This parameter is available in version 2.0.3 or later.
163+
164+
The CommandName parameter specifies the comma separated list of commands to import into the session. Use this parameter for applications or scripts that use a specific set of cmdlets. Reducing the number of cmdlets in the session helps improve performance and reduces the memory footprint of the application or script.
165+
166+
```yaml
167+
Type: String[]
168+
Parameter Sets: (All)
169+
Aliases:
170+
Applicable: Exchange Online
171+
172+
Required: False
173+
Position: 5
174+
Default value: None
175+
Accept pipeline input: False
176+
Accept wildcard characters: False
177+
```
178+
179+
### -FormatTypeName
180+
The FormatTypeName parameter specifies the output format of the cmdlet.
181+
182+
```yaml
183+
Type: String[]
184+
Parameter Sets: (All)
185+
Aliases:
186+
Applicable: Exchange Online
187+
188+
Required: False
189+
Position: 6
190+
Default value: None
191+
Accept pipeline input: False
192+
Accept wildcard characters: False
193+
```
194+
142195
### -BypassMailboxAnchoring
143196
The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch.
144197

0 commit comments

Comments
 (0)