Objetos de contexto do Azure PowerShell

O Azure PowerShell usa objetos de contexto do Azure PowerShell (contextos do Azure) para armazenar informações de assinatura e autenticação. Se você tiver acesso a várias assinaturas, os contextos do Azure permitirão que você selecione a assinatura para executar cmdlets do Azure PowerShell. Os contextos do Azure também são usados para armazenar informações de entrada em várias sessões do PowerShell e executar tarefas em segundo plano.

Este artigo aborda o gerenciamento de contextos do Azure, não o gerenciamento de assinaturas ou contas. Se você quiser gerenciar usuários, assinaturas, locatários ou outras informações da conta, consulte a documentação da ID do Microsoft Entra . Para saber mais sobre como usar contextos para executar tarefas em segundo plano ou paralelas, consulte Executar cmdlets do Azure PowerShell em Trabalhos do PowerShell depois de se familiarizar com contextos do Azure.

Visão geral dos objetos de contexto do Azure

Os contextos do Azure são objetos do PowerShell que representam sua assinatura ativa para executar comandos e as informações de autenticação necessárias para se conectar a uma nuvem do Azure. Com os contextos do Azure, o Azure PowerShell não precisa autenticar novamente sua conta sempre que você alternar assinaturas. Um contexto do Azure consiste em:

• A conta que foi usada para entrar no Azure com Connect-AzAccount. Os contextos do Azure tratam os usuários, as IDs do aplicativo e as entidades de serviço da mesma forma de uma perspectiva de conta.
• A assinatura ativa, um contrato de serviço com a Microsoft para criar e executar recursos do Azure, que estão associados a um locatário. Os locatários geralmente são chamados de organizações na documentação ou ao trabalhar com o Microsoft Entra.
• Uma referência a um cache de token, um token de autenticação armazenado para acessar uma nuvem do Azure. As configurações de salvamento automático de contexto determinam onde o token é armazenado e por quanto tempo ele persiste.

Para obter mais informações sobre esses termos, consulte Terminologia do Microsoft Entra. Os tokens de autenticação usados pelos contextos do Azure são os mesmos que outros tokens armazenados que fazem parte de uma sessão persistente.

Quando você entra com Connect-AzAccount, pelo menos um contexto do Azure é criado para sua assinatura padrão. O objeto retornado é Connect-AzAccount o contexto padrão do Azure usado para o restante da sessão do PowerShell.

Obter contextos do Azure

Os contextos disponíveis do Azure são recuperados com o Get-AzContext cmdlet. Liste os contextos disponíveis com o parâmetro ListAvailable :

Get-AzContext -ListAvailable

Ou obtenha um contexto por nome:

Get-AzContext -Name MyContextName

Os nomes de contexto podem ser diferentes do nome da assinatura associada. Para determinar o nome do contexto, use o valor da propriedade Name , que não é exibida por padrão.

Get-AzContext -ListAvailable | Select-Object -Property *

Criar um novo contexto do Azure com base nas informações da assinatura

O Set-AzContext cmdlet é usado para criar e definir novos contextos do Azure como o contexto ativo. A maneira mais fácil de criar um novo contexto do Azure é usar informações de assinatura existentes. O Set-AzContext cmdlet foi projetado para tirar o objeto de Get-AzSubscription saída como um valor canalizado e configurar um novo contexto do Azure:

Get-AzSubscription -SubscriptionName MySubscriptionName |
  Set-AzContext -Name MyContextName

Ou forneça o nome ou a ID da assinatura e a ID do locatário, se necessário:

Set-AzContext -Name MyContextName -Subscription MySubscriptionName -Tenant 00000000-0000-0000-0000-000000000000

Se o parâmetro Name for omitido, o nome e a ID da assinatura serão usados como o nome de contexto no formato Subscription Name (subscription-id).

Alterar o contexto ativo do Azure

Ambos Set-AzContext e Select-AzContext podem ser usados para alterar o contexto ativo do Azure. Conforme descrito em Criar um novo contexto do Azure, Set-AzContext criará um novo contexto do Azure para uma assinatura se não existir e alternar o contexto ativo para essa.

Select-AzContext destina-se a ser usado apenas com contextos existentes do Azure e funciona de maneira semelhante ao uso Set-AzContext -Context, mas foi projetado para uso com a tubulação:

Set-AzContext -Context (Get-AzContext -Name MyContextName) # Set a context with an inline Azure context object
Get-AzContext -Name MyContextName | Select-AzContext # Set a context with a piped Azure context object

