IDocumentClient.ReadTriggerAsync Method

Definition

Overloads

ReadTriggerAsync(String, RequestOptions)

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

ReadTriggerAsync(Uri, RequestOptions)

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

ReadTriggerAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerAsync (string triggerLink, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member 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 = null) As Task(Of ResourceResponse(Of Trigger))

Parameters

triggerLink
String

The link to the Trigger to be read.

options
RequestOptions

(Optional) The request options for the request.

Returns

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a Trigger containing the read resource record.

Exceptions

If triggerLink is not set.

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:

StatusCodeReason for exception
404NotFound - This means the resource you tried to read did not exist.
429TooManyRequests - 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


  //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);

Remarks

Doing a read of a resource is the most efficient way to get a resource from the Database. If you know the resource's ID, do a read instead of a query by ID.

The example shown uses ID-based links, where the link is composed of the ID properties used when the resources were created. You can still use the SelfLink property of the Trigger if you prefer. A self-link is a URI for a resource that is made up of Resource Identifiers (or the _rid properties). ID-based links and SelfLink will both work. The format for triggerLink is always "/dbs/{db identifier}/colls/{coll identifier}/triggers/{trigger identifier}" only the values within the {...} change depending on which method you wish to use to address the resource.

See also

ReadTriggerAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Trigger>> ReadTriggerAsync (Uri triggerUri, Microsoft.Azure.Documents.Client.RequestOptions options = null);
abstract member 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 = null) As Task(Of ResourceResponse(Of Trigger))

Parameters

triggerUri
Uri

A URI to the Trigger resource to be read.

options
RequestOptions

The request options for the request.

Returns

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a Trigger containing the read resource record.

Exceptions

If triggerUri is not set.

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:

StatusCodeReason for exception
404NotFound - This means the resource you tried to read did not exist.
429TooManyRequests - 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


  //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);

Remarks

Doing a read of a resource is the most efficient way to get a resource from the service. If you know the resource's ID, do a read instead of a query by ID.

See also

Applies to