KeyVaultClient.BackupKeyWithHttpMessagesAsync メソッド

定義

名前空間:

Microsoft.Azure.KeyVault

アセンブリ:

Microsoft.Azure.KeyVault.dll

パッケージ:

Microsoft.Azure.KeyVault v3.0.5

ソース:

KeyVaultClient.cs

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.BackupKeyResult>> BackupKeyWithHttpMessagesAsync (string vaultBaseUrl, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BackupKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.BackupKeyResult>>
override this.BackupKeyWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.KeyVault.Models.BackupKeyResult>>

Public Function BackupKeyWithHttpMessagesAsync (vaultBaseUrl As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of BackupKeyResult))

パラメーター

vaultBaseUrl

String

コンテナー名 (例: https://myvault.vault.azure.net)。

keyName

String

キーの名前です。

customHeaders

Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<BackupKeyResult>>

実装

BackupKeyWithHttpMessagesAsync(String, String, Dictionary<String,List<String>>, CancellationToken)

例外

KeyVaultErrorException

操作が無効な状態コードを返したときにスローされます

SerializationException

応答を逆シリアル化できない場合にスローされます

ValidationException

必須パラメーターが null の場合にスローされます

ArgumentNullException

必須パラメーターが null の場合にスローされます

注釈

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