IDocumentClient.ReadUserDefinedFunctionAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| ReadUserDefinedFunctionAsync(String, RequestOptions) |
Lee un UserDefinedFunction elemento del servicio Azure Cosmos DB como una operación asincrónica. |
| ReadUserDefinedFunctionAsync(Uri, RequestOptions) |
Lee como UserDefinedFunction una operación asincrónica desde el servicio Azure Cosmos DB. |
ReadUserDefinedFunctionAsync(String, RequestOptions)
Lee un UserDefinedFunction elemento del servicio Azure Cosmos DB como una operación asincrónica.
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
Vínculo a la función definida por el usuario que se va a leer.
- options
- RequestOptions
(Opcional) Las opciones de solicitud de la solicitud.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource>UserDefinedFunction objeto que contiene el registro de recursos de lectura.
Excepciones
Si functionLink no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
En el ejemplo que se muestra se usan vínculos basados en identificadores, donde el vínculo se compone de las propiedades de identificador usadas cuando se crearon los recursos. Si lo prefiere, puede usar la SelfLink propiedad de la función definida por el usuario. Un vínculo propio es un URI para un recurso que se compone de identificadores de recursos (o las propiedades _rid). Los vínculos basados en identificadores y SelfLink funcionarán. El formato de functionLink siempre es "/dbs/{db identifier}/colls/{coll identifier}/udfs/{udf identifier}" solo cambian los valores del {...} en función del método que desee usar para abordar el recurso.
Consulte también
Se aplica a
ReadUserDefinedFunctionAsync(Uri, RequestOptions)
Lee como UserDefinedFunction una operación asincrónica desde el servicio 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
Un URI para el recurso función definida por el usuario que se va a leer.
- options
- RequestOptions
Las opciones de solicitud de la solicitud.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource>UserDefinedFunction objeto que contiene el registro de recursos de lectura.
Excepciones
Si functionUri no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//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);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
Consulte también
Se aplica a
Azure SDK for .NET
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de