Connect-IPPSSession

Cette applet de commande est disponible uniquement dans le module PowerShell Exchange Online. Pour plus d’informations, consultez À propos du module PowerShell Exchange Online.

Utilisez l’applet de commande Connect-IPPSSession dans le module PowerShell Exchange Online pour vous connecter à PowerShell PowerShell de conformité de la sécurité & à l’aide de l’authentification moderne. L’applet de commande fonctionne pour les comptes MFA ou non activés par MFA.

Remarque : la version 3.2.0 ou ultérieure du module prend en charge le mode API REST pour la plupart des applets de commande PowerShell de conformité de la sécurité & (l’authentification de base dans WinRM sur l’ordinateur local n’est pas requise pour le mode API REST). Pour plus d’informations, consultez Prérequis pour le module PowerShell Exchange Online.

Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.

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>]

Description

Pour obtenir des instructions détaillées sur la connexion, y compris les prérequis, consultez Se connecter à PowerShell de conformité de la sécurité&.

Exemples

Exemple 1

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com

Cet exemple se connecte à PowerShell de conformité de la sécurité & à l’aide du compte spécifié et de l’authentification moderne, avec ou sans authentification multifacteur. Dans la version 3.2.0 ou ultérieure du module, nous nous connectons en mode API REST. L’authentification de base dans WinRM n’est donc pas requise sur l’ordinateur local.

Exemple 2

Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession

Cet exemple se connecte à PowerShell de conformité de la sécurité & à l’aide du compte spécifié et de l’authentification moderne, avec ou sans authentification multifacteur. Dans la version 3.2.0 ou ultérieure du module, nous nous connectons en mode PowerShell distant. L’authentification de base dans WinRM est donc requise sur l’ordinateur local.

Exemple 3

Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com"

Cet exemple se connecte à PowerShell de conformité de la sécurité & dans un scénario de script sans assistance à l’aide d’une empreinte numérique de certificat.

Exemple 4

Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com"

Cet exemple se connecte à PowerShell de conformité de la sécurité & dans un scénario de script sans assistance à l’aide d’un fichier de certificat. Cette méthode est idéale pour les scénarios où le certificat est stocké sur des machines distantes et extrait au moment de l’exécution. Par exemple, le certificat est stocké dans le Key Vault Azure.

Paramètres

-AppId

Le paramètre AppId spécifie l’ID d’application du principal de service utilisé dans l’authentification basée sur les certificats (CBA). Une valeur valide est le GUID de l’ID d’application (principal de service). Par exemple : 36ee4c6c-0812-40a2-b820-b22ebd02bce3.

Pour plus d’informations, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-AzureADAuthorizationEndpointUri

Le paramètre AzureADAuthorizationEndpointUri spécifie le point de terminaison d’autorisation Azure AD qui peut émettre des jetons d’accès OAuth2. Les environnements PowerShell et les valeurs associées suivants sont pris en charge :

  • Sécurité & conformité PowerShell dans Microsoft 365 ou Microsoft 365 GCC : n’utilisez pas ce paramètre. La valeur requise est https://login.microsoftonline.com/common, mais il s’agit également de la valeur par défaut. Vous n’avez donc pas besoin d’utiliser ce paramètre.
  • Conformité de la sécurité & PowerShell dans Office 365 géré par 21Vianet :https://login.chinacloudapi.cn/common
  • Conformité de la sécurité & PowerShell dans Microsoft GCC High ou Microsoft DoD : https://login.microsoftonline.us/common

Si vous utilisez le paramètre UserPrincipalName, vous n’avez pas besoin d’utiliser le paramètre AzureADAuthorizationEndpointUri pour l’authentification multifacteur ou les utilisateurs fédérés dans des environnements qui en ont normalement besoin (UserPrincipalName ou AzureADAuthorizationEndpointUri est requis ; OK pour utiliser les deux).

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-BypassMailboxAnchoring

Le commutateur BypassMailboxAnchoring contourne l’utilisation de l’indicateur d’ancrage de boîte aux lettres. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Certificate

Le paramètre Certificate spécifie le certificat utilisé pour l’authentification basée sur les certificats (CBA). Une valeur valide est la valeur de l’objet X509Certificate2 du certificat.

