Backup-AzKeyVaultSecret
Faz backup de um segredo em um cofre de chaves.
Syntax
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 backup. Os motivos típicos para usar esse cmdlet são:
- Você deseja depositar uma cópia do seu segredo, para que você tenha uma cópia off-line, caso você acidentalmente exclua seu segredo no seu 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: Fazer backup de um segredo em 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
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 em 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 salvar seu backup em um arquivo chamado Backup.blob.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valor padrão: | False |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Solicita a confirmação antes de substituir o arquivo de saída, se ele existir.
Tipo: | SwitchParameter |
Position: | Named |
valor padrão: | False |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Segredo a ser copiado, canalizado a partir da saída de uma chamada de recuperação.
Tipo: | PSKeyVaultSecretIdentityItem |
Aliases: | Secret |
Position: | 0 |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Especifica o nome do segredo para backup.
Tipo: | String |
Aliases: | SecretName |
Position: | 1 |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Especifica o nome do cofre de chaves que contém o segredo para backup.
Tipo: | String |
Position: | 0 |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Position: | Named |
valor padrão: | False |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |