KeyClient.BackupKeyAsync(String, CancellationToken) Méthode

Définition

Espace de noms:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Paquet:

Azure.Security.KeyVault.Keys v4.6.0

Source:

KeyClient.cs

Demande qu’une sauvegarde de la clé spécifiée soit téléchargée sur le client.

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()))

Paramètres

name

String

Nom de la clé.

cancellationToken

CancellationToken

CancellationToken Contrôle de la durée de vie de la requête.

Retours

Task<Response<Byte[]>>

Exceptions

ArgumentException

name est une chaîne vide.

ArgumentNullException

name a la valeur null.

RequestFailedException

Le serveur a retourné une erreur. Consultez Message pour plus d’informations retournées à partir du serveur.

Remarques

L’opération De sauvegarde de clé exporte une clé à partir d’Azure Key Vault sous une forme protégée. Notez que cette opération ne retourne PAS la clé réelle dans un formulaire qui peut être utilisé en dehors du système Azure Key Vault. La clé retournée est protégée par un HSM Azure Key Vault ou par Azure Key Vault lui-même. L'objectif de cette opération consiste à permettre à un client de générer (GENERATE) une clé dans une instance de coffre de clés Azure, de sauvegarder (BACKUP) la clé, puis de la restaurer (RESTORE) dans une autre instance de coffre de clés Azure. L'opération BACKUP peut servir à exporter, sous forme protégée, n'importe quel type de clé à partir du coffre de clés Azure. Les versions individuelles d'une clé ne peuvent pas être sauvegardées. Les opérations BACKUP/RESTORE peuvent être effectuées uniquement dans certaines limites géographiques. Cela signifie qu'une sauvegarde à partir d'une zone géographique ne peut pas être restaurée dans une autre. Par exemple, une sauvegarde réalisée dans la zone géographique US ne peut pas être restaurée dans une zone géographique UE. Cette opération nécessite l’autorisation clé/sauvegarde.