N’utilisez pas ce paramètre avec les paramètres CertificateFilePath ou CertificateThumbprint.

Pour plus d’informations sur l’authentification par certificat, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Type:X509Certificate2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateFilePath

Le paramètre CertificateFilePath spécifie le certificat utilisé pour l’authentification CBA. Une valeur valide est le chemin d’accès public complet au fichier de certificat. Utilisez le paramètre CertificatePassword avec ce paramètre.

N’utilisez pas ce paramètre avec les paramètres Certificate ou CertificateThumbprint.

Pour plus d’informations sur l’authentification par certificat, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificatePassword

Le paramètre CertificatePassword spécifie le mot de passe requis pour ouvrir le fichier de certificat lorsque vous utilisez le paramètre CertificateFilePath pour identifier le certificat utilisé pour l’authentification basée sur les certificats.

Vous pouvez utiliser les méthodes suivantes comme valeur pour ce paramètre :

  • (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).
  • Avant d’exécuter cette commande, stockez le mot de passe en tant que variable (par exemple, $password = Read-Host "Enter password" -AsSecureString), puis utilisez la variable ($password) pour la valeur.
  • (Get-Credential).password pour être invité à entrer le mot de passe en toute sécurité lorsque vous exécutez cette commande.

Pour plus d’informations sur l’authentification par certificat, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Remarque : L’utilisation d’une commande ConvertTo-SecureString pour stocker le mot de passe du certificat localement contrecarré l’objectif d’une méthode de connexion sécurisée pour les scénarios d’automatisation. L’utilisation d’une commande Get-Credential pour vous demander le mot de passe du certificat en toute sécurité n’est pas idéale pour les scénarios d’automatisation. En d’autres termes, il n’existe aucun moyen automatisé et sécurisé de se connecter à l’aide d’un certificat local.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CertificateThumbprint

Le paramètre CertificateThumbprint spécifie le certificat utilisé pour l’authentification CBA. Une valeur valide est la valeur d’empreinte numérique du certificat. Par exemple : 83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1.

N’utilisez pas ce paramètre avec les paramètres Certificate ou CertificateFilePath.

Remarque : Le paramètre CertificateThumbprint est pris en charge uniquement dans Microsoft Windows.

Pour plus d’informations sur l’authentification par certificat, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-CommandName

Le paramètre CommandName spécifie la liste séparée par des virgules des commandes à importer dans la session. Utilisez ce paramètre pour les applications ou les scripts qui utilisent un ensemble spécifique d’applets de commande. La réduction du nombre d’applets de commande dans la session permet d’améliorer les performances et de réduire l’empreinte mémoire de l’application ou du script.

Type:String[]
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ConnectionUri

Le paramètre ConnectionUri spécifie le point de terminaison de connexion pour la session PowerShell distante. Les environnements PowerShell et les valeurs associées suivants sont pris en charge :

  • Sécurité & conformité PowerShell dans Microsoft 365 ou Microsoft 365 GCC : n’utilisez pas ce paramètre. La valeur requise est https://ps.compliance.protection.outlook.com/powershell-liveid/, mais il s’agit également de la valeur par défaut. Vous n’avez donc pas besoin d’utiliser ce paramètre.
  • Conformité de la sécurité & PowerShell dans Office 365 géré par 21Vianet :https://ps.compliance.protection.partner.outlook.cn/powershell-liveid
  • Conformité de la sécurité & PowerShell dans Microsoft GCC High : https://ps.compliance.protection.office365.us/powershell-liveid/
  • PowerShell de conformité de la sécurité & dans 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

Le paramètre Credential spécifie le nom d’utilisateur et le mot de passe utilisés pour se connecter à Exchange Online PowerShell. En règle générale, vous utilisez ce paramètre dans des scripts ou lorsque vous avez besoin de fournir différentes informations d’identification qui ont les autorisations requises. N’utilisez pas ce paramètre pour les comptes qui utilisent l’authentification multifacteur (MFA).

