DocumentClient.ReadUserDefinedFunctionAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| ReadUserDefinedFunctionAsync(String, RequestOptions) |
Lit un UserDefinedFunction à partir du service Azure Cosmos DB en tant qu’opération asynchrone. |
| ReadUserDefinedFunctionAsync(Uri, RequestOptions) |
Lit un UserDefinedFunction en tant qu’opération asynchrone à partir du service Azure Cosmos DB. |
ReadUserDefinedFunctionAsync(String, RequestOptions)
Lit un UserDefinedFunction à partir du service Azure Cosmos DB en tant qu’opération asynchrone.
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>>
override this.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))Paramètres
- functionLink
- String
Lien vers la fonction définie par l’utilisateur à lire.
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un UserDefinedFunction contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si functionLink n’est pas défini.
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 |
|---|---|
| 404 | NotFound : cela signifie que la ressource que vous avez tenté de lire n’existait pas. |
| 429 | TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération. |
Exemples
//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);
Remarques
La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.
L’exemple présenté utilise des liens basés sur l’ID, où le lien est composé des propriétés d’ID utilisées lors de la création des ressources. Vous pouvez toujours utiliser la SelfLink propriété de la fonction définie par l’utilisateur si vous préférez. Un lien automatique est un URI pour une ressource composée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous les deux. Le format pour functionLink est toujours « /dbs/{identificateur de base de données}/colls/{identificateur coll}/udfs/{identificateur udf} » uniquement les valeurs dans le {...} changent en fonction de la méthode que vous souhaitez utiliser pour traiter la ressource.
Voir aussi
S’applique à
ReadUserDefinedFunctionAsync(Uri, RequestOptions)
Lit un UserDefinedFunction en tant qu’opération asynchrone à partir du service 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>>
override this.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))Paramètres
- functionUri
- Uri
URI de la ressource fonction définie par l’utilisateur à lire.
- options
- RequestOptions
Options de demande pour la demande.
Retours
System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un UserDefinedFunction contenant l’enregistrement de ressource de lecture.
Implémente
Exceptions
Si functionUri n’est pas défini.
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 |
|---|---|
| 404 | NotFound : cela signifie que la ressource que vous avez tenté de lire n’existait pas. |
| 429 | TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération. |
Exemples
//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);
Remarques
La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource auprès du service. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.
Voir aussi
S’applique à
Azure SDK for .NET
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour