Connect-AzureRmAccount

Referência

Módulo:: AzureRM.Profile

Conecte-se ao Azure com uma conta autenticada para uso com solicitações de cmdlet do Azure Resource Manager.

Aviso

O módulo AzureRM do PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Sintaxe

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

O cmdlet Connect-AzureRmAccount se conecta ao Azure com uma conta autenticada para uso com solicitações de cmdlet do Azure Resource Manager. Você pode usar essa conta autenticada somente com cmdlets do Azure Resource Manager. Para adicionar uma conta autenticada para uso com cmdlets do Gerenciamento de Serviços, use o cmdlet Add-AzureAccount ou Import-AzurePublishSettingsFile. Se nenhum contexto for encontrado para o usuário atual, esse comando preencherá a lista de contexto do usuário com um contexto para cada uma de suas (primeiras 25) assinaturas. A lista de contextos criados para o usuário pode ser encontrada executando "Get-AzureRmContext -ListAvailable". Para ignorar essa população de contexto, você pode executar esse comando com o parâmetro de opção "-SkipContextPopulation". Depois de executar esse cmdlet, você pode se desconectar de uma conta do Azure usando Disconnect-AzureRmAccount.

Exemplos

Exemplo 1: Usar um logon interativo para se conectar a uma conta do Azure

PS C:\> Connect-AzureRmAccount

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

Este comando liga-se a uma conta do Azure. Para executar cmdlets do Azure Resource Manager com essa conta, você deve fornecer credenciais de conta da Microsoft ou ID organizacional no prompt. Se a autenticação multifator estiver habilitada para suas credenciais, você deverá efetuar login usando a opção interativa ou usar a autenticação da entidade de serviço.

Exemplo 2: Conectar-se a uma conta do Azure usando credenciais de ID organizacional

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

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

O primeiro comando solicitará credenciais de usuário (nome de usuário e senha) e, em seguida, armazená-las na variável $Credential. O segundo comando se conecta a uma conta do Azure usando as credenciais armazenadas no $Credential. Essa conta é autenticada com o Azure Resource Manager usando credenciais de ID organizacional. Não é possível usar autenticação multifator ou credenciais de conta da Microsoft para executar cmdlets do Azure Resource Manager com essa conta.

Exemplo 3: Conectar-se a uma conta principal de serviço do 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

O primeiro comando obtém as credenciais da entidade de serviço (ID do aplicativo e segredo da entidade de serviço) e, em seguida, armazena-as na variável $Credential. O segundo comando se conecta ao Azure usando as credenciais da entidade de serviço armazenadas no $Credential para o Locatário especificado. O parâmetro de opção ServicePrincipal indica que a conta é autenticada como uma entidade de serviço.

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

Esse comando se conecta a uma conta do Azure e configurou o AzureRM PowerShell para executar cmdlets para o locatário e a assinatura especificados por padrão.

PS C:\> Connect-AzureRmAccount -MSI

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

Esse comando se conecta usando a identidade de serviço gerenciado do ambiente host (por exemplo, se executado em um VirtualMachine com uma Identidade de Serviço Gerenciado atribuída, isso permitirá que o código faça login usando essa identidade atribuída)

Exemplo 6: Adicionar uma conta usando certificados

# 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

Este comando se conecta a uma conta do Azure usando a autenticação de entidade de serviço baseada em certificado. A entidade de serviço utilizada para a autenticação deveria ter sido criada com o certificado fornecido.

Parâmetros

-AccessToken

Especifica um token de acesso.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-AccountId

ID da conta para token de acesso

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ApplicationId

SPN

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-CertificateThumbprint

Hash do certificado (impressão digital)

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ContextName

Nome do contexto padrão deste login. Você será capaz de selecionar este contexto por este nome após o login.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Credential

Especifica um objeto PSCredential. Para obter mais informações sobre o objeto PSCredential, digite Get-Help Get-Credential. O objeto PSCredential fornece o ID de usuário e a senha para credenciais de ID organizacional ou a ID do aplicativo e o segredo para credenciais da entidade de serviço.