Avant d’exécuter la commande Connect-IPPSSession, stockez le nom d’utilisateur et le mot de passe dans une variable (par exemple, $UserCredential = Get-Credential). Ensuite, utilisez le nom de la variable ($UserCredential) pour ce paramètre.

Une fois la commande Connect-IPPSSession terminée, la clé de mot de passe dans la variable est vidée.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-DelegatedOrganization

Le paramètre DelegatedOrganization spécifie le client organization que vous souhaitez gérer (par exemple, contosoelectronics.onmicrosoft.com). Ce paramètre fonctionne uniquement si le client organization a accepté votre gestion déléguée via le programme CSP.

Une fois l’authentification réussie, les applets de commande de cette session sont mappées au organization client, et toutes les opérations de cette session sont effectuées sur le client organization.

Remarques :

  • Utilisez le domaine .onmicrosoft.com principal du organization délégué pour la valeur de ce paramètre.
  • Vous devez utiliser le paramètre AzureADAuthorizationEndpointUri avec ce paramètre.
Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-FormatTypeName

Le paramètre FormatTypeName spécifie le format de sortie de l’applet de commande.

Type:String[]
Position:6
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Organization

Le paramètre Organization spécifie le organization lorsque vous vous connectez à l’aide de l’authentification CBA. Vous devez utiliser le domaine .onmicrosoft.com principal du organization pour la valeur de ce paramètre.

Pour plus d’informations sur l’authentification par certificat, consultez Authentification d’application uniquement pour les scripts sans assistance dans le module PowerShell Exchange Online.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Prefix

Le paramètre Prefix spécifie une valeur de texte à ajouter aux noms des applets de commande PowerShell de conformité de la sécurité & lorsque vous vous connectez. Par exemple, Get-ComplianceCase devient Get-ContosoComplianceCase lorsque vous utilisez la valeur Contoso pour ce paramètre.

  • La valeur Prefix ne peut pas contenir d’espaces ou de caractères spéciaux tels que des traits de soulignement ou des astérisque.
  • Vous ne pouvez pas utiliser la valeur de préfixe EXO. Cette valeur est réservée aux neuf applets de commande Get-EXO* exclusives intégrées au module.
  • Le paramètre Prefix affecte uniquement les noms d’applet de commande Security & Compliance importés. Cela n’affecte pas les noms des applets de commande intégrées au module (par exemple, Disconnect-ExchangeOnline).
Type:String
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PSSessionOption

Le paramètre PSSessionOption spécifie les options de session PowerShell distantes à utiliser dans votre connexion à PowerShell de conformité de la sécurité & .

Stockez la sortie de la commande New-PSSessionOption dans une variable (par exemple, $PSOptions = New-PSSessionOption <Settings>) et utilisez le nom de la variable comme valeur pour ce paramètre (par exemple, $PSOptions).

Type:PSSessionOption
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UserPrincipalName

Le paramètre UserPrincipalName spécifie le compte que vous souhaitez utiliser pour vous connecter (par exemple, navin@contoso.onmicrosoft.com). L’utilisation de ce paramètre vous permet d’ignorer la saisie d’un nom d’utilisateur dans l’invite d’informations d’identification d’authentification moderne (vous êtes invité à entrer un mot de passe).

Si vous utilisez le paramètre UserPrincipalName, vous n’avez pas besoin d’utiliser le paramètre AzureADAuthorizationEndpointUri pour l’authentification multifacteur ou les utilisateurs fédérés dans des environnements qui en ont normalement besoin (UserPrincipalName ou AzureADAuthorizationEndpointUri est requis ; OK pour utiliser les deux).

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UseRPSSession

Ce paramètre est disponible dans la version 3.2.0 ou ultérieure du module.

Le commutateur UseRPSSession vous permet de vous connecter à PowerShell de conformité de la sécurité & à l’aide d’un accès PowerShell distant traditionnel à toutes les applets de commande. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Ce commutateur nécessite que l’authentification de base soit activée dans WinRM sur l’ordinateur local. Pour plus d’informations, consultez Activer l’authentification de base dans WinRM.

Si vous n’utilisez pas ce commutateur, l’authentification de base dans WinRM n’est pas requise.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online