EventGridClient class

Ereignisrasternamespaces-Client

Konstruktoren

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Azure Messaging EventGrid-Client

Methoden

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

Bestätigen Sie einen Batch von Cloudereignissen. Der Server antwortet mit einem HTTP 200-Statuscode, wenn mindestens ein Ereignis erfolgreich bestätigt wird. Der Antworttext enthält den Satz von erfolgreich bestätigten LockTokens zusammen mit anderen fehlgeschlagenen LockTokens mit den entsprechenden Fehlerinformationen. Erfolgreich erkannte Ereignisse stehen keinem Verbraucher mehr zur Verfügung.

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

Thema Veröffentlichen eines einzelnen Cloud-Ereignisses im Namespace. Bei Erfolg antwortet der Server mit einem HTTP 200-Statuscode mit einem leeren JSON-Objekt als Antwort. Andernfalls kann der Server verschiedene Fehlercodes zurückgeben. Beispiel: 401: Gibt einen Autorisierungsfehler an, 403: Gibt an, dass das Kontingent überschritten wurde oder die Nachricht zu groß ist, 410: Gibt an, dass ein bestimmtes Thema nicht gefunden wird, 400: für ungültige Anforderung und 500: für internen Serverfehler.

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

Thema Veröffentlichen von Batch Cloud-Ereignissen im Namespace. Bei Erfolg antwortet der Server mit einem HTTP 200-Statuscode mit einem leeren JSON-Objekt als Antwort. Andernfalls kann der Server verschiedene Fehlercodes zurückgeben. Beispiel: 401: Gibt einen Autorisierungsfehler an, 403: Gibt an, dass das Kontingent überschritten wurde oder die Nachricht zu groß ist, 410: Gibt an, dass ein bestimmtes Thema nicht gefunden wird, 400: für ungültige Anforderung und 500: für internen Serverfehler.

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Empfangen eines Batches von Cloudereignissen aus dem Ereignisabonnement.

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

Batch von Cloudereignissen ablehnen.

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

Releasebatch von Cloudereignissen. Der Server antwortet mit einem HTTP 200-Statuscode, wenn mindestens ein Ereignis erfolgreich freigegeben wurde. Der Antworttext enthält den Satz von erfolgreich freigegebenen LockTokens zusammen mit anderen fehlgeschlagenen LockTokens mit den entsprechenden Fehlerinformationen.

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

Verlängern sie die Sperre für eine Reihe von Cloudereignissen.

Details zum Konstruktor

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Azure Messaging EventGrid-Client

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

Parameter

endpoint

string

Details zur Methode

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

Bestätigen Sie einen Batch von Cloudereignissen. Der Server antwortet mit einem HTTP 200-Statuscode, wenn mindestens ein Ereignis erfolgreich bestätigt wird. Der Antworttext enthält den Satz von erfolgreich bestätigten LockTokens zusammen mit anderen fehlgeschlagenen LockTokens mit den entsprechenden Fehlerinformationen. Erfolgreich erkannte Ereignisse stehen keinem Verbraucher mehr zur Verfügung.

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

Parameter

lockTokens

string[]

Sperren von Token

topicName

string

Name des Themas

eventSubscriptionName

string

Name des Veranstaltungsabonnements

options
AcknowledgeCloudEventsOptions

Zu bestätigende Optionen

Gibt zurück

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

Thema Veröffentlichen eines einzelnen Cloud-Ereignisses im Namespace. Bei Erfolg antwortet der Server mit einem HTTP 200-Statuscode mit einem leeren JSON-Objekt als Antwort. Andernfalls kann der Server verschiedene Fehlercodes zurückgeben. Beispiel: 401: Gibt einen Autorisierungsfehler an, 403: Gibt an, dass das Kontingent überschritten wurde oder die Nachricht zu groß ist, 410: Gibt an, dass ein bestimmtes Thema nicht gefunden wird, 400: für ungültige Anforderung und 500: für internen Serverfehler.

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

Parameter

event

CloudEvent<T>

Zu veröffentlichendes Ereignis

topicName

string

Thema für die Veröffentlichung des Ereignisses

options
PublishCloudEventOptions

Zu veröffentlichende Optionen

Gibt zurück

Promise<void>

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

Thema Veröffentlichen von Batch Cloud-Ereignissen im Namespace. Bei Erfolg antwortet der Server mit einem HTTP 200-Statuscode mit einem leeren JSON-Objekt als Antwort. Andernfalls kann der Server verschiedene Fehlercodes zurückgeben. Beispiel: 401: Gibt einen Autorisierungsfehler an, 403: Gibt an, dass das Kontingent überschritten wurde oder die Nachricht zu groß ist, 410: Gibt an, dass ein bestimmtes Thema nicht gefunden wird, 400: für ungültige Anforderung und 500: für internen Serverfehler.

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

Parameter

events

CloudEvent<T>[]

Zu veröffentlichende Ereignisse

topicName

string

Thema für die Veröffentlichung des Ereignisses

options
PublishCloudEventsOptions

Zu veröffentlichende Optionen

Gibt zurück

Promise<void>

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Empfangen eines Batches von Cloudereignissen aus dem Ereignisabonnement.

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

Parameter

topicName

string

Zu erhaltendes Thema

eventSubscriptionName

string

Name des Veranstaltungsabonnements

options
ReceiveCloudEventsOptions

Zu empfangende Optionen

Gibt zurück

Promise<ReceiveResult>

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

Batch von Cloudereignissen ablehnen.

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

Parameter

lockTokens

string[]

Sperren von Token

topicName

string

Name des Themas

eventSubscriptionName

string

Name des Veranstaltungsabonnements

options
RejectCloudEventsOptions

Optionen zum Ablehnen

Gibt zurück

Promise<RejectResult>

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

Releasebatch von Cloudereignissen. Der Server antwortet mit einem HTTP 200-Statuscode, wenn mindestens ein Ereignis erfolgreich freigegeben wurde. Der Antworttext enthält den Satz von erfolgreich freigegebenen LockTokens zusammen mit anderen fehlgeschlagenen LockTokens mit den entsprechenden Fehlerinformationen.

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

Parameter

lockTokens

string[]

Sperren von Token

topicName

string

Name des Themas

eventSubscriptionName

string

Name des Veranstaltungsabonnements

options
ReleaseCloudEventsOptions

Optionen für die Freigabe

Gibt zurück

Promise<ReleaseResult>

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

Verlängern sie die Sperre für eine Reihe von Cloudereignissen.

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

Parameter

lockTokens

string[]

Sperren von Token

topicName

string

Name des Themas

eventSubscriptionName

string

Name des Veranstaltungsabonnements

options
RenewCloudEventLocksOptions

Zu verlängernde Optionen

Gibt zurück