KeyClient.BackupKeyAsync(String, CancellationToken) Methode

Definition

Namespace:

Azure.Security.KeyVault.Keys

Assembly:

Azure.Security.KeyVault.Keys.dll

Paket:

Azure.Security.KeyVault.Keys v4.6.0

Quelle:

KeyClient.cs

Fordert an, dass eine Sicherung des angegebenen Schlüssels auf den Client heruntergeladen wird.

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

Parameter

name

String

Der Name des Schlüssels.

cancellationToken

CancellationToken

Ein CancellationToken , der die Lebensdauer der Anforderung steuert.

Gibt zurück

Task<Response<Byte[]>>

Ausnahmen

ArgumentException

name ist eine leere Zeichenfolge.

ArgumentNullException

name ist NULL.

RequestFailedException

Der Server hat einen Fehler zurückgegeben. Weitere Informationen, die vom Server zurückgegeben werden, finden Sie Message unter.

Hinweise

Der Schlüsselsicherungsvorgang exportiert einen Schlüssel aus Azure Key Vault in einem geschützten Format. Beachten Sie, dass dieser Vorgang DEN tatsächlichen Schlüssel NICHT in einer Form zurückgibt, die außerhalb des Azure Key Vault-Systems verwendet werden kann. Der zurückgegebene Schlüssel ist entweder für ein Azure Key Vault HSM oder für Azure Key Vault selbst geschützt. Der Zweck dieses Vorgangs ist es, einem Client zu ermöglichen einen Schlüssel in einer Azure-Schlüsseltresorinstanz zu generieren (GENERATE), den Schlüssel zu sichern (BACKUP) und ihn dann in einer anderen Azure-Schlüsseltresorinstanz wiederherzustellen. Der BACKUP-Vorgang kann verwendet werden, um jeden Schlüsseltyp in geschützter Form aus dem Azure-Schlüsseltresor zu exportieren. Einzelne Versionen eines Schlüssels können nicht gesichert werden. BACKUP/RESTORE kann nur innerhalb geografischer Grenzen ausgeführt werden. Dies bedeutet, dass eine Sicherung (BACKUP) aus einem geografischen Bereich nicht in einem anderen geografischen Bereich wiederhergestellt werden kann. Beispielsweise kann eine Sicherung aus dem geografischen Gebiet der USA nicht in einem geografischen Bereich der EU wiederhergestellt werden. Für diesen Vorgang ist die Schlüssel-/Sicherungsberechtigung erforderlich.