ClientEncryptionKey.ReadAsync(RequestOptions, CancellationToken) メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

ソース:

ClientEncryptionKey.cs

非同期操作として Azure Cosmos サービスからクライアント暗号化キーのプロパティを読み取ります。 このメソッドは、直接呼び出されるものではありません。 クライアント側の暗号化を使用するには、 を参照してください https://aka.ms/CosmosClientEncryption 。

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse> ReadAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ClientEncryptionKeyResponse>

Public MustOverride Function ReadAsync (Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientEncryptionKeyResponse)

パラメーター

requestOptions

RequestOptions

(省略可能)要求のオプション。

cancellationToken

CancellationToken

(省略可能)要求の取り消しを表すトークン。

戻り値

Task<ClientEncryptionKeyResponse>

読み取られたクライアント暗号化キーの ClientEncryptionKeyProperties 詳細を含む をラップする待機可能な応答。

例外

CosmosException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 クライアント暗号化キーを読み取るときに得られる一般的なコードは次のとおりです。

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースまたは親リソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 CosmosException.RetryAfter の値を調べ、この操作を再試行する前に待機する必要がある時間を確認します。