DocumentClient.CreateTriggerAsync メソッド

定義

名前空間:

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

オーバーロード

CreateTriggerAsync(String, Trigger, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてトリガーを作成します。
CreateTriggerAsync(Uri, Trigger, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてトリガーを作成します。

CreateTriggerAsync(String, Trigger, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてトリガーを作成します。

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

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

Public Function CreateTriggerAsync (collectionLink As String, trigger As Trigger, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

パラメーター

collectionLink

String

トリガーを DocumentCollection 作成する のリンク。 例: dbs/db_rid/colls/col_rid/

trigger

Trigger

Trigger作成するオブジェクト。

options

RequestOptions

(省略可能)この要求の任意 RequestOptions。

戻り値

Task<ResourceResponse<Trigger>>

非同期操作のサービス応答を表すタスク オブジェクト。

実装

CreateTriggerAsync(String, Trigger, RequestOptions)

例外

ArgumentNullException

または trigger がcollectionLink設定されていない場合。

AggregateException

非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます

DocumentClientException

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

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。 新しいトリガーに ID が指定されなかったか、本文の形式が正しくない可能性があります。
403	禁止 - 指定されたコレクションのトリガーのクォータに達しました。 このクォータを増やすには、サポートにお問い合わせください。
409	競合 - これは、指定した ID と一致する ID が既に存在する を意味 Trigger します。
413	RequestEntityTooLarge - 作成しようとしたの本文が Trigger 大きすぎたということです。

例

//Create a trigger that validates the contents of a document as it is created and adds a 'timestamp' property if one was not found.
Trigger trig = await client.CreateTriggerAsync(collectionLink, new Trigger
{
    Id = "ValidateDocuments",
    Body = @"function validate() {
                        var context = getContext();
                        var request = context.getRequest();                                                             
                        var documentToCreate = request.getBody();

                        // validate properties
                        if (!('timestamp' in documentToCreate)) {
                            var ts = new Date();
                            documentToCreate['timestamp'] = ts.getTime();
                        }

                        // update the document that will be created
                        request.setBody(documentToCreate);
                      }",
    TriggerType = TriggerType.Pre,
    TriggerOperation = TriggerOperation.Create
});

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• Trigger
• RequestOptions

CreateTriggerAsync(Uri, Trigger, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてトリガーを作成します。

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

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

Public Function CreateTriggerAsync (documentCollectionUri As Uri, trigger As Trigger, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

パラメーター

documentCollectionUri

Uri

トリガーを作成するドキュメント コレクションの URI。

trigger

Trigger

Microsoft.Azure.Documents.Trigger オブジェクト。

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<Trigger>>

非同期操作のサービス応答を表すタスク オブジェクト。

実装

CreateTriggerAsync(Uri, Trigger, RequestOptions)