CosmosScripts.ReadUserDefinedFunctionAsync メソッド

定義

名前空間:

Azure.Cosmos.Scripts

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

UserDefinedFunctionProperties非同期操作として Azure Cosmos DB サービスから を読み取ります。

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>> ReadUserDefinedFunctionAsync (string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadUserDefinedFunctionAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>>

Public MustOverride Function ReadUserDefinedFunctionAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UserDefinedFunctionProperties))

パラメーター

id

String

読み取るユーザー定義関数の ID

requestOptions

RequestOptions

(省略可能)ユーザー定義関数要求のオプション RequestOptions

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<Response<UserDefinedFunctionProperties>>

Task読み取りリソース レコードをResponse<T>含む をUserDefinedFunctionPropertiesラップする を含む 。

例外

CosmosException

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

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

例

これにより、既存のユーザー定義関数が読み取ります。

CosmosScripts scripts = this.container.Scripts;
Response<UserDefinedFunctionProperties> response = await scripts.ReadUserDefinedFunctionAsync("ExistingId");
UserDefinedFunctionProperties udfProperties = response;