Tipo:	PSCredential
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Environment

Ambiente que contém a conta para iniciar sessão

Tipo:	String
Aliases:	EnvironmentName
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Force

Substitua o contexto existente com o mesmo nome, se houver.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-GraphAccessToken

AccessToken para serviço gráfico

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Identity

Faça login usando a identidade do serviço gerenciado no ambiente atual.

Tipo:	SwitchParameter
Aliases:	MSI, ManagedService
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-KeyVaultAccessToken

AccessToken para Serviço KeyVault

Tipo:	String
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ManagedServiceHostName

Nome do host para login de serviço gerenciado

Tipo:	String
Position:	Named
Default value:	localhost
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ManagedServicePort

Número da porta para login do serviço gerenciado

Tipo:	Int32
Position:	Named
Default value:	50342
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ManagedServiceSecret

Secret, usado para alguns tipos de login de serviço gerenciado.

Tipo:	SecureString
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Scope

Determina o escopo das alterações de contexto, por exemplo, se as alterações se aplicam apenas ao processo atual ou a todas as sessões iniciadas por esse usuário.

Tipo:	ContextModificationScope
Valores aceites:	Process, CurrentUser
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ServicePrincipal

Indica que essa conta é autenticada fornecendo credenciais da entidade de serviço.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-SkipContextPopulation

Ignora a população de contexto se nenhum contexto for encontrado.

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-SkipValidation

Ignorar validação para token de acesso

Tipo:	SwitchParameter
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Subscription

Nome ou ID da Subscrição

Tipo:	String
Aliases:	SubscriptionName, SubscriptionId
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-TenantId

Nome de domínio opcional ou ID de locatário. O nome de domínio não funcionará em todas as situações de início de sessão. Para iniciar sessão no Cloud Solution Provider (CSP), é necessário um ID de inquilino.

Tipo:	String
Aliases:	Domain
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

String

Parâmetros: Subscrição (ByValue)

Saídas

PSAzureProfile

Partilhar via

Connect-AzureRmAccount

Sintaxe

Description

Exemplos

Exemplo 1: Usar um logon interativo para se conectar a uma conta do Azure

Exemplo 2: Conectar-se a uma conta do Azure usando credenciais de ID organizacional

Exemplo 3: Conectar-se a uma conta principal de serviço do Azure

Exemplo 6: Adicionar uma conta usando certificados

Parâmetros

-AccessToken

-AccountId

-ApplicationId

-CertificateThumbprint

-Confirm

-ContextName

-Credential

-DefaultProfile

-Environment

-Force

-GraphAccessToken

-Identity

-KeyVaultAccessToken

-ManagedServiceHostName

-ManagedServicePort

-ManagedServiceSecret

-Scope

-ServicePrincipal

-SkipContextPopulation

-SkipValidation

-Subscription

-TenantId

-WhatIf

Entradas

Saídas

Recursos adicionais

Partilhar via

Connect-AzureRmAccount

Sintaxe

Description

Exemplos

Exemplo 1: Usar um logon interativo para se conectar a uma conta do Azure

Exemplo 2: Conectar-se a uma conta do Azure usando credenciais de ID organizacional

Exemplo 3: Conectar-se a uma conta principal de serviço do Azure

Exemplo 4: Usar um login interativo para se conectar a uma conta de um locatário e assinatura específicos

Exemplo 5: Adicionar uma conta usando o login de identidade do serviço gerenciado

Exemplo 6: Adicionar uma conta usando certificados

Parâmetros

-AccessToken

-AccountId

-ApplicationId

-CertificateThumbprint

-Confirm

-ContextName

-Credential

-DefaultProfile

-Environment

-Force

-GraphAccessToken

-Identity

-KeyVaultAccessToken

-ManagedServiceHostName

-ManagedServicePort

-ManagedServiceSecret

-Scope

-ServicePrincipal

-SkipContextPopulation

-SkipValidation

-Subscription

-TenantId

-WhatIf

Entradas

Saídas

Recursos adicionais