Connect-IPPSSession
Dieses Cmdlet ist nur im Exchange Online PowerShell-Modul verfügbar. Weitere Informationen finden Sie unter Informationen zum Exchange Online PowerShell-Moduls.
Verwenden Sie das Cmdlet Connect-IPPSSession im Exchange Online PowerShell-Modul, um mithilfe der modernen Authentifizierung eine Verbindung mit PowerShell & Security Compliance PowerShell herzustellen. Das Cmdlet funktioniert für MFA- oder Nicht-MFA-fähige Konten.
Hinweis: Version 3.2.0 oder höher des Moduls unterstützt den REST-API-Modus für die meisten PowerShell-Cmdlets mit Sicherheitskonformität & (Die Standardauthentifizierung in WinRM auf dem lokalen Computer ist für den REST-API-Modus nicht erforderlich). Weitere Informationen finden Sie unter Voraussetzungen für das Exchange Online PowerShell-Modul.
Informationen zu den Parametersätzen im Abschnitt zur Syntax weiter unten finden Sie unter Syntax der Exchange-Cmdlets.
Syntax
Connect-IPPSSession
[[-ConnectionUri] <String>]
[[-AzureADAuthorizationEndpointUri] <String>]
[[-DelegatedOrganization] <String>]
[[-PSSessionOption] <PSSessionOption>]
[[-Prefix] <String>]
[[-CommandName] <String[]>]
[[-FormatTypeName] <String[]>]
[-AppId <String>]
[-BypassMailboxAnchoring]
[-Certificate <X509Certificate2>]
[-CertificateFilePath <String>]
[-CertificatePassword <SecureString>]
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-Organization <String>]
[-UserPrincipalName <String>]
[-UseRPSSession]
[<CommonParameters>]Beschreibung
Ausführliche Verbindungsanweisungen, einschließlich voraussetzungen, finden Sie unter Herstellen einer Verbindung mit PowerShell zur Sicherheitskonformität&.
Beispiele
Beispiel 1
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.comIn diesem Beispiel wird mithilfe des angegebenen Kontos und der modernen Authentifizierung mit oder ohne MFA eine Verbindung mit Security & Compliance PowerShell hergestellt. In Version 3.2.0 oder höher des Moduls stellen wir eine Verbindung im REST-API-Modus her, sodass die Standardauthentifizierung in WinRM auf dem lokalen Computer nicht erforderlich ist.
Beispiel 2
Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSessionIn diesem Beispiel wird mithilfe des angegebenen Kontos und der modernen Authentifizierung mit oder ohne MFA eine Verbindung mit Security & Compliance PowerShell hergestellt. In Version 3.2.0 oder höher des Moduls stellen wir eine Verbindung im Remote-PowerShell-Modus her, sodass die Standardauthentifizierung in WinRM auf dem lokalen Computer erforderlich ist.
Beispiel 3
Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"In diesem Beispiel wird eine Verbindung mit Security & Compliance PowerShell in einem Szenario für die unbeaufsichtigte Skripterstellung mithilfe eines Zertifikatfingerabdrucks hergestellt.
Beispiel 4
Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"In diesem Beispiel wird eine Verbindung mit Security & Compliance PowerShell in einem Szenario mit unbeaufsichtigten Skripts mithilfe einer Zertifikatdatei hergestellt. Diese Methode eignet sich am besten für Szenarien, in denen das Zertifikat auf Remotecomputern gespeichert und zur Laufzeit abgerufen wird. Das Zertifikat wird beispielsweise im Azure-Key Vault gespeichert.
Parameter
-AppId
Der Parameter AppId gibt die Anwendungs-ID des Dienstprinzipals an, der in der zertifikatbasierten Authentifizierung (Certificate Based Authentication, CBA) verwendet wird. Ein gültiger Wert ist die GUID der Anwendungs-ID (Dienstprinzipal). Beispiel: 36ee4c6c-0812-40a2-b820-b22ebd02bce3.
Weitere Informationen finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-AzureADAuthorizationEndpointUri
Der Parameter AzureADAuthorizationEndpointUri gibt den Azure AD-Autorisierungsendpunkt an, der OAuth2-Zugriffstoken ausstellen kann. Die folgenden PowerShell-Umgebungen und zugehörige Werte werden unterstützt:
- Security & Compliance PowerShell in Microsoft 365 oder Microsoft 365 GCC: Verwenden Sie diesen Parameter nicht. Der erforderliche Wert ist
https://login.microsoftonline.com/common, aber dies ist auch der Standardwert, sodass Sie diesen Parameter nicht verwenden müssen. - Security & Compliance PowerShell in Office 365 betrieben von 21Vianet:
https://login.chinacloudapi.cn/common - Security & Compliance PowerShell in Microsoft GCC High oder Microsoft DoD:
https://login.microsoftonline.us/common
Wenn Sie den UserPrincipalName-Parameter verwenden, müssen Sie den Parameter AzureADAuthorizationEndpointUri nicht für MFA oder Verbundbenutzer in Umgebungen verwenden, die ihn normalerweise erfordern (UserPrincipalName oder AzureADAuthorizationEndpointUri ist erforderlich; OK, um beides zu verwenden).
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-BypassMailboxAnchoring
Der BypassMailboxAnchoring-Schalter umgeht die Verwendung des Postfachankerhinweises. Sie müssen bei dieser Option keinen Wert angeben.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Certificate
Der Parameter Certificate gibt das Zertifikat an, das für die zertifikatbasierte Authentifizierung (Certificate-Based Authentication, CBA) verwendet wird. Ein gültiger Wert ist der X509Certificate2-Objektwert des Zertifikats.
Verwenden Sie diesen Parameter nicht mit den Parametern CertificateFilePath oder CertificateThumbprint.
Weitere Informationen zur CBA finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
| Type: | X509Certificate2 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateFilePath
Der Parameter CertificateFilePath gibt das Zertifikat an, das für die CBA verwendet wird. Ein gültiger Wert ist der vollständige öffentliche Pfad zur Zertifikatdatei. Verwenden Sie den Parameter CertificatePassword mit diesem Parameter.
Verwenden Sie diesen Parameter nicht mit den Parametern Certificate oder CertificateThumbprint.
Weitere Informationen zur CBA finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificatePassword
Der Parameter CertificatePassword gibt das Kennwort an, das zum Öffnen der Zertifikatdatei erforderlich ist, wenn Sie den Parameter CertificateFilePath verwenden, um das Zertifikat zu identifizieren, das für die CBA verwendet wird.
Sie können die folgenden Methoden als Wert für diesen Parameter verwenden:
(ConvertTo-SecureString -String '<password>' -AsPlainText -Force).- Bevor Sie diesen Befehl ausführen, speichern Sie das Kennwort als Variable (z. B
$password = Read-Host "Enter password" -AsSecureString. ), und verwenden Sie dann die Variable ($password) für den Wert. (Get-Credential).passwordaufgefordert werden, das Kennwort sicher einzugeben, wenn Sie diesen Befehl ausführen.
Weitere Informationen zur CBA finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
Hinweis: Die Verwendung eines ConvertTo-SecureString-Befehls zum lokalen Speichern des Kennworts des Zertifikats verfehlt den Zweck einer sicheren Verbindungsmethode für Automatisierungsszenarien. Die Verwendung eines Get-Credential-Befehls , um Sie zur sicheren Eingabe des Kennworts des Zertifikats aufzufordern, ist für Automatisierungsszenarien nicht ideal. Anders ausgedrückt: Es gibt wirklich keine automatisierte und sichere Möglichkeit, eine Verbindung mithilfe eines lokalen Zertifikats herzustellen.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CertificateThumbprint
Der Parameter CertificateThumbprint gibt das Zertifikat an, das für die CBA verwendet wird. Ein gültiger Wert ist der Fingerabdruckwert des Zertifikats. Beispiel: 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.
Verwenden Sie diesen Parameter nicht mit den Parametern Certificate oder CertificateFilePath.
Hinweis: Der Parameter CertificateThumbprint wird nur in Microsoft Windows unterstützt.
Weitere Informationen zur CBA finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-CommandName
Der CommandName-Parameter gibt die durch Trennzeichen getrennte Liste von Befehlen an, die in die Sitzung importiert werden sollen. Verwenden Sie diesen Parameter für Anwendungen oder Skripts, die einen bestimmten Satz von Cmdlets verwenden. Das Reduzieren der Anzahl von Cmdlets in der Sitzung trägt zur Verbesserung der Leistung bei und reduziert den Speicherbedarf der Anwendung oder des Skripts.
| Type: | String[] |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ConnectionUri
Der ConnectionUri-Parameter gibt den Verbindungsendpunkt für die PowerShell-Remotesitzung an. Die folgenden PowerShell-Umgebungen und zugehörige Werte werden unterstützt:
- Security & Compliance PowerShell in Microsoft 365 oder Microsoft 365 GCC: Verwenden Sie diesen Parameter nicht. Der erforderliche Wert ist
https://ps.compliance.protection.outlook.com/powershell-liveid/, aber dies ist auch der Standardwert, sodass Sie diesen Parameter nicht verwenden müssen. - Security & Compliance PowerShell in Office 365 betrieben von 21Vianet:
https://ps.compliance.protection.partner.outlook.cn/powershell-liveid - PowerShell zur Sicherheitskonformität & in Microsoft GCC High:
https://ps.compliance.protection.office365.us/powershell-liveid/ - PowerShell zur Sicherheitskonformität & in Microsoft DoD:
https://l5.ps.compliance.protection.office365.us/powershell-liveid/
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Credential
Der Parameter Credential gibt den Benutzernamen und das Kennwort an, die zum Herstellen einer Verbindung mit Exchange Online PowerShell verwendet werden. Normalerweise verwenden Sie diesen Parameter in Skripts oder wenn Sie unterschiedliche Anmeldeinformationen bereitstellen müssen, die über die erforderlichen Berechtigungen verfügen. Verwenden Sie diesen Parameter nicht für Konten, die die mehrstufige Authentifizierung (Multi-Factor Authentication, MFA) verwenden.
Bevor Sie den Befehl Connect-IPPSSession ausführen, speichern Sie den Benutzernamen und das Kennwort in einer Variablen (z. B $UserCredential = Get-Credential. ). Verwenden Sie dann den Variablennamen ($UserCredential) für diesen Parameter.
Nach Abschluss des Connect-IPPSSession Befehls wird der Kennwortschlüssel in der Variablen geleert.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-DelegatedOrganization
Der Parameter DelegatedOrganization gibt die kundenseitig organization an, die Sie verwalten möchten (z. B. contosoelectronics.onmicrosoft.com). Dieser Parameter funktioniert nur, wenn der Kunde organization Ihrer delegierten Verwaltung über das CSP-Programm zugestimmt hat.
Nach der erfolgreichen Authentifizierung werden die Cmdlets in dieser Sitzung dem kundenbasierten organization zugeordnet, und alle Vorgänge in dieser Sitzung werden für den Kunden organization ausgeführt.
Hinweise:
- Verwenden Sie die primäre .onmicrosoft.com-Domäne des delegierten organization für den Wert dieses Parameters.
- Sie müssen den Parameter AzureADAuthorizationEndpointUri mit diesem Parameter verwenden.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-FormatTypeName
Der Parameter FormatTypeName gibt das Ausgabeformat des Cmdlets an.
| Type: | String[] |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Organization
Der Parameter Organization gibt die organization an, wenn Sie eine Verbindung mit CBA herstellen. Sie müssen die primäre .onmicrosoft.com-Domäne des organization für den Wert dieses Parameters verwenden.
Weitere Informationen zur CBA finden Sie unter Reine App-Authentifizierung für unbeaufsichtigte Skripts im Exchange Online PowerShell-Modul.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Prefix
Der Parameter Prefix gibt einen Textwert an, der den Namen von PowerShell-Cmdlets zur Sicherheitskonformität & hinzugefügt werden soll, wenn Sie eine Verbindung herstellen. Beispielsweise wird Get-ComplianceCase Get-ContosoComplianceCase, wenn Sie den Wert Contoso für diesen Parameter verwenden.
- Der Präfixwert darf keine Leerzeichen oder Sonderzeichen wie Unterstriche oder Sternchen enthalten.
- Sie können den Präfixwert EXO nicht verwenden. Dieser Wert ist für die neun exklusiven Get-EXO*- Cmdlets reserviert, die in das Modul integriert sind.
- Der Parameter Prefix wirkt sich nur auf importierte Cmdlet-Namen für die Sicherheitskonformität & aus. Dies wirkt sich nicht auf die Namen von Cmdlets aus, die in das Modul integriert sind (z. B. Disconnect-ExchangeOnline).
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PSSessionOption
Der PSSessionOption-Parameter gibt die PowerShell-Remotesitzungsoptionen an, die in Ihrer Verbindung mit Security & Compliance PowerShell verwendet werden sollen.
Speichern Sie die Ausgabe des Befehls New-PSSessionOption in einer Variablen (z. B $PSOptions = New-PSSessionOption <Settings>. ), und verwenden Sie den Variablennamen als Wert für diesen Parameter (z. B $PSOptions. ).
| Type: | PSSessionOption |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UserPrincipalName
Der Parameter UserPrincipalName gibt das Konto an, navin@contoso.onmicrosoft.comdas Sie zum Herstellen einer Verbindung verwenden möchten (z. B. ). Mit diesem Parameter können Sie die Eingabe eines Benutzernamens in der Modernen Anmeldeinformationen für die Authentifizierung überspringen (Sie werden zur Eingabe eines Kennworts aufgefordert).
Wenn Sie den UserPrincipalName-Parameter verwenden, müssen Sie den Parameter AzureADAuthorizationEndpointUri nicht für MFA oder Verbundbenutzer in Umgebungen verwenden, die ihn normalerweise erfordern (UserPrincipalName oder AzureADAuthorizationEndpointUri ist erforderlich; OK, um beides zu verwenden).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UseRPSSession
Dieser Parameter ist in Version 3.2.0 oder höher des Moduls verfügbar.
Mit dem UseRPSSession-Schalter können Sie mithilfe des herkömmlichen Remotezugriffs von PowerShell auf alle Cmdlets eine Verbindung mit Security & Compliance PowerShell herstellen. Sie müssen keinen Wert für diese Option angeben.
Dieser Switch erfordert, dass die Standardauthentifizierung in WinRM auf dem lokalen Computer aktiviert ist. Weitere Informationen finden Sie unter Aktivieren der Standardauthentifizierung in WinRM.
Wenn Sie diesen Schalter nicht verwenden, ist die Standardauthentifizierung in WinRM nicht erforderlich.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für