Connect-ExchangeOnline

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

Le paramètre AccessToken spécifie le jeton web JSON OAuth (JWT) utilisé pour se connecter à ExchangeOnline.

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

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.

Remarque : Si vous utilisez le paramètre ExchangeEnvironmentName, vous n’avez pas besoin d’utiliser les paramètres AzureADAuthorizationEndpointUri ou ConnectionUri.

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

• 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.
• Office 365 Allemagne :https://login.microsoftonline.de/common
• Microsoft 365 GCC High ou Microsoft 365 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).

Remarque : l’authentification MFA ou l’authentification fédérée n’est pas disponible dans Office 365 géré par 21Vianet.

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.

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.

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.

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.

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.

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.

Remarque : Si vous utilisez le paramètre ExchangeEnvironmentName, vous n’avez pas besoin d’utiliser les paramètres AzureADAuthorizationEndpointUri ou ConnectionUri.

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

• Microsoft 365 ou Microsoft 365 GCC : n’utilisez pas ce paramètre. La valeur requise est https://outlook.office365.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.
• Office 365 Allemagne :https://outlook.office.de/PowerShell-LiveID
• Office 365 géré par 21Vianet :https://partner.outlook.cn/PowerShell
• Microsoft 365 GCC High : https://outlook.office365.us/powershell-liveID
• Microsoft 365 DoD : https://webmail.apps.mil/powershell-liveID

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-ExchangeOnline, 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-ExchangeOnline terminée, la clé de mot de passe dans la variable est vidée.

Pour spécifier le mot de passe d’un fichier de certificat, n’utilisez pas ce paramètre ; utilisez le paramètre CertificatePassword à la place.

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.

Remarque : Utilisez le domaine .onmicrosoft.com principal du organization délégué pour la valeur de ce paramètre.

Remarque : Ce paramètre est disponible dans la version 2.0.4 ou ultérieure du module, et uniquement dans PowerShell 7.

Le commutateur d’appareil est généralement utilisé sur les ordinateurs sans navigateur web. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

L’utilisation de ce commutateur génère un message à l’écran qui contient l’URL https://microsoft.com/devicelogin et un code unique. Sur tout autre appareil disposant d’un navigateur web et d’un accès à Internet, ouvrez l’URL, entrez le code unique et entrez vos informations d’identification dans les pages suivantes.

Si votre connexion a réussi, la connexion PowerShell continue.

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.

ExchangeEnvironmentName spécifie l’environnement Exchange Online et élimine la nécessité d’utiliser les paramètres AzureADAuthorizationEndpointUri et ConnectionUri. Les environnements PowerShell Exchange Online suivants sont pris en charge :

• Microsoft 365 ou Microsoft 365 GCC : n’utilisez pas ce paramètre. La valeur requise est O365Default, mais il s’agit également de la valeur par défaut. Vous n’avez donc pas besoin d’utiliser ce paramètre.
• Office 365 Allemagne :O365GermanyCloud
• Office 365 géré par 21Vianet :O365China
• Microsoft 365 GCC High : O365USGovGCCHigh
• Microsoft 365 DoD : O365USGovDoD

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

Remarque : Ce paramètre est disponible dans la version 2.0.4 ou ultérieure du module, et uniquement dans PowerShell 7.

Le commutateur InlineCredential spécifie s’il faut transmettre les informations d’identification directement dans la fenêtre Windows PowerShell. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Ce commutateur est similaire au paramètre Credential, mais avec une sécurité accrue. Le commutateur InlineCredential ne vous oblige pas à stocker les informations d’identification localement dans le script, et vous pouvez entrer des informations d’identification directement dans une session PowerShell interactive.

Ce commutateur ne fonctionne pas avec les comptes qui utilisent l’authentification multifacteur.

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

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

Le commutateur ManagedIdentity spécifie que vous utilisez l’identité managée pour vous connecter. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Les connexions d’identité managée sont actuellement prises en charge pour les types de ressources Azure suivants :

• runbooks Azure Automation
• Ordinateurs virtuels Azure
• Azure Virtual Machine Scale Sets
• Azure Functions

