Partilhar via

Backup-AzKeyVaultSecret

  • Referência
Módulo:
Az.KeyVault

Faz backup de um segredo em um cofre de chaves.

Sintaxe

Backup-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultSecret
      [-Id] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet backup do Backup-AzKeyVaultSecret faz backup de um segredo especificado em um cofre de chaves baixando-o e armazenando-o em um arquivo. Se houver várias versões do segredo, todas as versões serão incluídas no backup. Como o conteúdo baixado é criptografado, ele não pode ser usado fora do Azure Key Vault. Você pode restaurar um segredo de backup para qualquer cofre de chaves na assinatura da qual ele foi feito backup. Os motivos típicos para usar esse cmdlet são:

  • Você deseja escrow uma cópia do seu segredo, para que você tenha uma cópia offline no caso de excluir acidentalmente seu segredo em seu cofre de chaves.
  • Você adicionou um segredo a um cofre de chaves e agora deseja clonar o segredo em uma região diferente do Azure, para que possa usá-lo de todas as instâncias do aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultSecret para recuperar o segredo no formato criptografado e, em seguida, use o cmdlet Restore-AzKeyVaultSecret e especifique um cofre de chaves na segunda região. (Observe que as regiões devem pertencer à mesma geografia.)

Exemplos

Exemplo 1: fazer backup de um segredo com um nome de arquivo gerado automaticamente

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

C:\Users\username\mykeyvault-mysecret-1527029447.01191

Esse comando recupera o segredo chamado MySecret do cofre de chaves chamado MyKeyVault e salva um backup desse segredo em um arquivo que é automaticamente nomeado para você e exibe o nome do arquivo.

Exemplo 2: fazer backup de um segredo para um nome de arquivo especificado, substituindo o arquivo existente sem solicitar

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Esse comando recupera o segredo chamado MySecret do cofre de chaves denominado MyKeyVault e salva um backup desse segredo em um arquivo chamado Backup.blob.

Exemplo 3: fazer backup de um segredo recuperado anteriormente para um nome de arquivo especificado

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Esse comando usa o nome e o nome do cofre do objeto $secret para recuperar o segredo e salva seu backup em um arquivo chamado Backup.blob.

Exemplo 4: fazer backup de um segredo com um nome de arquivo gerado automaticamente (usando Uri)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

Parâmetros

-Confirm

Solicita a 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

-DefaultProfile

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

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

-Force

Solicita a confirmação antes de substituir o arquivo de saída, se isso existir.

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

-Id

O URI do segredo KeyVault. Verifique se ele segue o formato: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

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

-InputObject

Segredo a ser feito em backup, pipeline na saída de uma chamada de recuperação.

Tipo:PSKeyVaultSecretIdentityItem
Aliases:Secret
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome do segredo a ser backup.

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

-OutputFile

Especifica o arquivo de saída no qual o blob de backup é armazenado. Se você não especificar esse parâmetro, esse cmdlet gerará um nome de arquivo para você. Se você especificar o nome de um arquivo de saída existente, a operação não será concluída e retornará uma mensagem de erro que o arquivo de backup já existe.

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

-VaultName

Especifica o nome do cofre de chaves que contém o segredo a ser backup.

Tipo:String
Cargo:0
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

Saídas