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
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet 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 Cofre de Chaves do Azure. Você pode restaurar um segredo de backup para qualquer cofre de chaves na assinatura da qual foi feito o backup. Os motivos típicos para usar esse cmdlet são:

  • Pretende depositar uma cópia do seu segredo, para que tenha uma cópia offline no caso de eliminar acidentalmente o seu segredo no cofre de chaves.
  • Você adicionou um segredo a um cofre de chaves e agora deseja cloná-lo em uma região diferente do Azure, para que possa usá-lo de todas as instâncias do seu aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultSecret para recuperar o segredo em 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

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

Exemplo 2: Faça backup de um segredo para um nome de arquivo especificado, substituindo o arquivo existente sem avisar

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

C:\Backup.blob

Este comando recupera o segredo chamado MySecret do cofre de chaves chamado 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

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

Parâmetros

-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

-DefaultProfile

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

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

-Force

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

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

-InputObject

Segredo a ser copiado, canalizado a partir da saída de uma chamada de recuperação.

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

-Name

Especifica o nome do segredo do backup.

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

-OutputFile

Especifica o arquivo de saída no qual o blob de backup está 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 informando que o arquivo de backup já existe.

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

-VaultName

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

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

PSKeyVaultSecretIdentityItem

Saídas

String