IDocumentClient.CreateUserDefinedFunctionAsync Methode

Definition

Namespace:

Microsoft.Azure.Documents

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 asychronen Vorgang im Azure Cosmos DB-Dienst.
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)	Erstellt eine benutzerdefinierte Funktion als asychronen Vorgang im Azure Cosmos DB-Dienst.

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Erstellt eine benutzerdefinierte Funktion als asychronen 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>>

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 zum DocumentCollection Erstellen der benutzerdefinierten Funktion in. Beispiel: dbs/db_rid/colls/col_rid/

function

UserDefinedFunction

Das UserDefinedFunction zu erstellende Objekt.

options

RequestOptions

(Optional) Alle RequestOptionsfür diese Anforderung.

Gibt zurück

Task<ResourceResponse<UserDefinedFunction>>

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

Ausnahmen

ArgumentNullException

Wenn entweder collectionLink oder function nicht festgelegt ist.

AggregateException

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

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, sind:

StatusCode	Ausnahmegrund
400	BadRequest: Dies bedeutet, dass mit der bereitgestellten Anforderung etwas nicht stimmte. Es ist wahrscheinlich, dass keine ID für die neue benutzerdefinierte Funktion angegeben wurde oder dass der Textkörper falsch formatiert wurde.
403	Verboten: Sie haben Ihr Kontingent an benutzerdefinierten Funktionen für die bereitgestellte Sammlung erreicht. Wenden Sie sich an den Support, um dieses Kontingent zu erhöhen.
409	Konflikt: Dies bedeutet, dass eine UserDefinedFunction mit einer ID übereinstimmt, die der von Ihnen angegebenen ID entspricht, bereits vorhanden ist.
413	RequestEntityTooLarge: Dies bedeutet, dass der Textkörper der UserDefinedFunction zu erstellenden Datei 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

• UserDefinedFunction
• RequestOptions
• ResourceResponse<TResource>
• Task

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Erstellt eine benutzerdefinierte Funktion als asychronen 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>>

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 Dokumentsammlung, in der die benutzerdefinierte Funktion erstellt werden soll.

function

UserDefinedFunction

Das UserDefinedFunction-Objekt.

options

RequestOptions

(Optional) Der RequestOptions für die Anforderung.

Gibt zurück

Task<ResourceResponse<UserDefinedFunction>>

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