IDocumentClient.CreateUserDefinedFunctionAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Documents

Assemblys:

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

Paquets:

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

Surcharges

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)	Crée une fonction définie par l’utilisateur en tant qu’opération asychronous dans le service Azure Cosmos DB.
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)	Crée une fonction définie par l’utilisateur en tant qu’opération asychronous dans le service Azure Cosmos DB.

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Crée une fonction définie par l’utilisateur en tant qu’opération asychronous dans le service 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>>

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

Paramètres

collectionLink

String

Lien du DocumentCollection dans lequel créer la fonction définie par l’utilisateur. Par exemple, dbs/db_rid/colls/col_rid/

function

UserDefinedFunction

Objet UserDefinedFunction à créer.

options

RequestOptions

(Facultatif) N’importe lequel RequestOptionspour cette demande.

Retours

Task<ResourceResponse<UserDefinedFunction>>

Objet de tâche représentant la réponse du service pour l’opération asynchrone.

Exceptions

ArgumentNullException

Si ou collectionLinkfunction n’est pas défini.

AggregateException

Représente une consolidation des échecs qui se sont produits pendant le traitement asynchrone. Recherchez la ou les exceptions réelles dans InnerExceptions

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
400	BadRequest : cela signifie qu’un problème s’est produit avec la demande fournie. Il est probable qu’un ID n’a pas été fourni pour la nouvelle fonction définie par l’utilisateur ou que le corps a été mal formé.
403	Interdit : vous avez atteint votre quota de fonctions définies par l’utilisateur pour la collection fournie. Contactez le support technique pour augmenter ce quota.
409	Conflit : cela signifie qu’un UserDefinedFunction avec un ID correspondant à l’ID que vous avez fourni existait déjà.
413	RequestEntityTooLarge : cela signifie que le corps du que UserDefinedFunction vous avez tenté de créer était trop grand.

Exemples

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

Voir aussi

• UserDefinedFunction
• RequestOptions
• ResourceResponse<TResource>
• Task

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Crée une fonction définie par l’utilisateur en tant qu’opération asychronous dans le service 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>>

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

Paramètres

documentCollectionUri

Uri

URI de la collection de documents dans laquelle créer la fonction définie par l’utilisateur.

function

UserDefinedFunction

Objet UserDefinedFunction.

options

RequestOptions

(Facultatif) RequestOptions pour la demande.

Retours

Task<ResourceResponse<UserDefinedFunction>>

Objet de tâche représentant la réponse du service pour l’opération asynchrone.