Como muitos outros comandos de gerenciamento de conta e contexto no Azure PowerShell, Set-AzContext e Select-AzContext dê suporte ao parâmetro Scope para que você possa controlar por quanto tempo o contexto está ativo. O escopo permite alterar o contexto ativo de uma única sessão sem alterar o padrão:

Get-AzContext -Name MyContextName | Select-AzContext -Scope Process

Para evitar alternar contextos para uma sessão inteira do PowerShell, os comandos do Azure PowerShell com um parâmetro AzContext podem ser executados em um determinado contexto:

$context = Get-AzContext -Name MyContextName
New-AzVM -Name ExampleVM -AzContext $context

O outro uso principal de contextos com cmdlets do Azure PowerShell é executar comandos em segundo plano. Para saber mais sobre como executar trabalhos do PowerShell usando o Azure PowerShell, consulte Executar cmdlets do Azure PowerShell em Trabalhos do PowerShell.

Salvar contextos do Azure em sessões do PowerShell

Por padrão, os contextos do Azure são salvos para uso entre as sessões do PowerShell. Você pode alterar esse comportamento das seguintes maneiras:

• Entrar usando -Scope Process com Connect-AzAccount.

  Connect-AzAccount -Scope Process
  

  O contexto do Azure retornado como parte dessa entrada é válido apenas para a sessão atual e não é salvo automaticamente, independentemente da configuração de salvamento automático do contexto do Azure PowerShell.

• Desabilite o salvamento automático de contexto no Azure PowerShell com o Disable-AzContextAutosave cmdlet. Desabilitar o salvamento automático de contexto não limpa nenhum token armazenado. Para saber como limpar informações de contexto armazenadas do Azure, consulte Remover contextos do Azure e credenciais armazenadas.

• Habilitar explicitamente o salvamento automático de contexto do Azure pode ser habilitado com o Enable-AzContextAutosave cmdlet. Com o salvamento automático habilitado, os contextos de um usuário são armazenados localmente para sessões posteriores do PowerShell.

• Salve manualmente contextos com Save-AzContext os quais serão usados em sessões futuras do PowerShell, em que elas podem ser carregadas com Import-AzContext:

  Save-AzContext -Path current-context.json # Save the current context
  Import-AzContext -Path other-context.json # Load the context from a file and set it to the current context
  

Cada um desses comandos dá suporte ao parâmetro Scope , que pode levar um valor para Process aplicar somente ao processo em execução atual. Por exemplo, para garantir que os contextos recém-criados não sejam salvos após sair de uma sessão do PowerShell:

Disable-AzContextAutosave -Scope Process
Set-AzContext -Subscription 'Subscription ID or Name' -Tenant 00000000-0000-0000-0000-000000000000

Informações de contexto e tokens são armazenados no diretório no $env:USERPROFILE\.Azure Windows e $HOME/.Azure em outras plataformas. Informações confidenciais, como IDs de assinatura e IDs de locatário, ainda podem ser expostas em informações armazenadas, por meio de logs ou contextos salvos. Para saber como limpar informações armazenadas, consulte Remover contextos do Azure e credenciais armazenadas.

Remover contextos do Azure e credenciais armazenadas

Para limpar contextos e credenciais do Azure:

• Saia de uma conta com Disconnect-AzAccount. Você pode sair de qualquer conta por conta ou contexto:

  Disconnect-AzAccount # Disconnect active account
  Disconnect-AzAccount -Username 'user@contoso.com' # Disconnect by account name
  Disconnect-AzAccount -ContextName MyContextName # Disconnect by context name
  
  $context = Get-AzContext
  Disconnect-AzAccount -AzureContext $context # Disconnect using context object information
  

  A desconexão sempre remove tokens de autenticação armazenados e limpa os contextos salvos associados ao usuário ou contexto desconectado.

• Use Clear-AzContext. Esse cmdlet sempre remove contextos armazenados e tokens de autenticação e o desconscreve.

• Remova um contexto com Remove-AzContext:

  Remove-AzContext -Name MyContextName # Remove by name
  Get-AzContext -Name MyContextName | Remove-AzContext # Remove by piping an Azure context object
  

  Se você remover o contexto ativo, será desconectado do Azure e precisará se autenticar novamente com Connect-AzAccount.

Consulte também

• Connect-AzAccount
• Disconnect-AzAccount
• Get-AzContext
• Set-AzContext
• Save-AzContext
• Select-AzContext
• Import-AzContext
• Clear-AzContext
• Remove-AzContext
• Enable-AzContextAutosave
• Disable-AzContextAutosave
• Get-AzSubscription