Scripts.ReadTriggerAsync(String, RequestOptions, CancellationToken) Méthode

Définition

Espace de noms:

Microsoft.Azure.Cosmos.Scripts

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.39.0

Source:

Scripts.cs

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

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

abstract member ReadTriggerAsync : string * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.TriggerResponse>

Public MustOverride Function ReadTriggerAsync (id As String, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TriggerResponse)

Paramètres

id

String

ID du déclencheur à lire.

requestOptions

RequestOptions

(Facultatif) Options de la demande de déclencheur.

cancellationToken

CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<TriggerResponse>

Task contenant un TriggerResponse qui encapsule un TriggerProperties contenant l’enregistrement de ressource de lecture.

Exceptions

CosmosException

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
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 voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

Ceci lit un déclencheur existant

Scripts scripts = this.container.Scripts;
TriggerResponse response = await scripts.ReadTriggerAsync("ExistingId");
TriggerProperties triggerProperties = response;