CosmosScripts.ReadTriggerAsync Método

Definição

Namespace:

Azure.Cosmos.Scripts

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

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

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

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

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

Parâmetros

id

String

A ID do gatilho a ser lido.

requestOptions

RequestOptions

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

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<Response<TriggerProperties>>

Um Task que contém um Response<T> que encapsula um TriggerProperties que contém o registro de recurso de leitura.

Exceções

CosmosException

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:

StatusCode	Motivo da exceção
429	TooManyRequests - 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

Isso lê um gatilho existente

CosmosScripts scripts = this.container.Scripts;
Response<TriggerProperties> response = await scripts.ReadTriggerAsync("ExistingId");
TriggerProperties triggerProperties = response;