Compartilhar via

Backup-AzKeyVaultSecret

Módulo:
Az.KeyVault Module

Faz backup de um segredo em um cofre de chaves.

Sintaxe

BySecretName (Default) 

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 baixado é criptografado, ele não pode ser usado fora de Azure Key Vault. Você pode restaurar um segredo de backup para qualquer cofre de chaves na assinatura da qual ele foi feito backup. Os motivos típicos para usar esse cmdlet são:

  • Você deseja escrow uma cópia do seu segredo, para que você tenha uma cópia offline no caso de excluir acidentalmente seu segredo em seu cofre de chaves.
  • Você adicionou um segredo a um cofre de chaves e agora deseja clonar o segredo em uma região de Azure diferente, para que possa usá-lo de todas as instâncias do aplicativo distribuído. Use o cmdlet Backup-AzKeyVaultSecret para recuperar o segredo no 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

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

Exemplo 2: fazer backup de um segredo para um nome de arquivo especificado, substituindo o arquivo existente sem solicitar

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

C:\Backup.blob

Esse comando recupera o segredo chamado MySecret do cofre de chaves denominado 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

Esse comando usa o nome e o nome do cofre do objeto $secret para recuperar o segredo e salva 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 sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
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 usadas 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

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
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

-Id

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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-InputObject

Segredo a ser feito em backup, pipeline na saída de uma chamada de recuperação.

Propriedades do parâmetro

Tipo:PSKeyVaultSecretIdentityItem
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:Segredo

Conjuntos de parâmetros

BySecret
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 do segredo a ser backup.

Propriedades do parâmetro

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

Conjuntos de parâmetros

BySecretName
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 o segredo a ser backup.

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

PSKeyVaultSecretIdentityItem

Saídas

String