CosmosScripts.ReadUserDefinedFunctionAsync Método

Definição

Namespace:

Azure.Cosmos.Scripts

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

Lê um UserDefinedFunctionProperties do serviço do Azure Cosmos DB como uma operação assíncrona.

public abstract System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>> ReadUserDefinedFunctionAsync(string id, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadUserDefinedFunctionAsync : string * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Cosmos.Scripts.UserDefinedFunctionProperties>>

Public MustOverride Function ReadUserDefinedFunctionAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of UserDefinedFunctionProperties))

Parâmetros

id

String

A ID da função definida pelo usuário a ser lida

requestOptions

RequestOptions

(Opcional) As opções para a solicitação de função definida pelo usuário RequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<Response<UserDefinedFunctionProperties>>

Um Task que contém um Response<T> que encapsula um UserDefinedFunctionProperties que contém o registro de recurso de leitura.

Exceções

CosmosException

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:

StatusCode	Motivo da exceção
404	NotFound - Isso significa que o recurso que você tentou ler não existia.
429	TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação.

Exemplos

Isso lê uma função definida pelo usuário existente.

CosmosScripts scripts = this.container.Scripts;
Response<UserDefinedFunctionProperties> response = await scripts.ReadUserDefinedFunctionAsync("ExistingId");
UserDefinedFunctionProperties udfProperties = response;