KeyClient.BackupKeyAsync(String, CancellationToken) Método

Definição

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Pacote:

Azure.Security.KeyVault.Keys v4.6.0

Origem:

KeyClient.cs

Solicita que um backup da chave especificada seja baixado para o cliente.

public virtual System.Threading.Tasks.Task<Azure.Response<byte[]>> BackupKeyAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member BackupKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<byte[]>>
override this.BackupKeyAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<byte[]>>

Public Overridable Function BackupKeyAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Byte()))

Parâmetros

name

String

O nome da chave.

cancellationToken

CancellationToken

Um CancellationToken que controla o tempo de vida da solicitação.

Retornos

Task<Response<Byte[]>>

Exceções

ArgumentException

name é uma cadeia de caracteres vazia.

ArgumentNullException

name é nulo.

RequestFailedException

O servidor retornou um erro. Consulte Message para obter detalhes retornados do servidor.

Comentários

A operação de Backup de Chave exporta uma chave do Azure Key Vault em um formulário protegido. Observe que essa operação NÃO retorna a chave real em um formulário que pode ser usado fora do sistema de Key Vault do Azure, a chave retornada é protegida para um HSM Key Vault do Azure ou para o próprio Azure Key Vault. A intenção dessa operação é permitir que um cliente GERE uma chave em uma instância do Cofre de Chaves do Azure, FAÇA BACKUP da chave e, em seguida, RESTAURE a chave em outra instância do Cofre de Chaves do Azure. A operação BACKUP pode ser usada para exportar, de forma protegida, qualquer tipo de chave do Cofre de Chaves do Azure. Não é possível fazer backup das versões individuais de uma chave. A operação BACKUP/RESTORE pode ser executada apenas dentro dos limites geográficos. Isso significa que um BACKUP de uma área geográfica não pode ser restaurado para outra área geográfica. Por exemplo, um backup da área geográfica dos EUA não pode ser restaurado em uma área geográfica da UE. Essa operação requer a permissão de chave/backup.