Compartilhar via

Início Rápido: Definir e recuperar um segredo do Azure Key Vault usando o PowerShell

O Azure Key Vault é um serviço de nuvem que funciona como um repositório de segredos seguro. Você pode armazenar chaves, senhas, certificados e outros segredos com segurança. Para obter mais informações sobre o Key Vault, você pode examinar a visão geral. Neste início rápido, você usará o Azure PowerShell para criar um cofre de chaves. Em seguida, armazene um segredo no cofre recém-criado.

Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.

Azure Cloud Shell

O Azure hospeda o Azure Cloud Shell, um ambiente de shell interativo que você pode usar por meio do navegador. Você pode usar o Bash ou o PowerShell com o Cloud Shell para trabalhar com os serviços do Azure. Você pode usar os comandos pré-instalados do Cloud Shell para executar o código neste artigo, sem precisar instalar nada em seu ambiente local.

Para iniciar o Azure Cloud Shell:

Opção Exemplo/Link
Selecione Experimente no canto superior direito de um código ou bloco de comando. Selecionar Try It não copia automaticamente o código ou o comando para o Cloud Shell. Captura de tela que mostra um exemplo da funcionalidade 'Experimente' do Azure Cloud Shell.
https://shell.azure.comAcesse ou selecione o botão Iniciar Cloud Shell para abrir o Cloud Shell no navegador. Botão para iniciar o Azure Cloud Shell.
Selecione o botão Cloud Shell na barra de menus no canto superior direito no portal do Azure. Captura de tela que mostra o botão Cloud Shell no portal do Azure

Para usar o Azure Cloud Shell:

  1. Inicie o Cloud Shell.

  2. Selecione o botão Copiar em um bloco de código (ou bloco de comando) para copiar o código ou o comando.

  3. Cole o código ou o comando na sessão do Cloud Shell selecionando Ctrl+Shift+V no Windows e Linux ou selecionando Cmd+Shift+V no macOS.

  4. Selecione Enter para executar o código ou o comando.

Se você optar por instalar e usar o PowerShell localmente, este tutorial exigirá o módulo do Azure PowerShell versão 5.0.0 ou posterior. Digite Get-InstalledModule -Name Az para localizar a versão. Se você precisar atualizar, confira Como instalar o Azure PowerShell. Se você estiver executando o PowerShell localmente, também precisará executar o Connect-AzAccount para criar uma conexão com o Azure.

Connect-AzAccount

Criar um grupo de recursos

Um grupo de recursos é um contêiner lógico no qual os recursos do Azure são implantados e gerenciados. Utilize o cmdlet New-AzResourceGroup do PowerShell do Azure para criar um grupo de recursos chamado myResourceGroup na região eastus.

New-AzResourceGroup -Name "myResourceGroup" -Location "EastUS"

Criar um cofre de chaves

Use o cmdlet do Azure PowerShell New-AzKeyVault para criar um Cofre de Chaves no grupo de recursos do passo anterior. Você precisa fornecer algumas informações:

  • Nome do cofre de chaves: uma cadeia de caracteres de 3 a 24 caracteres contendo somente números (0 a 9), letras (a a z, A a Z) e hifens (-)

    Importante

    Cada cofre de chaves deve ter um nome exclusivo. Substitua <vault-name> pelo nome do cofre de chaves nos exemplos a seguir.

  • Nome do grupo de recursos: myResourceGroup

  • A localização: EastUS

New-AzKeyVault -Name "<vault-name>" -ResourceGroupName "myResourceGroup" -Location "EastUS" -EnableRbacAuthorization $true

A saída desse cmdlet mostra as propriedades do cofre de chaves criado recentemente. Anote estas duas propriedades:

  • Nome do cofre: o nome que você forneceu ao parâmetro -Name.
  • URI do cofre: neste exemplo, o URI do cofre é https://<vault-name>.vault.azure.net/. Aplicativos que usam seu cofre via API REST devem usar esse URI.

Neste ponto, sua conta do Azure é a única autorizada a executar quaisquer operações neste novo cofre.

Dê aos usuários da conta permissões para gerenciar segredos no Key Vault

Para obter permissões para o cofre de chaves por meio do RBAC (controle de acesso baseado em função), atribua uma função ao seu UPN (nome principal do usuário) usando o cmdlet do Azure PowerShell New-AzRoleAssignment.

New-AzRoleAssignment -SignInName "<upn>" -RoleDefinitionName "Key Vault Secrets Officer" -Scope "/subscriptions/<subscription-id>/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/<vault-name>"

Substitua <upn>, <subscription-id>e <vault-name> com seus valores reais. Se você usou um nome de grupo de recursos diferente, substitua "myResourceGroup" também. Seu UPN normalmente estará no formato de um endereço de email (por exemplo, username@domain.com).

Adicionando um segredo ao Key Vault

Para adicionar um segredo ao cofre, basta executar algumas etapas. Nesse caso, você adiciona uma senha que pode ser usada por um aplicativo. A senha é chamada ExamplePassword e armazena o valor de hVFkk965BuUv nela.

Primeiro, execute o seguinte comando e insira o valor hVFkk965BuUv quando solicitado a convertê-lo em uma cadeia de caracteres segura:

$secretvalue = Read-Host -Prompt 'Enter the example password' -AsSecureString

Em seguida, use o cmdlet Set-AzKeyVaultSecret do Azure PowerShell para criar um segredo no Key Vault chamado ExamplePassword com o valor hVFkk965BuUv :

$secret = Set-AzKeyVaultSecret -VaultName "<vault-name>" -Name "ExamplePassword" -SecretValue $secretvalue

Recuperar um segredo do Key Vault

Para exibir o valor contido no segredo como texto sem formatação, use o cmdlet Get-AzKeyVaultSecret do Azure PowerShell:

$secret = Get-AzKeyVaultSecret -VaultName "<vault-name>" -Name "ExamplePassword" -AsPlainText

Agora, você criou um Key Vault, armazenou um segredo e o recuperou.

Limpar os recursos

Outros guias de início rápido e tutoriais desta coleção se baseiam neste guia de início rápido. Se você planeja continuar a trabalhar com outros guias de início rápido e tutoriais, convém manter esses recursos.

Quando não for mais necessário, você poderá usar o comando Remove-AzResourceGroup para remover o grupo de recursos, o Key Vault e todos os recursos relacionados.

Remove-AzResourceGroup -Name "myResourceGroup"

Próximas etapas

Neste início rápido, você criou um Key Vault e armazenou um segredo nele. Para saber mais sobre o Key Vault e como integrá-lo a seus aplicativos, confira os artigos abaixo.

  • Last updated on