DocumentClient.ReadTriggerAsync Método

Definição

Sobrecargas

ReadTriggerAsync(String, RequestOptions)

Lê um Trigger do serviço do Azure Cosmos DB como uma operação assíncrona.

ReadTriggerAsync(Uri, RequestOptions)

Lê um Trigger como uma operação assíncrona do serviço do Azure Cosmos DB.

ReadTriggerAsync(String, RequestOptions)

Lê um Trigger do serviço do Azure Cosmos DB como uma operação assíncrona.

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

Parâmetros

triggerLink
String

O link para o Gatilho a ser lido.

options
RequestOptions

(Opcional) As opções de solicitação para a solicitação.

Retornos

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Trigger que contém o registro de recurso de leitura.

Implementações

Exceções

Se triggerLink não estiver definido.

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:

StatusCodeMotivo da exceção
404NotFound - Isso significa que o recurso que você tentou ler não existia.
429TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação.

Exemplos

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

Comentários

Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do Banco de Dados. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.

O exemplo mostrado usa links baseados em ID, em que o link é composto pelas propriedades de ID usadas quando os recursos foram criados. Você ainda pode usar a SelfLink propriedade do Gatilho, se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recursos (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para triggerLink é sempre "/dbs/{db identifier}/colls/{coll identifier}/triggers/{trigger identifier}" somente os valores dentro da alteração {...} dependendo de qual método você deseja usar para endereçar o recurso.

Confira também

Aplica-se a

ReadTriggerAsync(Uri, RequestOptions)

Lê um Trigger como uma operação assíncrona do serviço do 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))

Parâmetros

triggerUri
Uri

Um URI para o recurso Gatilho a ser lido.

options
RequestOptions

As opções de solicitação para a solicitação.

Retornos

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Trigger que contém o registro de recurso de leitura.

Implementações

Exceções

Se triggerUri não estiver definido.

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:

StatusCodeMotivo da exceção
404NotFound - Isso significa que o recurso que você tentou ler não existia.
429TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação.

Exemplos

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

Comentários

Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do serviço. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.

Confira também

Aplica-se a