Skip to content

Commit e76a4be

Browse files
committed
Update Connect-ExchangeOnline.md
Added parameter details for the 2.0.3 version of client module
1 parent 4e2eb3e commit e76a4be

File tree

1 file changed

+132
-18
lines changed

1 file changed

+132
-18
lines changed

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

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

2525
```
26-
Connect-ExchangeOnline
27-
[[-AzureADAuthorizationEndpointUri] <String>]
28-
[-BypassMailboxAnchoring]
29-
[[-ConnectionUri] <String>]
30-
[-Credential <PSCredential>]
31-
[[-DelegatedOrganization] <String>]
32-
[-EnableErrorReporting]
33-
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
34-
[-LogDirectoryPath <String>]
35-
[-LogLevel <String>]
36-
[-PageSize <UInt32>]
37-
[-Prefix <String>]
26+
Connect-ExchangeOnline
27+
[[-ConnectionUri] <String>] [[-AzureADAuthorizationEndpointUri] <String>]
28+
[[-ExchangeEnvironmentName] <ExchangeEnvironment>]
3829
[[-PSSessionOption] <PSSessionOption>]
39-
[-ShowBanner]
40-
[-ShowProgress <Boolean>]
41-
[-TrackPerformance <Boolean>]
42-
[-UseMultithreading <Boolean>]
30+
[-BypassMailboxAnchoring] [[-DelegatedOrganization] <String>]
31+
[-Prefix <String>] [-ShowBanner]
32+
[-CommandName <String[]>]
33+
[-FormatTypeName <String[]>]
4334
[-UserPrincipalName <String>]
35+
[-Credential <PSCredential>]
36+
[-Certificate <X509Certificate2>]
37+
[-CertificateFilePath <String>]
38+
[-CertificatePassword <SecureString>]
39+
[-CertificateThumbprint <String>]
40+
[-AppId <String>]
41+
[-Organization <String>]
42+
[-EnableErrorReporting]
43+
[-LogDirectoryPath <String>]
44+
[-LogLevel <LogLevel>]
45+
[-TrackPerformance <Boolean>]
46+
[-ShowProgress <Boolean>]
47+
[-UseMultithreading <Boolean>]
48+
[-PageSize <UInt32>]
4449
[<CommonParameters>]
4550
```
4651

@@ -72,7 +77,6 @@ After the Connect-ExchangeOnline command is successful, you can run ExO V2 modul
7277

7378
## PARAMETERS
7479

75-
### -AzureADAuthorizationEndpointUri
7680
**Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters.
7781

7882
The AzureADAuthorizationEndpointUri parameter specifies the Azure AD Authorization endpoint Uri that can issue OAuth2 access tokens. You use this parameter with multi-factor authentication (MFA) and federated authentication. The following Exchange Online PowerShell environments and related values are supported:
@@ -169,6 +173,7 @@ Applicable: Exchange Online
169173
170174
Required: False
171175
Position: 5
176+
### -AzureADAuthorizationEndpointUri
172177
Default value: None
173178
Accept pipeline input: False
174179
Accept wildcard characters: False
@@ -299,6 +304,115 @@ Accept pipeline input: False
299304
Accept wildcard characters: False
300305
```
301306

307+
### -AppId
308+
This parameter is applicable in case of Certificate Based Authentication Flow. AppId is the GUID of application created as part of setup for CBA as documented here - https://aka.ms/exov2-cba
309+
It is the application ID of the Service Principal.
310+
311+
```yaml
312+
Type: String
313+
Parameter Sets: (All)
314+
Aliases:
315+
316+
Required: False
317+
Position: Named
318+
Default value: None
319+
Accept pipeline input: False
320+
Accept wildcard characters: False
321+
```
322+
323+
### -Certificate
324+
This parameter is applicable in case of Certificate Based Authentication which is available in version 2.0.3 or higher. It currently accepts certificate in format of X509Certificate2 object.
325+
326+
```yaml
327+
Type: X509Certificate2
328+
Parameter Sets: (All)
329+
Aliases:
330+
331+
Required: False
332+
Position: Named
333+
Default value: None
334+
Accept pipeline input: False
335+
Accept wildcard characters: False
336+
```
337+
338+
### -CertificateFilePath
339+
This parameter is applicable in case of Certificate Based Authentication which is available in version 2.0.3 or higher. Use this parameter to pass the complete path of public file of Certificate file.
340+
341+
```yaml
342+
Type: String
343+
Parameter Sets: (All)
344+
Aliases:
345+
346+
Required: False
347+
Position: Named
348+
Default value: None
349+
Accept pipeline input: False
350+
Accept wildcard characters: False
351+
```
352+
353+
### -CertificatePassword
354+
This parameter is applicable in case of Certificate Based Authentication which is available in version 2.0.3 or higher.
355+
Use this parameter to pass the password used to encrypt the certificate.If a password was used during Certificate creation, the same is required when connecting to Exchange Online using certificate.
356+
357+
```yaml
358+
Type: SecureString
359+
Parameter Sets: (All)
360+
Aliases:
361+
362+
Required: False
363+
Position: Named
364+
Default value: None
365+
Accept pipeline input: False
366+
Accept wildcard characters: False
367+
```
368+
369+
### -CertificateThumbprint
370+
Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action.
371+
372+
```yaml
373+
Type: String
374+
Parameter Sets: (All)
375+
Aliases:
376+
377+
Required: False
378+
Position: Named
379+
Default value: None
380+
Accept pipeline input: False
381+
Accept wildcard characters: False
382+
```
383+
384+
### -CommandName
385+
Use this parameter to pass the comma separated list of commands which has to be imported into the session. This is applicable for applications or scripts which use a select set of cmdlets and it helps in improving performance as well as reducing memory footprint of the application/script.
386+
387+
```yaml
388+
Type: String[]
389+
Parameter Sets: (All)
390+
Aliases:
391+
392+
Required: False
393+
Position: Named
394+
Default value: None
395+
Accept pipeline input: False
396+
Accept wildcard characters: False
397+
```
398+
399+
### -FormatTypeName
400+
401+
402+
```yaml
403+
Type: String[]
404+
Parameter Sets: (All)
405+
Aliases:
406+
407+
Required: False
408+
Position: Named
409+
Default value: None
410+
Accept pipeline input: False
411+
Accept wildcard characters: False
412+
```
413+
414+
415+
302416
### -ShowBanner
303417
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.
304418

@@ -340,7 +454,7 @@ Accept wildcard characters: False
340454
```
341455

342456
### -TrackPerformance
343-
{{ Fill TrackPerformance Description }}
457+
Use this parameter to measure additional events like CPU Load, memory consumed etc. This parameter works when logging is enabled.
344458

345459
```yaml
346460
Type: Boolean

0 commit comments

Comments
 (0)