Backup-AzKeyVaultCertificate
Faz backup de um certificado em um cofre de chaves.
Sintaxe
ByCertificateName (Predefinição)
Backup-AzKeyVaultCertificate
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByCertificate
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 descarregado está encriptado, não pode ser utilizado fora do Azure Key Vault. Podes restaurar um certificado de backup em qualquer cofre de chave na subscrição de onde 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.
Criou um certificado usando o Key Vault e agora quer clonar o objeto para uma região Azure diferente, para que possa usá-lo a partir de todas as instâncias da sua aplicação distribuída. 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
Este 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 para um nome de arquivo especificado
Backup-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' -OutputFile 'C:\Backup.blob'
C:\Backup.blob
Este 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.
$cert = Get-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert'
Backup-AzKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blob
Este 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 confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-DefaultProfile
As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.
Propriedades dos parâmetros
| Tipo: | IAzureContextContainer |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Force
Substitua o arquivo fornecido, se ele existir
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-InputObject
Segredo a ser copiado, canalizado a partir da saída de uma chamada de recuperação.
Propriedades dos parâmetros
| Tipo: | PSKeyVaultCertificateIdentityItem |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Certidão |
Conjuntos de parâmetros
ByCertificate
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Nome Secreto |
Conjuntos de parâmetros
ByCertificateName
| Position: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-VaultName
Nome do cofre. O cmdlet constrói o FQDN de um cofre com base no nome e no ambiente selecionado no momento.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
ByCertificateName
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.