Backup-AzKeyVaultCertificate

  • Referência
Módulo:
Az.KeyVault

Faz backup de um certificado em um cofre de chaves.

Sintaxe

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

Description

O cmdlet Backup-AzKeyVaultCertificate faz backup de um certificado especificado em um cofre de chaves baixando-o e armazenando-o em um arquivo. Se o certificado tiver várias versões, todas as suas 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 certificado de backup para qualquer cofre de chaves na assinatura da qual foi feito o backup, desde que o cofre esteja na mesma geografia do Azure. Os motivos típicos para usar esse cmdlet são:

  • Você deseja manter uma cópia offline do certificado caso exclua acidentalmente o original do cofre.

  • Você criou um certificado usando o Key Vault e agora deseja clonar o objeto em uma região diferente do Azure, para que possa usá-lo em todas as instâncias do aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultCertificate para recuperar o certificado em formato criptografado e, em seguida, use o cmdlet Restore-AzKeyVaultCertificate e especifique um cofre de chaves na segunda região.

Exemplos

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

Backup-AzKeyVaultCertificate -VaultName 'mykeyvault' -Name 'mycert'

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

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

Exemplo 2: Fazer backup de um certificado em um nome de arquivo especificado

Backup-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

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

Exemplo 3: Faça backup de um certificado recuperado anteriormente em um nome de arquivo especificado, substituindo o arquivo de destino sem avisar.

$cert = Get-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert'
Backup-AzKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Esse comando cria um backup do certificado chamado $cert. Nome no cofre chamado $cert. 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.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
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 a 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

Substituir o arquivo fornecido, se ele existir

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

-InputObject

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

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

-Name

Nome secreto. O cmdlet constrói o FQDN de um segredo do nome do cofre, do ambiente selecionado no momento e do nome do segredo.

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

-OutputFile

Arquivo de saída. O arquivo de saída para armazenar o backup do certificado. Se não for especificado, um nome de arquivo padrão será gerado.

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

-VaultName

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

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:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSKeyVaultCertificateIdentityItem

Saídas

String