Connect-AzureRmAccount

  • Référence
Module:
AzureRM.Profile

Connectez-vous à Azure avec un compte authentifié pour une utilisation avec les demandes d’applet de commande Azure Resource Manager.

Avertissement

Le module AzureRM PowerShell a été officiellement déprécié le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Il est possible que le module AzureRM fonctionne encore, mais il ne fait plus l’objet de maintenance ni de support. L’utilisateur peut continuer à s’en servir s’il le souhaite, à ses propres risques. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

Connect-AzureRmAccount
       [-Environment <String>]
       [[-Credential] <PSCredential>]
       [-TenantId <String>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-AzureRmAccount
       [-Environment <String>]
       [-Credential] <PSCredential>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-AzureRmAccount
       [-Environment <String>]
       -CertificateThumbprint <String>
       -ApplicationId <String>
       [-ServicePrincipal]
       -TenantId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       -AccessToken <String>
       [-GraphAccessToken <String>]
       [-KeyVaultAccessToken <String>]
       -AccountId <String>
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipValidation]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-AzureRmAccount
       [-Environment <String>]
       [-TenantId <String>]
       [-AccountId <String>]
       [-Identity]
       [-ManagedServicePort <Int32>]
       [-ManagedServiceHostName <String>]
       [-ManagedServiceSecret <SecureString>]
       [-Subscription <String>]
       [-ContextName <String>]
       [-SkipContextPopulation]
       [-Force]
       [-Scope <ContextModificationScope>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

L’applet de commande Connect-AzureRmAccount se connecte à Azure avec un compte authentifié à utiliser avec les demandes d’applet de commande Azure Resource Manager. Vous pouvez utiliser ce compte authentifié uniquement avec les applets de commande Azure Resource Manager. Pour ajouter un compte authentifié à utiliser avec les applets de commande Service Management, utilisez l’applet de commande Add-AzureAccount ou Import-AzurePublishSettingsFile. Si aucun contexte n’est trouvé pour l’utilisateur actuel, cette commande remplit la liste de contextes de l’utilisateur avec un contexte pour chacun de ses abonnements (25 premiers). Vous trouverez la liste des contextes créés pour l’utilisateur en exécutant « Get-AzureRmContext -ListAvailable ». Pour ignorer cette population de contexte, vous pouvez exécuter cette commande avec le paramètre de commutateur « -SkipContextPopulation ». Après avoir exécuté cette applet de commande, vous pouvez vous déconnecter d’un compte Azure à l’aide de Disconnect-AzureRmAccount.

Exemples

Exemple 1 : Utiliser une connexion interactive pour se connecter à un compte Azure

PS C:\> Connect-AzureRmAccount

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Cette commande se connecte à un compte Azure. Pour exécuter des applets de commande Azure Resource Manager avec ce compte, vous devez fournir des informations d’identification d’ID d’organisation ou de compte Microsoft à l’invite. Si l’authentification multifacteur est activée pour vos informations d’identification, vous devez vous connecter à l’aide de l’option interactive ou utiliser l’authentification du principal de service.

Exemple 2 : Se connecter à un compte Azure à l’aide des informations d’identification d’ID d’organisation

PS C:\> $Credential = Get-Credential
PS C:\> Connect-AzureRmAccount -Credential $Credential

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

La première commande invite les informations d’identification de l’utilisateur (nom d’utilisateur et mot de passe), puis les stocke dans la variable $Credential. La deuxième commande se connecte à un compte Azure à l’aide des informations d’identification stockées dans $Credential. Ce compte s’authentifie auprès d’Azure Resource Manager à l’aide des informations d’identification de l’ID d’organisation. Vous ne pouvez pas utiliser l’authentification multifacteur ou les informations d’identification du compte Microsoft pour exécuter des applets de commande Azure Resource Manager avec ce compte.

Exemple 3 : Se connecter à un compte de principal de service Azure

PS C:\> $Credential = Get-Credential

PS C:\> Connect-AzureRmAccount -Credential $Credential -Tenant "xxxx-xxxx-xxxx-xxxx" -ServicePrincipal
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
xxxx-xxxx-xxxx-xxxx    Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

La première commande obtient les informations d’identification du principal de service (ID d’application et secret du principal de service), puis les stocke dans la variable $Credential. La deuxième commande se connecte à Azure à l’aide des informations d’identification du principal de service stockées dans $Credential pour le locataire spécifié. Le paramètre de commutateur ServicePrincipal indique que le compte s’authentifie en tant que principal de service.

Exemple 4 : Utiliser une connexion interactive pour se connecter à un compte pour un locataire et un abonnement spécifiques

PS C:\> Connect-AzureRmAccount -Tenant "xxxx-xxxx-xxxx-xxxx" -SubscriptionId "yyyy-yyyy-yyyy-yyyy"
Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
azureuser@contoso.com  Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Cette commande se connecte à un compte Azure et configure AzureRM PowerShell pour exécuter des applets de commande pour le locataire et l’abonnement spécifiés par défaut.

Exemple 5 : Ajouter un compte à l’aide de Managed Service Identity Login

PS C:\> Connect-AzureRmAccount -MSI

Account                SubscriptionName TenantId                Environment
-------                ---------------- --------                -----------
MSI@50342              Subscription1    xxxx-xxxx-xxxx-xxxx     AzureCloud

Cette commande se connecte à l’aide de l’identité de service managé de l’environnement hôte (par exemple, si elle est exécutée sur un VirtualMachine avec une identité de service managée affectée, cela permet au code de se connecter à l’aide de cette identité affectée)

Exemple 6 : Ajouter un compte à l’aide de certificats

# For more information on creating a self-signed certificate
# and giving it proper permissions, please see the following:
# https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-authenticate-service-principal-powershell
PS C:\> $Thumbprint = "0SZTNJ34TCCMUJ5MJZGR8XQD3S0RVHJBA33Z8ZXV"
PS C:\> $TenantId = "00001111-aaaa-2222-bbbb-3333cccc4444"
PS C:\> $ApplicationId = "00001111-aaaa-2222-bbbb-3333cccc4444"
PS C:\> Connect-AzureRmAccount -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -Tenant $TenantId -ServicePrincipal

Account             SubscriptionName TenantId            Environment
-------             ---------------- --------            -----------
xxxx-xxxx-xxxx-xxxx Subscription1    xxxx-xxxx-xxxx-xxxx AzureCloud

Account          : 00001111-aaaa-2222-bbbb-3333cccc4444
SubscriptionName : MyTestSubscription
SubscriptionId   : 85f0f653-1f86-4d2c-a9f1-042efc00085c
TenantId         : 00001111-aaaa-2222-bbbb-3333cccc4444
Environment      : AzureCloud

Cette commande se connecte à un compte Azure à l’aide de l’authentification du principal de service basé sur des certificats. Le principal de service utilisé pour l’authentification doit avoir été créé avec le certificat donné.

Paramètres

-AccessToken

Spécifie un jeton d’accès.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-AccountId

ID de compte pour le jeton d’accès

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ApplicationId

SPN

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CertificateThumbprint

Hachage de certificat (empreinte numérique)

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ContextName

Nom du contexte par défaut de cette connexion. Vous pourrez sélectionner ce contexte par ce nom après la connexion.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Credential

Spécifie un objet PSCredential. Pour plus d’informations sur l’objet PSCredential, tapez Get-Help Get-Credential. L’objet PSCredential fournit l’ID utilisateur et le mot de passe des informations d’identification d’ID d’organisation, ou l’ID d’application et le secret pour les informations d’identification du principal de service.

Type:PSCredential
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Environment

Environnement contenant le compte à connecter

Type:String
Alias:EnvironmentName
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Remplacez le contexte existant portant le même nom, le cas échéant.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-GraphAccessToken

AccessToken pour le service Graph

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Identity

Connectez-vous à l’aide de l’identité de service managé dans l’environnement actuel.

Type:SwitchParameter
Alias:MSI, ManagedService
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-KeyVaultAccessToken

AccessToken pour le service KeyVault

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ManagedServiceHostName

Nom d’hôte pour la connexion au service managé

Type:String
Position:Named
Valeur par défaut:localhost
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ManagedServicePort

Numéro de port pour la connexion au service managé

Type:Int32
Position:Named
Valeur par défaut:50342
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ManagedServiceSecret

Secret, utilisé pour certains types de connexion de service managé.

Type:SecureString
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Scope

Détermine l’étendue des modifications de contexte, par exemple, si les modifications s’appliquent uniquement au processus actuel ou à toutes les sessions démarrées par cet utilisateur.

Type:ContextModificationScope
Valeurs acceptées:Process, CurrentUser
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ServicePrincipal

Indique que ce compte s’authentifie en fournissant les informations d’identification du principal de service.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SkipContextPopulation

Ignore la population du contexte si aucun contexte n’est trouvé.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SkipValidation

Ignorer la validation du jeton d’accès

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Subscription

Nom ou ID de l’abonnement

Type:String
Alias:SubscriptionName, SubscriptionId
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TenantId

Nom de domaine facultatif ou ID de locataire. Le nom de domaine ne fonctionnera pas dans toutes les situations de connexion. Pour la connexion fournisseur de solutions Cloud (CSP), l’ID de locataire est requis.

Type:String
Alias:Domain
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Paramètres : Abonnement (ByValue)

Sorties

PSAzureProfile