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 PowerShell do AzureRM 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 do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes 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 de 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

Esse comando se conecta 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á fazer logon 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á as credenciais do usuário (nome de usuário e senha) e, em seguida, as armazenará 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. Você não pode usar a autenticação multifator ou as credenciais da conta da Microsoft para executar cmdlets do Azure Resource Manager com essa conta.

Exemplo 3: conectar-se a uma conta de entidade 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 as armazena 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.

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

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.

Exemplo 5: Adicionar uma conta usando o logon do Managed Service Identity

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 de host (por exemplo, se executado em uma 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

Esse 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 usada para autenticação deve ter sido criada com o certificado fornecido.

Parâmetros

-AccessToken

Especifica um token de acesso.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-AccountId

ID da conta para token de acesso

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ApplicationId

SPN

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-CertificateThumbprint

Hash de certificado (impressão digital)

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Confirm

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

Tipo:	SwitchParameter
Aliases:	cf
Cargo:	Named
Valor padrão:	False
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ContextName

Nome do contexto padrão deste logon. Você poderá selecionar este contexto por este nome após o login.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Credential

Especifica um objeto PSCredential. Para obter mais informações sobre o objeto PSCredential, digite Get-Help Get-Credential. O objeto PSCredential fornece a ID do 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
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-DefaultProfile

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

Tipo:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Environment

Ambiente que contém a conta para fazer login

Tipo:	String
Aliases:	EnvironmentName
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Force

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

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-GraphAccessToken

AccessToken para Serviço do Graph

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Identity

Faça logon usando a identidade de serviço gerenciado no ambiente atual.

Tipo:	SwitchParameter
Aliases:	MSI, ManagedService
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-KeyVaultAccessToken

AccessToken para o serviço KeyVault

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ManagedServiceHostName

Nome do host para logon de serviço gerenciado

Tipo:	String
Cargo:	Named
Valor padrão:	localhost
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ManagedServicePort

Número da porta para logon de serviço gerenciado

Tipo:	Int32
Cargo:	Named
Valor padrão:	50342
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ManagedServiceSecret

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

Tipo:	SecureString
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	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 aceitos:	Process, CurrentUser
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ServicePrincipal

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

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SkipContextPopulation

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

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SkipValidation

Ignorar validação para token de acesso

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Subscription

Nome ou ID da assinatura

Tipo:	String
Aliases:	SubscriptionName, SubscriptionId
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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 entrada. Para entrada do CSP (Provedor de Soluções na Nuvem), a ID do locatário é necessária.

Tipo:	String
Aliases:	Domain
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Cargo:	Named
Valor padrão:	False
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

String

Parâmetros: Assinatura (ByValue)

Saídas

PSAzureProfile

Compartilhar via