Backup-AzureKeyVaultCertificate

  • Referência
Módulo:
AzureRM.KeyVault

Faz backup de um certificado em um cofre de chaves.

Aviso

O módulo do PowerShell do AzureRM foi oficialmente preterido em 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Sintaxe

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

Description

O cmdlet Backup-AzureKeyVaultCertificate 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 Cofre de Chaves do Azure. Você pode restaurar um certificado de backup para qualquer cofre de chaves na assinatura da qual foi feito 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 Cofre de Chaves e agora deseja clonar o objeto 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-AzureKeyVaultCertificate para recuperar o certificado em formato criptografado e, em seguida, use o cmdlet Restore-AzureKeyVaultCertificate 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

PS C:\Users\username\> Backup-AzureKeyVaultCertificate -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

PS C:\> Backup-AzureKeyVaultKey -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 solicitar.

PS C:\> $cert = Get-AzureKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert'
PS C:\> Backup-AzureKeyVaultCertificate -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 em 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:AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Substitua 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 atualmente selecionado 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

Parâmetros: InputObject (ByValue)

Saídas

String