Vous devez utiliser ce commutateur avec le paramètre Organization.

Pour l’identité managée affectée par l’utilisateur, vous devez également utiliser ce commutateur avec le paramètre ManagedIdentityAccountId.

Pour plus d’informations sur la connexion avec une identité managée, consultez Utiliser des identités managées Azure pour se connecter à Exchange Online PowerShell.

Le paramètre ManagedIdentityAccountId spécifie l’identité managée affectée par l’utilisateur que vous utilisez pour vous connecter. Une valeur valide pour ce paramètre est l’ID d’application (GUID) du principal de service qui correspond à l’identité managée affectée par l’utilisateur dans Azure.

Vous devez utiliser ce paramètre avec le paramètre Organization et le commutateur ManagedIdentity.

Pour plus d’informations sur la connexion avec une identité managée, consultez Utiliser des identités managées Azure pour se connecter à Exchange Online PowerShell.

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

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

Pour plus d’informations sur la connexion avec une identité managée, consultez Utiliser des identités managées Azure pour se connecter à Exchange Online PowerShell.

Le paramètre PageSize indique le nombre maximal d’entrées par page. L’entrée valide pour ce paramètre est un entier entre 1 et 1 000. La valeur par défaut est 1000.

Le paramètre Prefix spécifie une valeur de texte à ajouter aux noms des applets de commande PowerShell Exchange Online lorsque vous vous connectez. Par exemple, Get-InboundConnector devient Get-ContosoInboundConnector 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 Exchange Online importés. Cela n’affecte pas les noms des applets de commande intégrées au module (par exemple, Disconnect-ExchangeOnline).

Le paramètre PSSessionOption spécifie les options de session PowerShell à utiliser dans votre connexion à Exchange Online. 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).

Le commutateur ShowBanner affiche ou masque le message de bannière qui s’affiche lorsque vous exécutez Connect-ExchangeOnline. 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.

Le paramètre ShowProgress spécifie s’il faut afficher ou masquer la barre de progression des applets de commande importées lorsque vous vous connectez. Les valeurs valides sont les suivantes :

• $true : la barre de progression s’affiche. Il s’agit de la valeur par défaut.
• $false : actuellement, cette valeur n’a aucun effet.

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

Le paramètre SigningCertificate spécifie le certificat client utilisé pour signer les fichiers de format (*). Format.ps1xml) ou fichiers de module de script (.psm1) dans le module temporaire que Connect-ExchangeOnline crée.

Une valeur valide pour ce paramètre est une variable qui contient le certificat, ou une commande ou une expression qui obtient le certificat.

Pour rechercher le certificat, utilisez l’applet de commande Get-PfxCertificate dans le module Microsoft.PowerShell.Security ou utilisez l’applet de commande Get-ChildItem dans le certificat (Cert:) Disque. Si le certificat n’est pas valide ou ne dispose pas d’une autorité suffisante, la commande échoue.

Le commutateur SkipLoadingFormatData évite de télécharger les données de format pour les connexions d’API REST. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Lorsque vous utilisez ce commutateur, la sortie d’une applet de commande Exchange n’est pas mise en forme.

Ce commutateur ne fonctionne pas avec le commutateur UseRPSSession.

Le paramètre TrackPerformance mesure des événements supplémentaires (par exemple, la charge du processeur et la mémoire consommée). Les valeurs valides sont les suivantes :

• $true : le suivi des performances est activé.
• $false : le suivi des performances est désactivé. Il s’agit de la valeur par défaut.

Ce paramètre fonctionne uniquement lorsque la journalisation est activée.

Le paramètre UseMultithreading spécifie s’il faut désactiver ou activer le multithreading dans le module PowerShell Exchange Online. Les valeurs valides sont les suivantes :

• $true : activer le multithreading. Il s’agit de la valeur par défaut.
• $false : désactivez le multithreading. Cette valeur dégrade les performances des neuf applets de commande Get-EXO* exclusives dans le module.

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

Le commutateur UseRPSSession vous permet de vous connecter à Exchange Online PowerShell à 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.