DocumentClient.ReadTriggerAsync メソッド

定義

名前空間:

Microsoft.Azure.Documents.Client

アセンブリ:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

パッケージ:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

オーバーロード

ReadTriggerAsync(String, RequestOptions)	Trigger非同期操作として Azure Cosmos DB サービスから を読み取ります。
ReadTriggerAsync(Uri, RequestOptions)	Triggerを Azure Cosmos DB サービスから非同期操作として読み取ります。

ReadTriggerAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerAsync (string triggerLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadTriggerAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>

Public Function ReadTriggerAsync (triggerLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

パラメーター

triggerLink

String

読み取るトリガーへのリンク。

options

RequestOptions

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

戻り値

Task<ResourceResponse<Trigger>>

System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をTriggerラップする を含む 。

実装

ReadTriggerAsync(String, RequestOptions)

例外

ArgumentNullException

が設定されていない場合 triggerLink 。

DocumentClientException

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

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

例

//Reads a Trigger from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - trigger_id is the ID of the trigger to be read
var triggerLink = "/dbs/sample_database/colls/sample_collection/triggers/trigger_id";
Trigger trigger = await client.ReadTriggerAsync(triggerLink);

注釈

リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。

次に示す例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink Trigger の プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または _rid プロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink はどちらも機能します。 の triggerLink 形式は常に "/dbs/{db identifier}/colls/{coll identifier}/triggers/{trigger identifier}" です。{..} 内の値のみが、リソースのアドレス指定に使用する方法によって変わります。

こちらもご覧ください

• Trigger
• RequestOptions
• ResourceResponse<TResource>
• Task
• Uri

ReadTriggerAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerAsync (Uri triggerUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadTriggerAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>

Public Function ReadTriggerAsync (triggerUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

パラメーター

triggerUri

Uri

読み取るトリガー リソースへの URI。

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<Trigger>>

System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をTriggerラップする を含む 。

実装

ReadTriggerAsync(Uri, RequestOptions)

例外

ArgumentNullException

が設定されていない場合 triggerUri 。

DocumentClientException

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

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

例

//Reads a Trigger resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - trigger_id is the ID property of the Trigger you wish to read. 
var triggerLink = UriFactory.CreateTriggerUri("db_id", "coll_id", "trigger_id");
Trigger trigger = await client.ReadTriggerAsync(triggerLink);

注釈

リソースの読み取りを行うことは、サービスからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• Trigger
• RequestOptions