Scripts.ReadTriggerAsync(String, RequestOptions, CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Cosmos.Scripts

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

Scripts.cs

Reads a TriggerProperties from the Azure Cosmos service as an asynchronous operation.

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)

Parameters

id

String

The id of the trigger to read.

requestOptions

RequestOptions

(Optional) The options for the trigger request.

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<TriggerResponse>

A Task containing a TriggerResponse which wraps a TriggerProperties containing the read resource record.

Exceptions

CosmosException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:

StatusCode	Reason for exception
429	TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation.

Examples

This reads an existing trigger

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