KeyClient.BackupKey(String, CancellationToken) メソッド

定義

名前空間:

Azure.Security.KeyVault.Keys

アセンブリ:

Azure.Security.KeyVault.Keys.dll

パッケージ:

Azure.Security.KeyVault.Keys v4.6.0

ソース:

KeyClient.cs

指定したキーのバックアップをクライアントにダウンロードするように要求します。

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

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

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

パラメーター

name

String

キーの名前です。

cancellationToken

CancellationToken

CancellationToken要求の有効期間を制御する 。

戻り値

Response<Byte[]>

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

サーバーからエラーが返されました。 サーバーから返される詳細については、「」を参照してください Message 。

注釈

キー バックアップ操作は、保護された形式で Azure Key Vaultからキーをエクスポートします。 この操作では、Azure Key Vault システムの外部で使用できる形式の実際のキーは返されません。返されるキーは、Azure Key Vault HSM または Azure Key Vault 自体に保護されます。 この操作の目的は、クライアントがある Azure Key Vault インスタンスでキーを生成し、そのキーをバックアップしてから、別の Azure Key Vault インスタンスで復元できるようにすることです。 バックアップ操作は、保護された形式で Azure Key Vault からすべての種類のキーをエクスポートするために使用できます。 キーをバージョンごとにバックアップすることはできません。 バックアップ/復元は地理的な境界内でのみ実行できます。つまり、ある地理的領域からのバックアップを別の地理的領域に復元することはできません。 たとえば、米国の地理的領域からのバックアップを EU の地理的領域に復元することはできません。 この操作には、キー/バックアップのアクセス許可が必要です。