DocumentClient.CreateStoredProcedureAsync メソッド

定義

名前空間:

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

オーバーロード

CreateStoredProcedureAsync(String, StoredProcedure, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてストアド プロシージャを作成します。
CreateStoredProcedureAsync(Uri, StoredProcedure, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてストアド プロシージャを作成します。

CreateStoredProcedureAsync(String, StoredProcedure, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてストアド プロシージャを作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> CreateStoredProcedureAsync (string collectionLink, Microsoft.Azure.Documents.StoredProcedure storedProcedure, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function CreateStoredProcedureAsync (collectionLink As String, storedProcedure As StoredProcedure, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

パラメーター

collectionLink

String

ストアド プロシージャを作成するコレクションのリンク。 例: dbs/db_rid/colls/col_rid/

storedProcedure

StoredProcedure

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

options

RequestOptions

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

戻り値

Task<ResourceResponse<StoredProcedure>>

非同期操作の StoredProcedure サービス応答を Task 表す オブジェクト内に格納されている 作成された 。

実装

CreateStoredProcedureAsync(String, StoredProcedure, RequestOptions)

例外

ArgumentNullException

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

AggregateException

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

DocumentClientException

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

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

例

//Create a new stored procedure called "HelloWorldSproc" that takes in a single param called "name".
StoredProcedure sproc = await client.CreateStoredProcedureAsync(collectionLink, new StoredProcedure
{
   Id = "HelloWorldSproc",
   Body = @"function (name){
               var response = getContext().getResponse();
               response.setBody('Hello ' + name);
            }"
});

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• StoredProcedure
• RequestOptions

CreateStoredProcedureAsync(Uri, StoredProcedure, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてストアド プロシージャを作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> CreateStoredProcedureAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.StoredProcedure storedProcedure, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function CreateStoredProcedureAsync (documentCollectionUri As Uri, storedProcedure As StoredProcedure, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

パラメーター

documentCollectionUri

Uri

ストアド プロシージャを作成するドキュメント コレクションの URI。

storedProcedure

StoredProcedure

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

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<StoredProcedure>>

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

実装

CreateStoredProcedureAsync(Uri, StoredProcedure, RequestOptions)