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

定義

名前空間:

Azure.Security.KeyVault.Keys

アセンブリ:

Azure.Security.KeyVault.Keys.dll

パッケージ:

Azure.Security.KeyVault.Keys v4.6.0

ソース:

KeyClient.cs

格納されているキーの公開部分を取得します。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>> GetKeyAsync (string name, string version = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKeyAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>
override this.GetKeyAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Keys.KeyVaultKey>>

Public Overridable Function GetKeyAsync (name As String, Optional version As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultKey))

パラメーター

name

String

キーの名前です。

version

String

キーのバージョン。

cancellationToken

CancellationToken

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

戻り値

Task<Response<KeyVaultKey>>

例外

ArgumentException

name が空の文字列です。

ArgumentNullException

name が null です。

RequestFailedException

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

注釈

キーの取得操作は、すべてのキーの種類に適用できます。 要求されたキーが対称の場合、応答でキーは解放されません。 この操作には、キー/取得アクセス許可が必要です。