Connect-Entra

Module:
Microsoft.Entra.Authentication Module v1.3

Connectez-vous à Microsoft Entra ID avec un compte authentifié.

Syntaxe

UserParameterSet (Par défaut) 

Connect-Entra
[[-Scopes]
    [[-Scopes] <String[]>]
    [[-ClientId] <String>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-UseDeviceCode]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AppCertificateParameterSet 

Connect-Entra
[-ClientId]
    [-ClientId] <String>
    [[-CertificateSubjectName] <String>]
    [[-CertificateThumbprint] <String>]
    [-SendCertificateChain <Boolean>]
    [-Certificate <X509Certificate2>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

IdentityParameterSet 

Connect-Entra
[[-ClientId]
    [[-ClientId] <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-Identity]
    [-NoWelcome]
    [<CommonParameters>]

AppSecretCredentialParameterSet 

Connect-Entra
[-ClientSecretCredential
    [-ClientSecretCredential <PSCredential>]
    [-TenantId <String>]
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

AccessTokenParameterSet 

Connect-Entra
[-AccessToken]
    [-AccessToken] <SecureString>
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-NoWelcome]
    [<CommonParameters>]

EnvironmentVariableParameterSet 

Connect-Entra
[-ContextScope
    [-ContextScope <ContextScope>]
    [-Environment <String>]
    [-ClientTimeout <Double>]
    [-EnvironmentVariable]
    [-NoWelcome]
    [<CommonParameters>]

Description

L’applet Connect-Entra de commande se connecte à Microsoft Entra ID avec un compte authentifié.

Plusieurs scénarios d’authentification sont pris en charge en fonction de votre cas d’usage, tels que délégué (interactif) et app uniquement (non interactif).

Connect-Entra est un alias pour Connect-MgGraph.

Exemples

Exemple 1 : Accès délégué : Connecter une session PowerShell à un locataire

Connect-Entra

Cet exemple montre comment connecter votre session PowerShell actuelle à un locataire Microsoft Entra ID à l’aide d’informations d’identification.

Exemple 2 : Accès délégué : Connecter une session PowerShell à un locataire avec des étendues requises

Connect-Entra -Scopes 'User.Read.All', 'Group.ReadWrite.All'

Welcome to Microsoft Graph!

Cet exemple montre comment s’authentifier auprès de Microsoft Entra ID avec des étendues.

Exemple 3 : Accès délégué : utilisation d’un jeton d’accès

$secureString = ConvertTo-SecureString -String $AccessToken -AsPlainText -Force
Connect-Entra -AccessToken $secureString

Welcome to Microsoft Graph!

Cet exemple montre comment s’authentifier de manière interactive pour Microsoft Entra ID à l’aide d’un jeton d’accès.

Pour plus d’informations sur la façon d’obtenir ou de créer un jeton d’accès, consultez Demander un jeton d’accès.

Exemple 4 : Accès délégué : utilisation du flux de code d’appareil

Connect-Entra -UseDeviceCode

To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code A1B2CDEFGH to authenticate.

Cet exemple montre comment s’authentifier de manière interactive pour Microsoft Entra ID à l’aide du flux de code de l’appareil.

Pour plus d’informations, consultez flux de code d’appareil.

Exemple 5 : Accès à l’application uniquement : utilisation des informations d’identification du client avec une empreinte numérique de certificat

$connectParams = @{
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    ApplicationId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    CertificateThumbprint = 'AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00'
}

Connect-Entra @connectParams

Welcome to Microsoft Graph!

Cet exemple montre comment s’authentifier à l’aide d’un Id d’application et certificateThumbprint.

Pour plus d’informations sur l’obtention ou la création de CertificateThumbprint, consultez S’authentifier avec un accès à l’application uniquement.

Exemple 6 : Accès uniquement aux applications : utilisation des informations d’identification du client avec un nom de certificat

$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    CertificateName = 'YOUR_CERT_SUBJECT'
}

Connect-Entra @params

 $Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
 Connect-Entra -ClientId '<App-Id>' -TenantId '<Tenant-Id>' -Certificate $Cert

Vous pouvez trouver le sujet du certificat en exécutant la commande ci-dessus.

Exemple 7 : Accès uniquement aux applications : utilisation des informations d’identification du client avec un certificat

$Cert = Get-ChildItem Cert:\LocalMachine\My\$CertThumbprint
$params = @{
    ClientId = '00001111-aaaa-2222-bbbb-3333cccc4444'
    TenantId = 'aaaabbbb-0000-cccc-1111-dddd2222eeee'
    Certificate = $Cert
}

Connect-Entra @params

Exemple 8 : Accès à l’application uniquement : utilisation des informations d’identification de clé secrète client

$ClientSecretCredential = Get-Credential -Credential '00001111-aaaa-2222-bbbb-3333cccc4444'
# Enter client_secret in the password prompt.
Connect-Entra -TenantId 'aaaabbbb-0000-cccc-1111-dddd2222eeee' -ClientSecretCredential $ClientSecretCredential

Cette méthode d’authentification est idéale pour les interactions en arrière-plan.

Pour plus d’informations sur l’obtention des informations d’identification, consultez la commande Get-Credential .

Exemple 9 : Accès uniquement aux applications : Utilisation de l’identité managée : identité managée affectée par le système

Connect-Entra -Identity

Utilise une identité managée automatiquement sur une instance de service. L’identité est liée au cycle de vie d’une instance de service.

Exemple 10 : Accès uniquement aux applications : Utilisation de l’identité managée : identité managée affectée par l’utilisateur

Connect-Entra -Identity -ClientId 'User_Assigned_Managed_identity_Client_Id'

Utilise une identité managée créée par l’utilisateur en tant que ressource Azure autonome.

Exemple 11 : Connexion à un environnement en tant qu’identité différente

Connect-Entra -ContextScope 'Process'

Welcome to Microsoft Graph!

Pour vous connecter en tant qu’identité différente de CurrentUser, spécifiez le paramètre ContextScope avec la valeur Process.

Pour plus d’informations sur l’obtention du contexte actuel, consultez la commande Get-EntraContext .

Exemple 12 : Connexion à un environnement ou à un cloud

Get-EntraEnvironment

Name     AzureADEndpoint                   GraphEndpoint                           Type
----     ---------------                   -------------                           ----
China    https://login.chinacloudapi.cn    https://microsoftgraph.chinacloudapi.cn Built-in
Global   https://login.microsoftonline.com https://graph.microsoft.com             Built-in
USGov    https://login.microsoftonline.us  https://graph.microsoft.us              Built-in
USGovDoD https://login.microsoftonline.us  https://dod-graph.microsoft.us          Built-in

Connect-Entra -Environment 'Global'

Lorsque vous utilisez Connect-Entra, vous pouvez choisir de cibler d’autres environnements. Par défaut, Connect-Entra cible le cloud public global.

Exemple 13 : Définit le délai d’expiration du client HTTP en secondes

 Connect-Entra -ClientTimeout 60

Welcome to Microsoft Graph!

Cet exemple montre comment définir le délai d’expiration du client HTTP en secondes.

Exemple 14 : Masque le message de bienvenue

Connect-Entra -NoWelcome

Cet exemple montre comment masquer le message d’accueil.

Exemple 15 : Autorise l’authentification à l’aide de variables d’environnement

Connect-Entra -EnvironmentVariable

Cet exemple permet l’authentification à l’aide de variables d’environnement.

Paramètres

-AccessToken

Spécifie un jeton du porteur pour Microsoft Entra service. Les jetons d’accès expirent et vous devez gérer leur actualisation.

Propriétés du paramètre

Type:SecureString
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AccessTokenParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Certificate

Certificat X.509 fourni pendant l’appel.

Propriétés du paramètre

Type:X509Certificate2
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CertificateSubjectName

Nom unique de l’objet d’un certificat. Le certificat est récupéré à partir du magasin de certificats de l’utilisateur actuel.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:CertificateSubject, CertificateName

Jeux de paramètres

AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CertificateThumbprint

Spécifie l’empreinte numérique du certificat d’une clé publique numérique X.509 d’un compte d’utilisateur autorisé à effectuer cette action.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ClientId

Spécifie l’ID d’application du principal de service.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AppId, ApplicationId

Jeux de paramètres

UserParameterSet
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
IdentityParameterSet
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
AppCertificateParameterSet
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ClientSecretCredential

L’objet PSCredential fournit l’ID d’application et la clé secrète client pour les informations d’identification du principal de service. Pour plus d’informations sur l’objet PSCredential, tapez Get-Help Get-Credential.

Propriétés du paramètre

Type:PSCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:SecretCredential, Credential

Jeux de paramètres

AppSecretCredentialParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ClientTimeout

Définit le délai d’expiration du client HTTP en secondes.

Propriétés du paramètre

Type:System.Double
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ContextScope

Détermine l’étendue du contexte d’authentification. Ce ContextScope accepte Process le processus actuel ou CurrentUser pour toutes les sessions démarrées par l’utilisateur.

Propriétés du paramètre

Type:ContextScope
Valeur par défaut:None
Valeurs acceptées:Process, CurrentUser
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UserParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
IdentityParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
AppSecretCredentialParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
EnvironmentVariableParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Environment

Nom de l’environnement cloud national auquel se connecter. Par défaut, le cloud global est utilisé.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:EnvironmentName, NationalCloud

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-EnvironmentVariable

Autorise l’authentification à l’aide de variables d’environnement configurées sur l’ordinateur hôte. Voir https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#environment-variables

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

EnvironmentVariableParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Identity

Connexion à l’aide d’une identité managée

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:ManagedIdentity, ManagedServiceIdentity, MSI

Jeux de paramètres

IdentityParameterSet
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-NoWelcome

Masque le message d’accueil.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Scopes

Tableau d’autorisations déléguées à donner son consentement.

Propriétés du paramètre

Type:

System.String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

UserParameterSet
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SendCertificateChain

Incluez l’en-tête x5c dans les revendications du client lors de l’acquisition d’un jeton pour activer l’authentification basée sur le sujet/l’émetteur à l’aide d’un certificat donné.

Propriétés du paramètre

Type:Boolean
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-TenantId

Spécifie l’ID d’un locataire.

Si vous ne spécifiez pas ce paramètre, le compte est authentifié auprès du locataire de base.

Vous devez spécifier le paramètre TenantId pour l’authentification en tant que principal de service ou lors de l’utilisation de compte Microsoft.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Public visé, Tenant

Jeux de paramètres

UserParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
AppCertificateParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
AppSecretCredentialParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-UseDeviceCode

Utilisez l’authentification par code d’appareil au lieu d’un contrôle de navigateur.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:UseDeviceAuthentication, DeviceCode, DeviceAuth, Appareil

Jeux de paramètres

UserParameterSet
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.