EventGridClient class

Client d’espaces de noms Event Grid

Constructeurs

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Client EventGrid de messagerie Azure

Méthodes

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

Reconnaître le lot d’événements cloud. Le serveur répond avec un code d’état HTTP 200 si au moins un événement est reconnu avec succès. Le corps de la réponse inclut l’ensemble de lockTokens reconnus avec succès, ainsi que d’autres lockTokens ayant échoué avec leurs informations d’erreur correspondantes. Les événements reconnus avec succès ne seront plus disponibles pour tout consommateur.

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

Sujet Publier un événement de cloud unique dans l’espace de noms. En cas de réussite, le serveur répond avec un code d’état HTTP 200 avec un objet JSON vide en réponse. Sinon, le serveur peut retourner différents codes d’erreur. Par exemple, 401 : qui indique l’échec d’autorisation, 403 : qui indique que le quota dépassé ou le message est trop volumineux, 410 : ce qui indique que la rubrique spécifique est introuvable, 400 : pour une demande incorrecte et 500 : pour une erreur de serveur interne.

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

Sujet Publier l’événement Batch Cloud dans l’espace de noms. En cas de réussite, le serveur répond avec un code d’état HTTP 200 avec un objet JSON vide en réponse. Sinon, le serveur peut retourner différents codes d’erreur. Par exemple, 401 : qui indique l’échec d’autorisation, 403 : qui indique que le quota dépassé ou le message est trop volumineux, 410 : ce qui indique que la rubrique spécifique est introuvable, 400 : pour une demande incorrecte et 500 : pour une erreur de serveur interne.

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Recevez le lot d’événements cloud à partir de l’abonnement aux événements.

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

Rejeter le lot d’événements cloud.

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

Lot de mise en production d’événements cloud. Le serveur répond avec un code d’état HTTP 200 si au moins un événement est correctement publié. Le corps de la réponse inclut l’ensemble de lockTokens libérés avec succès, ainsi que d’autres lockTokens ayant échoué avec leurs informations d’erreur correspondantes.

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

Renouveler le verrou pour le lot d’événements cloud.

Détails du constructeur

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Client EventGrid de messagerie Azure

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

Paramètres

endpoint

string

Détails de la méthode

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

Reconnaître le lot d’événements cloud. Le serveur répond avec un code d’état HTTP 200 si au moins un événement est reconnu avec succès. Le corps de la réponse inclut l’ensemble de lockTokens reconnus avec succès, ainsi que d’autres lockTokens ayant échoué avec leurs informations d’erreur correspondantes. Les événements reconnus avec succès ne seront plus disponibles pour tout consommateur.

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

Paramètres

lockTokens

string[]

Jetons de verrouillage

topicName

string

Nom du sujet

eventSubscriptionName

string

Nom de l’abonnement à l’événement

options
AcknowledgeCloudEventsOptions

Options de accusé de réception

Retours

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

Sujet Publier un événement de cloud unique dans l’espace de noms. En cas de réussite, le serveur répond avec un code d’état HTTP 200 avec un objet JSON vide en réponse. Sinon, le serveur peut retourner différents codes d’erreur. Par exemple, 401 : qui indique l’échec d’autorisation, 403 : qui indique que le quota dépassé ou le message est trop volumineux, 410 : ce qui indique que la rubrique spécifique est introuvable, 400 : pour une demande incorrecte et 500 : pour une erreur de serveur interne.

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

Paramètres

event

CloudEvent<T>

Événement à publier

topicName

string

Sujet de publication de l’événement

options
PublishCloudEventOptions

Options de publication

Retours

Promise<void>

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

Sujet Publier l’événement Batch Cloud dans l’espace de noms. En cas de réussite, le serveur répond avec un code d’état HTTP 200 avec un objet JSON vide en réponse. Sinon, le serveur peut retourner différents codes d’erreur. Par exemple, 401 : qui indique l’échec d’autorisation, 403 : qui indique que le quota dépassé ou le message est trop volumineux, 410 : ce qui indique que la rubrique spécifique est introuvable, 400 : pour une demande incorrecte et 500 : pour une erreur de serveur interne.

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

Paramètres

events

CloudEvent<T>[]

Événements à publier

topicName

string

Sujet de publication de l’événement

options
PublishCloudEventsOptions

Options de publication

Retours

Promise<void>

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Recevez le lot d’événements cloud à partir de l’abonnement aux événements.

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

Paramètres

topicName

string

Sujet à recevoir

eventSubscriptionName

string

Nom de l’abonnement à l’événement

options
ReceiveCloudEventsOptions

Options de réception

Retours

Promise<ReceiveResult>

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

Rejeter le lot d’événements cloud.

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

Paramètres

lockTokens

string[]

Jetons de verrouillage

topicName

string

Nom du sujet

eventSubscriptionName

string

Nom de l’abonnement à l’événement

options
RejectCloudEventsOptions

Options à rejeter

Retours

Promise<RejectResult>

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

Lot de mise en production d’événements cloud. Le serveur répond avec un code d’état HTTP 200 si au moins un événement est correctement publié. Le corps de la réponse inclut l’ensemble de lockTokens libérés avec succès, ainsi que d’autres lockTokens ayant échoué avec leurs informations d’erreur correspondantes.

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

Paramètres

lockTokens

string[]

Jetons de verrouillage

topicName

string

Nom du sujet

eventSubscriptionName

string

Nom de l’abonnement à l’événement

options
ReleaseCloudEventsOptions

Options de mise en production

Retours

Promise<ReleaseResult>

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

Renouveler le verrou pour le lot d’événements cloud.

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

Paramètres

lockTokens

string[]

Jetons de verrouillage

topicName

string

Nom du sujet

eventSubscriptionName

string

Nom de l’abonnement à l’événement

options
RenewCloudEventLocksOptions

Options de renouvellement

Retours