DocumentClient.CreateUserDefinedFunctionAsync Methode

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblys:

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

Pakete:

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

Überlädt

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)	Erstellt eine benutzerdefinierte Funktion als asychroner Vorgang im Azure Cosmos DB-Dienst.
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)	Erstellt eine benutzerdefinierte Funktion als asychroner Vorgang im Azure Cosmos DB-Dienst.

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Erstellt eine benutzerdefinierte Funktion als asychroner Vorgang im Azure Cosmos DB-Dienst.

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))

Parameter

collectionLink

String

Der Link des , in dem DocumentCollection die benutzerdefinierte Funktion erstellt werden soll. Beispiel: dbs/db_rid/colls/col_rid/

function

UserDefinedFunction

Das UserDefinedFunction zu erstellende Objekt.

options

RequestOptions

(Optional) Jeder RequestOptionsfür diese Anforderung.

Gibt zurück

Task<ResourceResponse<UserDefinedFunction>>

Ein Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Ausnahmen

ArgumentNullException

Wenn oder collectionLinkfunction nicht festgelegt ist.

AggregateException

Stellt eine Konsolidierung von Fehlern dar, die während der asynchronen Verarbeitung aufgetreten sind. Suchen Sie in InnerExceptions nach den tatsächlichen Ausnahmen.

DocumentClientException

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten können, sind:

StatusCode	Grund für die Ausnahme
400	BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung ein Fehler aufgetreten ist. Es ist wahrscheinlich, dass für die neue benutzerdefinierte Funktion keine ID angegeben wurde oder dass der Text falsch formatiert wurde.
403	Verboten: Sie haben ihr Kontingent an benutzerdefinierten Funktionen für die angegebene Sammlung erreicht. Wenden Sie sich an den Support, um dieses Kontingent zu erhöhen.
409	Konflikt: Dies bedeutet, dass ein UserDefinedFunction mit einer ID übereinstimmt, die der von Ihnen angegebenen ID entspricht, bereits vorhanden ist.
413	RequestEntityTooLarge: Dies bedeutet, dass der Textkörper des UserDefinedFunction zu erstellenden zu groß war.

Beispiele

//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();
                    }",
});

Weitere Informationen

• ResourceResponse<TResource>
• Task
• UserDefinedFunction
• RequestOptions

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Erstellt eine benutzerdefinierte Funktion als asychroner Vorgang im Azure Cosmos DB-Dienst.

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))

Parameter

documentCollectionUri

Uri

der URI der Dokumentauflistung, in der die benutzerdefinierte Funktion erstellt werden soll.

function

UserDefinedFunction

das Microsoft.Azure.Documents.UserDefinedFunction-Objekt.

options

RequestOptions

Die Anforderungsoptionen für die Anforderung.

Gibt zurück

Task<ResourceResponse<UserDefinedFunction>>

Das Aufgabenobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

Implementiert

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)