Backup-AzKeyVaultKey

Referência

Módulo:: Az.KeyVault

Faz backup de uma chave em um cofre de chaves.

Syntax

Backup-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Backup-AzKeyVaultKey faz backup de uma chave especificada em um cofre de chaves baixando-a e armazenando-a em um arquivo. Se houver várias versões da chave, 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 uma chave 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 da sua chave, para que tenha uma cópia offline no caso de eliminar acidentalmente a sua chave no cofre de chaves.
Você criou uma chave usando o Cofre da Chave e agora deseja cloná-la em uma região diferente do Azure, para que possa usá-la de todas as instâncias do seu aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultKey para recuperar a chave em formato criptografado e, em seguida, use o cmdlet Restore-AzKeyVaultKey e especifique um cofre de chaves na segunda região.

Exemplos

Exemplo 1: Fazer backup de uma chave com um nome de arquivo gerado automaticamente

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

Este comando recupera a chave chamada MyKey do cofre de chaves chamado MyKeyVault e salva um backup dessa chave em um arquivo que é nomeado automaticamente para você e exibe o nome do arquivo.

Exemplo 2: Fazer backup de uma chave para um nome de arquivo especificado

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Este comando recupera a chave chamada MyKey do cofre de chaves chamado MyKeyVault e salva um backup dessa chave em um arquivo chamado Backup.blob.

Exemplo 3: Faça backup de uma chave recuperada anteriormente para um nome de arquivo especificado, substituindo o arquivo de destino sem solicitar.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Este comando cria um backup da chave chamada $key. Nome no cofre chamado $key. VaultName para um arquivo chamado Backup.blob, substituindo silenciosamente o arquivo se ele já existir.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Substitua o arquivo fornecido, se ele existir

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HsmName

Nome HSM. O cmdlet constrói o FQDN de um HSM gerenciado com base no nome e no ambiente selecionado no momento.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Pacote de chaves para backup, canalizado a partir da saída de uma chamada de recuperação.

Type:	PSKeyVaultKeyIdentityItem
Aliases:	Key
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Especifica o nome da chave para backup.

Type:	String
Aliases:	KeyName
Position:	1
Default value:	None
Required:	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.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

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

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

PSKeyVaultKeyIdentityItem

Saídas

String