EventGridClient class

Event Grid-naamruimtenclient

Constructors

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Azure Messaging EventGrid-client

Methoden

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

De batch cloudgebeurtenissen bevestigen. De server reageert met een HTTP 200-statuscode als ten minste één gebeurtenis is bevestigd. De antwoordtekst bevat de set geslaagde lockTokens, samen met andere mislukte lockTokens met de bijbehorende foutinformatie. Geslaagde gebeurtenissen zijn niet meer beschikbaar voor elke consument.

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

Publiceer één cloudgebeurtenis naar naamruimteonderwerp. Als het lukt, reageert de server met een HTTP 200-statuscode met een leeg JSON-object als antwoord. Anders kan de server verschillende foutcodes retourneren. Bijvoorbeeld 401: wat aangeeft dat de autorisatie is mislukt, 403: wat aangeeft dat het quotum is overschreden of dat het bericht te groot is, 410: wat aangeeft dat specifiek onderwerp niet wordt gevonden, 400: voor ongeldige aanvragen en 500: voor interne serverfout.

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

Batch Cloud Event publiceren naar naamruimteonderwerp. Als het lukt, reageert de server met een HTTP 200-statuscode met een leeg JSON-object als antwoord. Anders kan de server verschillende foutcodes retourneren. Bijvoorbeeld 401: wat aangeeft dat de autorisatie is mislukt, 403: wat aangeeft dat het quotum is overschreden of dat het bericht te groot is, 410: wat aangeeft dat specifiek onderwerp niet wordt gevonden, 400: voor ongeldige aanvragen en 500: voor interne serverfout.

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Ontvang batch cloudgebeurtenissen van het gebeurtenisabonnement.

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

Batch cloudgebeurtenissen weigeren.

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

Releasebatch van cloudgebeurtenissen. De server reageert met een HTTP 200-statuscode als ten minste één gebeurtenis is vrijgegeven. De hoofdtekst van het antwoord bevat de set met geslaagde vrijgegeven lockTokens, samen met andere mislukte lockTokens met de bijbehorende foutinformatie.

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

Verleng de vergrendeling voor batch cloudgebeurtenissen.

Constructordetails

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

Azure Messaging EventGrid-client

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

Parameters

endpoint

string

Methodedetails

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

De batch cloudgebeurtenissen bevestigen. De server reageert met een HTTP 200-statuscode als ten minste één gebeurtenis is bevestigd. De antwoordtekst bevat de set geslaagde lockTokens, samen met andere mislukte lockTokens met de bijbehorende foutinformatie. Geslaagde gebeurtenissen zijn niet meer beschikbaar voor elke consument.

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

Parameters

lockTokens

string[]

Tokens vergrendelen

topicName

string

Naam van het onderwerp

eventSubscriptionName

string

Naam van het evenement Abonnement

options
AcknowledgeCloudEventsOptions

Opties om te bevestigen

Retouren

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

Publiceer één cloudgebeurtenis naar naamruimteonderwerp. Als het lukt, reageert de server met een HTTP 200-statuscode met een leeg JSON-object als antwoord. Anders kan de server verschillende foutcodes retourneren. Bijvoorbeeld 401: wat aangeeft dat de autorisatie is mislukt, 403: wat aangeeft dat het quotum is overschreden of dat het bericht te groot is, 410: wat aangeeft dat specifiek onderwerp niet wordt gevonden, 400: voor ongeldige aanvragen en 500: voor interne serverfout.

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

Parameters

event

CloudEvent<T>

Evenement om te publiceren

topicName

string

Onderwerp om het evenement te publiceren

options
PublishCloudEventOptions

Opties voor publiceren

Retouren

Promise<void>

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

Batch Cloud Event publiceren naar naamruimteonderwerp. Als het lukt, reageert de server met een HTTP 200-statuscode met een leeg JSON-object als antwoord. Anders kan de server verschillende foutcodes retourneren. Bijvoorbeeld 401: wat aangeeft dat de autorisatie is mislukt, 403: wat aangeeft dat het quotum is overschreden of dat het bericht te groot is, 410: wat aangeeft dat specifiek onderwerp niet wordt gevonden, 400: voor ongeldige aanvragen en 500: voor interne serverfout.

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

Parameters

events

CloudEvent<T>[]

Gebeurtenissen die moeten worden gepubliceerd

topicName

string

Onderwerp om het evenement te publiceren

options
PublishCloudEventsOptions

Opties voor publiceren

Retouren

Promise<void>

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

Ontvang batch cloudgebeurtenissen van het gebeurtenisabonnement.

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

Parameters

topicName

string

Te ontvangen onderwerp

eventSubscriptionName

string

Naam van het evenement Abonnement

options
ReceiveCloudEventsOptions

Opties voor ontvangst

Retouren

Promise<ReceiveResult>

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

Batch cloudgebeurtenissen weigeren.

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

Parameters

lockTokens

string[]

Tokens vergrendelen

topicName

string

Naam van het onderwerp

eventSubscriptionName

string

Naam van het evenement Abonnement

options
RejectCloudEventsOptions

Opties om af te wijzen

Retouren

Promise<RejectResult>

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

Releasebatch van cloudgebeurtenissen. De server reageert met een HTTP 200-statuscode als ten minste één gebeurtenis is vrijgegeven. De hoofdtekst van het antwoord bevat de set met geslaagde vrijgegeven lockTokens, samen met andere mislukte lockTokens met de bijbehorende foutinformatie.

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

Parameters

lockTokens

string[]

Tokens vergrendelen

topicName

string

Naam van het onderwerp

eventSubscriptionName

string

Naam van het evenement Abonnement

options
ReleaseCloudEventsOptions

Opties om vrij te geven

Retouren

Promise<ReleaseResult>

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

Verleng de vergrendeling voor batch cloudgebeurtenissen.

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

Parameters

lockTokens

string[]

Tokens vergrendelen

topicName

string

Naam van het onderwerp

eventSubscriptionName

string

Naam van het evenement Abonnement

options
RenewCloudEventLocksOptions

Opties om te verlengen

Retouren