Connect-IPPSSession

Syntaxe

Default (Par défaut)

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]
    [-LogDirectoryPath <String>]
    [-LogLevel <LogLevel>]
    [-Organization <String>]
    [-ShowBanner]
    [-UserPrincipalName <String>]
    [-UseRPSSession]
    [<CommonParameters>]

Description

Exemples

Exemple 1

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

Exemple 2

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

Exemple 3

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

Exemple 4

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

Paramètres

-AccessToken

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.8.0-Preview1 ou ultérieure.

Le paramètre AccessToken spécifie le jeton web JSON OAuth (JWT) utilisé pour se connecter à PowerShell sécurité et conformité.

Selon le type de jeton d’accès, vous devez utiliser ce paramètre avec les paramètres Organization, DelegatedOrganization ou UserPrincipalName.

Propriétés du paramètre

Jeux de paramètres

-AppId

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-AzureADAuthorizationEndpointUri

Applicable : Exchange Online

Le paramètre AzureADAuthorizationEndpointUri spécifie le point de terminaison d’autorisation Microsoft Entra 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/organizations, mais il s’agit également de la valeur par défaut. Vous n’avez donc pas besoin d’utiliser ce paramètre.
• Security & Compliance PowerShell dans Office 365 géré par 21Vianet :https://login.chinacloudapi.cn/organizations
• Sécurité & Conformité PowerShell dans Microsoft GCC High ou Microsoft DoD : https://login.microsoftonline.us/organizations

La valeur d’URI se terminant par /organizations autorise uniquement les comptes professionnels ou scolaires. L’ancienne valeur d’URI se terminant par /common fonctionne toujours, mais peut vous inviter à choisir entre un compte personnel et un compte professionnel ou scolaire. Nous recommandons la valeur de l’URI /organizations dans les scénarios d’entreprise où les comptes de consommateur doivent être exclus.

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).

Propriétés du paramètre

Jeux de paramètres

-BypassMailboxAnchoring

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-Certificate

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-CertificateFilePath

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-CertificatePassword

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-CertificateThumbprint

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-CommandName

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-ConnectionUri

Applicable : Exchange Online

Le paramètre ConnectionUri spécifie le point de terminaison de connexion pour la session PowerShell. 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.
• Security & Compliance PowerShell dans Office 365 géré par 21Vianet :https://ps.compliance.protection.partner.outlook.cn/powershell-liveid
• Sécurité & Conformité PowerShell dans Microsoft GCC High : https://ps.compliance.protection.office365.us/powershell-liveid/
• Sécurité & Conformité PowerShell dans Microsoft DoD : https://l5.ps.compliance.protection.office365.us/powershell-liveid/

Propriétés du paramètre

Jeux de paramètres

-Credential

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-DelegatedOrganization

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-DisableWAM

Applicable : Exchange Online

Remarque : ce paramètre est disponible dans le module version 3.7.2-Preview1 ou ultérieure.

Le commutateur DisableWAM désactive le Gestionnaire de comptes web (WAM). Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Si vous rencontrez des problèmes liés à WAM lors de la connexion, vous pouvez utiliser ce commutateur pour désactiver WAM.

Propriétés du paramètre

Jeux de paramètres

-EnableErrorReporting

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.8.1-Preview1 ou ultérieure.

Le commutateur EnableErrorReporting spécifie s’il faut activer le rapport d’erreurs. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Propriétés du paramètre

Jeux de paramètres

-EnableSearchOnlySession

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.9.0-Preview1 ou ultérieure.

Le commutateur EnableSearchOnlySession spécifie s’il faut activer certaines eDiscovery et les applets de commande associées qui se connectent à d’autres services Microsoft 365. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Propriétés du paramètre

Jeux de paramètres

-FormatTypeName

Applicable : Exchange Online

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

Propriétés du paramètre

Jeux de paramètres

-LogDirectoryPath

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.8.1-Preview1 ou ultérieure.

Le paramètre LogDirectoryPath spécifie l’emplacement des fichiers journaux. L’emplacement par défaut est %TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv.

Si vous spécifiez un emplacement personnalisé et un nom de fichier contenant des espaces, placez la valeur entre guillemets (").

Propriétés du paramètre

Jeux de paramètres

-LogLevel

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.8.1-Preview1 ou ultérieure.

Le paramètre LogLevel spécifie le niveau de journalisation. Les valeurs valides sont Default et All.

Propriétés du paramètre

Jeux de paramètres

-Organization

Applicable : Exchange Online

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.

Propriétés du paramètre

Jeux de paramètres

-Prefix

Applicable : Exchange Online

Le paramètre Prefix spécifie une valeur de texte à ajouter aux noms des applets de commande PowerShell Security & Compliance 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).

Propriétés du paramètre

Jeux de paramètres

-PSSessionOption

Applicable : Exchange Online

Remarque : Ce paramètre ne fonctionne pas dans les connexions d’API REST.

Le paramètre PSSessionOption spécifie les options de session PowerShell distantes à utiliser dans votre connexion à PowerShell security & Compliance. Ce paramètre fonctionne uniquement si vous utilisez également le commutateur UseRPSSession dans la même commande.

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).

Propriétés du paramètre

Jeux de paramètres

-ShowBanner

Applicable : Exchange Online

Remarque : Ce paramètre est disponible dans le module version 3.2.0 ou ultérieure.

Le commutateur ShowBanner affiche ou masque le message de bannière qui s’affiche lorsque vous exécutez Connect-IPPSSession. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

• Pour afficher la bannière, vous n’avez pas besoin d’utiliser ce commutateur (la bannière est affichée par défaut).
• Pour masquer la bannière, utilisez la syntaxe exacte suivante : -ShowBanner:$false.

Propriétés du paramètre

Jeux de paramètres

-UserPrincipalName

Applicable : Exchange Online

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).

Propriétés du paramètre

Jeux de paramètres

-UseRPSSession

Applicable : Exchange Online

Remarque : ce paramètre est disponible dans le module version 3.2.0-Preview3 ou ultérieure.

Remarque : Les connexions PowerShell distantes à Security & Compliance PowerShell sont déconseillées. Pour plus d’informations, consultez Dépréciation de PowerShell à distance dans PowerShell sécurité et conformité.

Le commutateur UseRPSSession vous permet de vous connecter à PowerShell sécurité & conformité à 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.

Si vous n’utilisez pas ce commutateur, le mode API REST étant utilisé pour la connexion, l’authentification de base dans WinRM n’est pas requise.

Propriétés du paramètre

Jeux de paramètres

CommonParameters