EventGridReceiverClient class
Cliente de namespaces de grade de eventos
Construtores
Event |
Azure Messaging EventGrid Client |
Métodos
acknowledge |
Reconheça o lote de eventos na nuvem. O servidor responde com um código de status HTTP 200 se pelo menos um evento for reconhecido com êxito. O corpo da resposta incluirá o conjunto de lockTokens reconhecidos com êxito, juntamente com outros lockTokens com falha com suas informações de erro correspondentes. Eventos reconhecidos com sucesso não estarão mais disponíveis para nenhum consumidor. |
receive |
Receba o lote de eventos na nuvem a partir da assinatura do evento. |
reject |
Rejeitar lote de Cloud Events. |
release |
Libere o lote de Cloud Events. O servidor responde com um código de status HTTP 200 se pelo menos um evento for liberado com êxito. O corpo da resposta incluirá o conjunto de lockTokens lançados com sucesso, juntamente com outros lockTokens com falha com suas informações de erro correspondentes. |
renew |
Renove o bloqueio para o lote de Cloud Events. |
Detalhes do Construtor
EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)
Azure Messaging EventGrid Client
new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)
Parâmetros
- endpoint
-
string
- credential
- topicName
-
string
- subscriptionName
-
string
- options
- EventGridReceiverClientOptions
Detalhes de Método
acknowledgeEvents(string[], AcknowledgeEventsOptions)
Reconheça o lote de eventos na nuvem. O servidor responde com um código de status HTTP 200 se pelo menos um evento for reconhecido com êxito. O corpo da resposta incluirá o conjunto de lockTokens reconhecidos com êxito, juntamente com outros lockTokens com falha com suas informações de erro correspondentes. Eventos reconhecidos com sucesso não estarão mais disponíveis para nenhum consumidor.
function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>
Parâmetros
- lockTokens
-
string[]
Tokens de bloqueio
- options
- AcknowledgeEventsOptions
Opções a Reconhecer
Devoluções
Promise<AcknowledgeResult>
receiveEvents<T>(ReceiveEventsOptions)
Receba o lote de eventos na nuvem a partir da assinatura do evento.
function receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>
Parâmetros
- options
- ReceiveEventsOptions
Opções para receber
Devoluções
Promise<ReceiveResult<T>>
rejectEvents(string[], RejectEventsOptions)
Rejeitar lote de Cloud Events.
function rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>
Parâmetros
- lockTokens
-
string[]
Tokens de bloqueio
- options
- RejectEventsOptions
Opções de rejeição
Devoluções
Promise<RejectResult>
releaseEvents(string[], ReleaseEventsOptions)
Libere o lote de Cloud Events. O servidor responde com um código de status HTTP 200 se pelo menos um evento for liberado com êxito. O corpo da resposta incluirá o conjunto de lockTokens lançados com sucesso, juntamente com outros lockTokens com falha com suas informações de erro correspondentes.
function releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>
Parâmetros
- lockTokens
-
string[]
Tokens de bloqueio
- options
- ReleaseEventsOptions
Opções de lançamento
Devoluções
Promise<ReleaseResult>
renewEventLocks(string[], RenewEventLocksOptions)
Renove o bloqueio para o lote de Cloud Events.
function renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>
Parâmetros
- lockTokens
-
string[]
Tokens de bloqueio
- options
- RenewEventLocksOptions
Opções para renovar
Devoluções
Promise<RenewLocksResult>