IDocumentClient.ReadUserDefinedFunctionAsync Método

Definição

Sobrecargas

ReadUserDefinedFunctionAsync(String, RequestOptions)

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

ReadUserDefinedFunctionAsync(Uri, RequestOptions)

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

ReadUserDefinedFunctionAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (string functionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserDefinedFunctionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function ReadUserDefinedFunctionAsync (functionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

Parâmetros

functionLink
String

O link para a Função Definida pelo Usuário a ser lida.

options
RequestOptions

(Opcional) As opções de solicitação para a solicitação.

Retornos

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um UserDefinedFunction que contém o registro de recurso de leitura.

Exceções

Se functionLink não estiver definido.

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
404NotFound - Isso significa que o recurso que você tentou ler não existia.
429TooManyRequests - 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

//Reads a User Defined Function from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - udf_id is the ID of the user-defined function to be read
var udfLink = "/dbs/sample_database/colls/sample_collection/udfs/udf_id";
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);

Comentários

Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do Banco de Dados. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.

O exemplo mostrado usa links baseados em ID, em que o link é composto pelas propriedades de ID usadas quando os recursos foram criados. Você ainda pode usar a SelfLink propriedade da Função Definida pelo Usuário, se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recursos (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para functionLink é sempre "/dbs/{db identifier}/colls/{coll identifier}/udfs/{udf identifier}" somente os valores dentro da alteração {...} dependendo de qual método você deseja usar para endereçar o recurso.

Confira também

Aplica-se a

ReadUserDefinedFunctionAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionAsync (Uri functionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadUserDefinedFunctionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function ReadUserDefinedFunctionAsync (functionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of UserDefinedFunction))

Parâmetros

functionUri
Uri

Um URI para o recurso função definida pelo usuário a ser lido.

options
RequestOptions

As opções de solicitação para a solicitação.

Retornos

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um UserDefinedFunction que contém o registro de recurso de leitura.

Exceções

Se functionUri não estiver definido.

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
404NotFound - Isso significa que o recurso que você tentou ler não existia.
429TooManyRequests - 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

//Reads a UserDefinedFunction resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - udf_id is the ID property of the UserDefinedFunction you wish to read. 
var udfLink = UriFactory.CreateUserDefinedFunctionUri("db_id", "coll_id", "udf_id");
UserDefinedFunction udf = await client.ReadUserDefinedFunctionAsync(udfLink);

Comentários

Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do serviço. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.

Confira também

Aplica-se a