Partilhar via

Backup-AzKeyVaultSecret

Módulo:
Az.KeyVault Module

Faz backup de um segredo em um cofre de chaves.

Sintaxe

BySecretName (Predefinição) 

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

BySecretUri 

Backup-AzKeyVaultSecret
    [-Id] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySecret 

Backup-AzKeyVaultSecret
    [-InputObject] <PSKeyVaultSecretIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Backup-AzKeyVaultSecret faz backup de um segredo especificado em um cofre de chaves baixando-o e armazenando-o em um arquivo. Se houver várias versões do segredo, todas as 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. Você pode restaurar um segredo 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 do seu segredo, para que tenha uma cópia offline no caso de eliminar acidentalmente o seu segredo no cofre de chaves.
  • Adicionaste um segredo a um cofre de chaves e agora queres clonar o segredo para uma região Azure diferente, para poderes usá-lo a partir de todas as instâncias da tua aplicação distribuída. Use o cmdlet Backup-AzKeyVaultSecret para recuperar o segredo em formato criptografado e, em seguida, use o cmdlet Restore-AzKeyVaultSecret e especifique um cofre de chaves na segunda região. (Observe que as regiões devem pertencer à mesma geografia.)

Exemplos

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

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

Exemplo 2: Faça backup de um segredo para um nome de arquivo especificado, substituindo o arquivo existente sem avisar

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Este comando recupera o segredo chamado MySecret do cofre de chaves chamado MyKeyVault e salva um backup desse segredo em um arquivo chamado Backup.blob.

Exemplo 3: Fazer backup de um segredo recuperado anteriormente para um nome de arquivo especificado

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Este comando usa o nome e o nome do cofre do objeto $secret para recuperar o segredo e salvar seu backup em um arquivo chamado Backup.blob.

Exemplo 4: Fazer backup de um segredo com um nome de arquivo gerado automaticamente (usando Uri)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
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, a conta, o locatário e a assinatura 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

Solicita confirmação antes de substituir o arquivo de saída, se ele existir.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
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

-Id

O URI do segredo KeyVault. Certifique-se de que segue o formato: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:SecretId

Conjuntos de parâmetros

BySecretUri
Position:0
Obrigatório:True
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:PSKeyVaultSecretIdentityItem
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Segredo

Conjuntos de parâmetros

BySecret
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Especifica o nome do segredo do backup.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Nome Secreto

Conjuntos de parâmetros

BySecretName
Position:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

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

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

BySecretName
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:False
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.

Entradas

PSKeyVaultSecretIdentityItem

Saídas

String