IDocumentClient.CreateUserDefinedFunctionAsync Método

  • Referência

Definição

Namespace:
Microsoft.Azure.Documents
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Pacotes:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Sobrecargas

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Cria uma função definida pelo usuário como uma operação assíncrona no serviço do Azure Cosmos DB.
CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Cria uma função definida pelo usuário como uma operação assíncrona no serviço do Azure Cosmos DB.

CreateUserDefinedFunctionAsync(String, UserDefinedFunction, RequestOptions)

Cria uma função definida pelo usuário como uma operação assíncrona no serviço do 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))

Parâmetros

collectionLink
String

O link do DocumentCollection no qual criar a função definida pelo usuário. Por exemplo, dbs/db_rid/colls/col_rid/

function
UserDefinedFunction

O UserDefinedFunction objeto a ser criado.

options
RequestOptions

(Opcional) Qualquer RequestOptionspara essa solicitação.

Retornos

Task<ResourceResponse<UserDefinedFunction>>

Um objeto de tarefa que representa a resposta de serviço para a operação assíncrona.

Exceções

ArgumentNullException

Se ou collectionLinkfunction não estiver definido.

AggregateException

Representa uma consolidação de falhas que ocorreram durante o processamento assíncrono. Procure dentro de InnerExceptions para encontrar as exceções reais

DocumentClientException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:

StatusCodeMotivo da exceção
400BadRequest - Isso significa que algo estava errado com a solicitação fornecida. É provável que uma ID não tenha sido fornecida para a nova função definida pelo usuário ou que o Corpo tenha sido malformado.
403Proibido – você atingiu sua cota de funções definidas pelo usuário para a coleção fornecida. Entre em contato com o suporte para aumentar essa cota.
409Conflito – isso significa que um UserDefinedFunction com uma ID correspondente à ID que você forneceu já existia.
413RequestEntityTooLarge - Isso significa que o corpo do que UserDefinedFunction você tentou criar era muito grande.

Exemplos

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

Confira também

Aplica-se a

CreateUserDefinedFunctionAsync(Uri, UserDefinedFunction, RequestOptions)

Cria uma função definida pelo usuário como uma operação assíncrona no serviço do 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))

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos no qual criar a função definida pelo usuário.

function
UserDefinedFunction

O objeto UserDefinedFunction.

options
RequestOptions

(Opcional) O RequestOptions para a solicitação.

Retornos

Task<ResourceResponse<UserDefinedFunction>>

O objeto de tarefa que representa a resposta de serviço para a operação assíncrona.

Aplica-se a