DocumentClient.CreateUserDefinedFunctionAsync メソッド

定義

名前空間:

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

オーバーロード

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)	Azure Cosmos DB サービスで、ユーザー定義関数を非同期操作として作成します。
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)	Azure Cosmos DB サービスで、ユーザー定義関数を非同期操作として作成します。

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Azure Cosmos DB サービスで、ユーザー定義関数を非同期操作として作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> CreateUserDefinedFunctionAsync (string collectionLink, Microsoft.Azure.Documents.UserDefinedFunction function, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function CreateUserDefinedFunctionAsync (collectionLink As String, function As UserDefinedFunction, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

パラメーター

collectionLink

String

ユーザー定義関数を作成する のリンク DocumentCollection 。 例: dbs/db_rid/colls/col_rid/

function

UserDefinedFunction

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

options

RequestOptions

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

戻り値

Task<ResourceResponse<UserDefinedFunction>>

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

実装

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

例外

ArgumentNullException

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

AggregateException

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

DocumentClientException

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

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

例

//Create a user defined function that converts a string to upper case
UserDefinedFunction udf = client.CreateUserDefinedFunctionAsync(collectionLink, new UserDefinedFunction
{
   Id = "ToUpper",
   Body = @"function toUpper(input) {
                       return input.toUpperCase();
                    }",
});

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• UserDefinedFunction
• RequestOptions

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Azure Cosmos DB サービスで、ユーザー定義関数を非同期操作として作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> CreateUserDefinedFunctionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.UserDefinedFunction function, Microsoft.Azure.Documents.Client.RequestOptions options = default);

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

Public Function CreateUserDefinedFunctionAsync (documentCollectionUri As Uri, function As UserDefinedFunction, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

パラメーター

documentCollectionUri

Uri

ユーザー定義関数を作成するドキュメント コレクションの URI。

function

UserDefinedFunction

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

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<UserDefinedFunction>>

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

実装

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)