EventGridClient class

Cliente de espacios de nombres de Event Grid

Constructores

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Cliente eventGrid de mensajería de Azure

Métodos

acknowledgeCloudEvents(string[], string, string, AcknowledgeCloudEventsOptions)

Confirme el lote de eventos en la nube. El servidor responde con un código de estado HTTP 200 si se confirma correctamente al menos un evento. El cuerpo de la respuesta incluirá el conjunto de lockTokens confirmados correctamente, junto con otros lockTokens con errores con su información de error correspondiente. Los eventos confirmados correctamente ya no estarán disponibles para ningún consumidor.

publishCloudEvent<T>(CloudEvent<T>, string, PublishCloudEventOptions)

Tema Publicar evento de nube única en el espacio de nombres. En caso de éxito, el servidor responde con un código de estado HTTP 200 con un objeto JSON vacío en respuesta. De lo contrario, el servidor puede devolver varios códigos de error. Por ejemplo, 401: que indica un error de autorización, 403: que indica que la cuota superada o el mensaje es demasiado grande, 410: lo que indica que no se encuentra un tema específico, 400: para una solicitud incorrecta y 500: para el error interno del servidor.

publishCloudEvents<T>(CloudEvent<T>[], string, PublishCloudEventsOptions)

Tema Publicar evento de nube de Batch en el espacio de nombres. En caso de éxito, el servidor responde con un código de estado HTTP 200 con un objeto JSON vacío en respuesta. De lo contrario, el servidor puede devolver varios códigos de error. Por ejemplo, 401: que indica un error de autorización, 403: que indica que la cuota superada o el mensaje es demasiado grande, 410: lo que indica que no se encuentra un tema específico, 400: para una solicitud incorrecta y 500: para el error interno del servidor.

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Reciba batch of Cloud Events de la suscripción de eventos.

rejectCloudEvents(string[], string, string, RejectCloudEventsOptions)

Rechazar el lote de eventos en la nube.

releaseCloudEvents(string[], string, string, ReleaseCloudEventsOptions)

Lanzamiento por lotes de Eventos en la nube. El servidor responde con un código de estado HTTP 200 si se libera correctamente al menos un evento. El cuerpo de la respuesta incluirá el conjunto de lockTokens liberados correctamente, junto con otros lockTokens con errores con su información de error correspondiente.

renewCloudEventLocks(string[], string, string, RenewCloudEventLocksOptions)

Renueve el bloqueo para el lote de Eventos en la nube.

Detalles del constructor

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Cliente eventGrid de mensajería de Azure

new EventGridClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, options?: EventGridClientOptions)

Parámetros

endpoint

string

Detalles del método

acknowledgeCloudEvents(string[], string, string, AcknowledgeCloudEventsOptions)

Confirme el lote de eventos en la nube. El servidor responde con un código de estado HTTP 200 si se confirma correctamente al menos un evento. El cuerpo de la respuesta incluirá el conjunto de lockTokens confirmados correctamente, junto con otros lockTokens con errores con su información de error correspondiente. Los eventos confirmados correctamente ya no estarán disponibles para ningún consumidor.

function acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>

Parámetros

lockTokens

string[]

Tokens de bloqueo

topicName

string

Nombre del tema

eventSubscriptionName

string

Nombre de la suscripción al evento

options
AcknowledgeCloudEventsOptions

Opciones para confirmar

Devoluciones

publishCloudEvent<T>(CloudEvent<T>, string, PublishCloudEventOptions)

Tema Publicar evento de nube única en el espacio de nombres. En caso de éxito, el servidor responde con un código de estado HTTP 200 con un objeto JSON vacío en respuesta. De lo contrario, el servidor puede devolver varios códigos de error. Por ejemplo, 401: que indica un error de autorización, 403: que indica que la cuota superada o el mensaje es demasiado grande, 410: lo que indica que no se encuentra un tema específico, 400: para una solicitud incorrecta y 500: para el error interno del servidor.

function publishCloudEvent<T>(event: CloudEvent<T>, topicName: string, options?: PublishCloudEventOptions): Promise<void>

Parámetros

event

CloudEvent<T>

Evento a publicar

topicName

string

Tema para publicar el evento

options
PublishCloudEventOptions

Opciones para publicar

Devoluciones

Promise<void>

publishCloudEvents<T>(CloudEvent<T>[], string, PublishCloudEventsOptions)

Tema Publicar evento de nube de Batch en el espacio de nombres. En caso de éxito, el servidor responde con un código de estado HTTP 200 con un objeto JSON vacío en respuesta. De lo contrario, el servidor puede devolver varios códigos de error. Por ejemplo, 401: que indica un error de autorización, 403: que indica que la cuota superada o el mensaje es demasiado grande, 410: lo que indica que no se encuentra un tema específico, 400: para una solicitud incorrecta y 500: para el error interno del servidor.

function publishCloudEvents<T>(events: CloudEvent<T>[], topicName: string, options?: PublishCloudEventsOptions): Promise<void>

Parámetros

events

CloudEvent<T>[]

Eventos que se van a publicar

topicName

string

Tema para publicar el evento

options
PublishCloudEventsOptions

Opciones para publicar

Devoluciones

Promise<void>

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Reciba batch of Cloud Events de la suscripción de eventos.

function receiveCloudEvents(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult>

Parámetros

topicName

string

Tema a recibir

eventSubscriptionName

string

Nombre de la suscripción al evento

options
ReceiveCloudEventsOptions

Opciones para recibir

Devoluciones

Promise<ReceiveResult>

rejectCloudEvents(string[], string, string, RejectCloudEventsOptions)

Rechazar el lote de eventos en la nube.

function rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>

Parámetros

lockTokens

string[]

Tokens de bloqueo

topicName

string

Nombre del tema

eventSubscriptionName

string

Nombre de la suscripción al evento

options
RejectCloudEventsOptions

Opciones para rechazar

Devoluciones

Promise<RejectResult>

releaseCloudEvents(string[], string, string, ReleaseCloudEventsOptions)

Lanzamiento por lotes de Eventos en la nube. El servidor responde con un código de estado HTTP 200 si se libera correctamente al menos un evento. El cuerpo de la respuesta incluirá el conjunto de lockTokens liberados correctamente, junto con otros lockTokens con errores con su información de error correspondiente.

function releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>

Parámetros

lockTokens

string[]

Tokens de bloqueo

topicName

string

Nombre del tema

eventSubscriptionName

string

Nombre de la suscripción al evento

options
ReleaseCloudEventsOptions

Opciones para liberar

Devoluciones

Promise<ReleaseResult>

renewCloudEventLocks(string[], string, string, RenewCloudEventLocksOptions)

Renueve el bloqueo para el lote de Eventos en la nube.

function renewCloudEventLocks(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RenewCloudEventLocksOptions): Promise<RenewCloudEventLocksResult>

Parámetros

lockTokens

string[]

Tokens de bloqueo

topicName

string

Nombre del tema

eventSubscriptionName

string

Nombre de la suscripción al evento

options
RenewCloudEventLocksOptions

Opciones para renovar

Devoluciones