Partager via


DocumentClient.ReadTriggerAsync Méthode

Définition

Surcharges

ReadTriggerAsync(String, RequestOptions)

Lit un Trigger à partir du service Azure Cosmos DB en tant qu’opération asynchrone.

ReadTriggerAsync(Uri, RequestOptions)

Lit un Trigger en tant qu’opération asynchrone à partir du service Azure Cosmos DB.

ReadTriggerAsync(String, RequestOptions)

Lit un Trigger à 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.Trigger>> ReadTriggerAsync (string triggerLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadTriggerAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
Public Function ReadTriggerAsync (triggerLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

Paramètres

triggerLink
String

Lien vers le déclencheur à lire.

options
RequestOptions

(Facultatif) Options de demande pour la demande.

Retours

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Trigger contenant l’enregistrement de ressource de lecture.

Implémente

Exceptions

Si triggerLink 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 :

StatusCodeRaison de l’exception
404NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//Reads a Trigger from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - trigger_id is the ID of the trigger to be read
var triggerLink = "/dbs/sample_database/colls/sample_collection/triggers/trigger_id";
Trigger trigger = await client.ReadTriggerAsync(triggerLink);

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 ci-dessous 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é du déclencheur si vous le souhaitez. Un lien automatique est un URI pour une ressource constituée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous deux. Le format pour triggerLink est toujours « /dbs/{db identifier}/colls/{coll identifier}/triggers/{trigger identifier} », seules les valeurs dans le {...} changent en fonction de la méthode que vous souhaitez utiliser pour traiter la ressource.

Voir aussi

S’applique à

ReadTriggerAsync(Uri, RequestOptions)

Lit un Trigger 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.Trigger>> ReadTriggerAsync (Uri triggerUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadTriggerAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
override this.ReadTriggerAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>>
Public Function ReadTriggerAsync (triggerUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Trigger))

Paramètres

triggerUri
Uri

URI de la ressource Déclencheur à lire.

options
RequestOptions

Options de demande pour la demande.

Retours

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Trigger contenant l’enregistrement de ressource de lecture.

Implémente

Exceptions

Si triggerUri 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 :

StatusCodeRaison de l’exception
404NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//Reads a Trigger resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - trigger_id is the ID property of the Trigger you wish to read. 
var triggerLink = UriFactory.CreateTriggerUri("db_id", "coll_id", "trigger_id");
Trigger trigger = await client.ReadTriggerAsync(triggerLink);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir 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 à