KeyVaultClient.GetDeletedKeysWithHttpMessagesAsync メソッド

定義

名前空間:

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.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>> GetDeletedKeysWithHttpMessagesAsync (string vaultBaseUrl, int? maxresults = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDeletedKeysWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>>
override this.GetDeletedKeysWithHttpMessagesAsync : string * Nullable<int> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.KeyVault.Models.DeletedKeyItem>>>

Public Function GetDeletedKeysWithHttpMessagesAsync (vaultBaseUrl As String, Optional maxresults As Nullable(Of Integer) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of DeletedKeyItem)))

パラメーター

vaultBaseUrl

String

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

maxresults

Nullable<Int32>

ページに返される結果の最大数。 指定しない場合、サービスは最大 25 件の結果を返します。

customHeaders

Dictionary<String,List<String>>

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

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<AzureOperationResponse<IPage<DeletedKeyItem>>>

実装

GetDeletedKeysWithHttpMessagesAsync(String, Nullable<Int32>, Dictionary<String,List<String>>, CancellationToken)

例外

KeyVaultErrorException

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

SerializationException

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

ValidationException

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

ArgumentNullException

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

注釈

削除されたキーの公開部分を含む JSON Web キー構造として、Key Vault内のキーの一覧を取得します。 この操作には、削除固有の情報が含まれます。 削除済みキーの取得操作は、論理的な削除が有効なコンテナーに適用されます。 操作は任意のコンテナーで呼び出すことができますが、論理的な削除が有効になっていないコンテナーで呼び出されるとエラーが返されます。 この操作には、キー/リストのアクセス許可が必要です。