Commands › Exchange Online

Connect-IPPSSession

Exchange Online ExchangeOnlineManagement Connect-*

For more information, see About the Exchange Online PowerShell module. Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. **Note**: Version 3.2.0 or later of the module supports REST API mode for virtually all Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see Prerequisites for the Exchange Online PowerShell module.

Quick start script

# Connect-IPPSSession — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Connect-IPPSSession | Format-List

# 3. Export for evidence / drift tracking
Connect-IPPSSession | Export-Clixml .\IPPSSession-$(Get-Date -Format yyyyMMdd).xml

Syntax

Connect-IPPSSession
 [[-ConnectionUri] <String>]
 [[-AzureADAuthorizationEndpointUri] <String>]
 [[-DelegatedOrganization] <String>]
 [[-PSSessionOption] <PSSessionOption>]
 [[-Prefix] <String>]
 [[-CommandName] <String[]>]
 [[-FormatTypeName] <String[]>]
 [-AccessToken <String>]
 [-AppId <String>]
 [-BypassMailboxAnchoring]
 [-Certificate <X509Certificate2>]
 [-CertificateFilePath <String>]
 [-CertificatePassword <SecureString>]
 [-CertificateThumbprint <String>]
 [-Credential <PSCredential>]
 [-DisableWAM]
 [-EnableErrorReporting]
 [-EnableSearchOnlySession]
 [-EXOModuleBasePath <String>]
 [-LogDirectoryPath <String>]
 [-LogLevel <LogLevel>]
 [-Organization <String>]
 [-ShowBanner]
 [-UserPrincipalName <String>]
 [-UseRPSSession]
 [<CommonParameters>]

Parameters (25)

Parameter	Type	What it controls
-ConnectionUri	String	The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following PowerShell environments and related values are supported:
-AzureADAuthorizationEndpointUri	String	The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported:
-DelegatedOrganization	String	The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter works only if the customer organization has agreed to...
-PSSessionOption	PSSessionOption	Note: This parameter doesn't work in REST API connections.
-Prefix	String	The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value...
-CommandName	String[]	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...
-FormatTypeName	String[]	The FormatTypeName parameter specifies the output format of the cmdlet.
-AccessToken	String	Note: This parameter is available in module version 3.8.0-Preview1 or later.
-AppId	String	The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example,...
-BypassMailboxAnchoring	SwitchParameter	The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch.
-Certificate	X509Certificate2	The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate.
-CertificateFilePath	String	The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter.
-CertificatePassword	SecureString	The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA.
-CertificateThumbprint	String	The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`.
-Credential	PSCredential	The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that...
-DisableWAM	SwitchParameter	Note: This parameter is available in module version 3.7.2-Preview1 or later.
-EnableErrorReporting	SwitchParameter	Note: This parameter is available in module version 3.8.1-Preview1 or later.
-EnableSearchOnlySession	SwitchParameter	Note: This parameter is available in module version 3.9.0-Preview1 or later.
-EXOModuleBasePath	String	Note: This parameter is available in module version 3.9.1-Preview1 or later.
-LogDirectoryPath	String	Note: This parameter is available in module version 3.8.1-Preview1 or later.
-LogLevel	LogLevel	Note: This parameter is available in module version 3.8.1-Preview1 or later.
-Organization	String	The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter.
-ShowBanner	SwitchParameter	Note: This parameter is available in module version 3.2.0 or later.
-UserPrincipalName	String	The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `navin@contoso.onmicrosoft.com`). Using this parameter allows you to skip entering a username in the modern...
-UseRPSSession	SwitchParameter	Note: This parameter is deprecated in module version 3.9.2 or later. Remote PowerShell connections to Security & Compliance PowerShell were deprecated in October 2023. For more information, see [Deprecation of...

Message Center changes mentioning this command

MC1248389 (Updated) Retirement of -Credential parameter when connecting to Exchange Online PowerShell

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.