Skip to content

Commit ac1a2fe

Browse files
committed
Update Connect-IPPSSession.md
Undisclosed updates for v3.9.0-Preview1
1 parent 8f4756f commit ac1a2fe

File tree

1 file changed

+138
-7
lines changed

1 file changed

+138
-7
lines changed

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

Lines changed: 138 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,13 @@ Connect-IPPSSession
4040
[-CertificatePassword <SecureString>]
4141
[-CertificateThumbprint <String>]
4242
[-Credential <PSCredential>]
43+
[-DisableWAM]
44+
[-EnableErrorReporting]
45+
[-EnableSearchOnlySession]
46+
[-LogDirectoryPath <String>]
47+
[-LogLevel <LogLevel>]
4348
[-Organization <String>]
49+
[-ShowBanner]
4450
[-UserPrincipalName <String>]
4551
[-UseRPSSession]
4652
[<CommonParameters>]
@@ -237,7 +243,7 @@ Accept wildcard characters: False
237243

238244
> Applicable: Exchange Online
239245

240-
**Note**: This parameter is available in version 3.8.0-Preview1 or later of the module.
246+
**Note**: This parameter is available in module version 3.8.0-Preview1 or later.
241247

242248
The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Security and Compliance PowerShell.
243249

@@ -411,6 +417,110 @@ Accept pipeline input: False
411417
Accept wildcard characters: False
412418
```
413419

420+
### -DisableWAM
421+
422+
> Applicable: Exchange Online
423+
424+
**Note**: This parameter is available in module version 3.7.2 or later.
425+
426+
The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch.
427+
428+
If you encounter WAM-related issues during sign in, you can use this switch to disable WAM.
429+
430+
```yaml
431+
Type: SwitchParameter
432+
Parameter Sets: (All)
433+
Aliases:
434+
435+
Required: False
436+
Position: Named
437+
Default value: None
438+
Accept pipeline input: False
439+
Accept wildcard characters: False
440+
```
441+
442+
### -EnableErrorReporting
443+
444+
> Applicable: Exchange Online
445+
446+
**Note**: This parameter is available in module version 3.9.0-Preview1 or later.
447+
448+
The EnableErrorReporting switch specifies whether to enable error reporting. You don't need to specify a value with this switch.
449+
450+
```yaml
451+
Type: SwitchParameter
452+
Parameter Sets: (All)
453+
Aliases:
454+
455+
Required: False
456+
Position: Named
457+
Default value: None
458+
Accept pipeline input: False
459+
Accept wildcard characters: False
460+
```
461+
462+
### -EnableSearchOnlySession
463+
464+
> Applicable: Exchange Online
465+
466+
**Note**: This parameter is available in module version 3.9.0-Preview1 or later.
467+
468+
The EnableSearchOnlySession switch specifies whether to enable certain eDiscovery and related cmdlets that connect to other Microsoft 365 services. You don't need to specify a value with this switch.
469+
470+
```yaml
471+
Type: SwitchParameter
472+
Parameter Sets: (All)
473+
Aliases:
474+
475+
Required: False
476+
Position: Named
477+
Default value: None
478+
Accept pipeline input: False
479+
Accept wildcard characters: False
480+
```
481+
482+
### -LogDirectoryPath
483+
484+
> Applicable: Exchange Online
485+
486+
**Note**: This parameter is available in module version 3.9.0-Preview1 or later.
487+
488+
The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`.
489+
490+
If you specify a custom location and filename that contains spaces, enclose the value in quotation marks (").
491+
492+
```yaml
493+
Type: String
494+
Parameter Sets: (All)
495+
Aliases:
496+
497+
Required: False
498+
Position: Named
499+
Default value: None
500+
Accept pipeline input: False
501+
Accept wildcard characters: False
502+
```
503+
504+
### -LogLevel
505+
506+
> Applicable: Exchange Online
507+
508+
**Note**: This parameter is available in module version 3.9.0-Preview1 or later.
509+
510+
The LogLevel parameter specifies the logging level. Valid values are Default and All.
511+
512+
```yaml
513+
Type: LogLevel
514+
Parameter Sets: (All)
515+
Aliases:
516+
517+
Required: False
518+
Position: Named
519+
Default value: None
520+
Accept pipeline input: False
521+
Accept wildcard characters: False
522+
```
523+
414524
### -Organization
415525

416526
> Applicable: Exchange Online
@@ -431,11 +541,34 @@ Accept pipeline input: False
431541
Accept wildcard characters: False
432542
```
433543

544+
### -ShowBanner
545+
546+
> Applicable: Exchange Online
547+
548+
**Note**: This parameter is available in module version 3.2.0 or later.
549+
550+
The ShowBanner switch shows or hides the banner message that's displayed when you run Connect-IPPSSession. You don't need to specify a value with this switch.
551+
552+
- To show the banner, you don't need to use this switch (the banner is displayed by default).
553+
- To hide the banner, use this exact syntax: `-ShowBanner:$false`.
554+
555+
```yaml
556+
Type: SwitchParameter
557+
Parameter Sets: (All)
558+
Aliases:
559+
560+
Required: False
561+
Position: Named
562+
Default value: None
563+
Accept pipeline input: False
564+
Accept wildcard characters: False
565+
```
566+
434567
### -UserPrincipalName
435568

436569
> Applicable: Exchange Online
437570

438-
The UserPrincipalName parameter specifies the account that you want to use to connect (for example, [email protected]). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password).
571+
The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `[email protected]`). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password).
439572

440573
If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both).
441574

@@ -455,15 +588,13 @@ Accept wildcard characters: False
455588

456589
> Applicable: Exchange Online
457590

458-
This parameter is available in version 3.2.0 or later of the module.
591+
This parameter is available in module version 3.2.0 or later.
459592

460-
**Note**: Remote PowerShell connections to Security & Compliance are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432).
593+
**Note**: Remote PowerShell connections to Security & Compliance PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432).
461594

462595
The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch.
463596

464-
This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm).
465-
466-
If you don't use this switch, Basic authentication in WinRM is not required.
597+
If you don't use this switch, REST API mode is used for the connection, so Basic authentication in WinRM isn't required.
467598

468599
```yaml
469600
Type: SwitchParameter

0 commit comments

Comments
 (0)