Compartilhar via

Backup-AzKeyVaultKey

Módulo:
Az.KeyVault Module

Faz backup de uma chave em um cofre de chaves.

Sintaxe

ByKeyName (Default) 

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

HsmByKeyName 

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

ByKey 

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 Azure Key Vault. Você pode restaurar uma chave 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 escrow uma cópia da sua chave, para que você tenha uma cópia offline no caso de excluir acidentalmente sua chave em seu cofre de chaves.

  • Você criou uma chave usando o Key Vault e agora deseja clonar a chave em uma região diferente do Azure, para que possa usá-la de todas as instâncias do aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultKey para recuperar a chave no 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

Esse comando recupera a chave chamada MyKey do cofre de chaves chamado MyKeyVault e salva um backup dessa chave em um arquivo que é automaticamente nomeado 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

Esse comando recupera a chave chamada MyKey do cofre de chaves denominado 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

Esse 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 sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Substituir o arquivo especificado se ele existir

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmName

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

HsmByKeyName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Pacote de chaves para fazer backup, pipeline na saída de uma chamada de recuperação.

Propriedades do parâmetro

Tipo:PSKeyVaultKeyIdentityItem
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Key

Conjuntos de parâmetros

ByKey
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

Especifica o nome da chave a ser backup.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Nome da chave

Conjuntos de parâmetros

ByKeyName
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
HsmByKeyName
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-VaultName

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ByKeyName
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSKeyVaultKeyIdentityItem

Saídas

String