EventGridReceiverClient class

Paket:

@azure/eventgrid-namespaces

Event Grid-namnområdesklient

Konstruktorer

EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)

Azure Messaging EventGrid-klient

Metoder

acknowledgeEvents(string[], AcknowledgeEventsOptions)	Bekräfta batch med molnhändelser. Servern svarar med en HTTP 200-statuskod om minst en händelse har bekräftats. Svarstexten innehåller uppsättningen med bekräftad lockTokens tillsammans med andra misslyckade lockTokens med motsvarande felinformation. Bekräftade händelser kommer inte längre att vara tillgängliga för någon konsument.
receiveEvents<T>(ReceiveEventsOptions)	Ta emot batch med molnhändelser från händelseprenumerationen.
rejectEvents(string[], RejectEventsOptions)	Avvisa batch med molnhändelser.
releaseEvents(string[], ReleaseEventsOptions)	Versionsbatch med molnhändelser. Servern svarar med en HTTP 200-statuskod om minst en händelse har släppts. Svarstexten innehåller uppsättningen med frisläppta lockTokens, tillsammans med andra misslyckade lockTokens med motsvarande felinformation.
renewEventLocks(string[], RenewEventLocksOptions)	Förnya låset för batch med molnhändelser.

Konstruktorinformation

EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)

Azure Messaging EventGrid-klient

new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)

Parametrar

endpoint

string

credential

AzureKeyCredential | TokenCredential

topicName

string

subscriptionName

string

options

EventGridReceiverClientOptions

Metodinformation

acknowledgeEvents(string[], AcknowledgeEventsOptions)

Bekräfta batch med molnhändelser. Servern svarar med en HTTP 200-statuskod om minst en händelse har bekräftats. Svarstexten innehåller uppsättningen med bekräftad lockTokens tillsammans med andra misslyckade lockTokens med motsvarande felinformation. Bekräftade händelser kommer inte längre att vara tillgängliga för någon konsument.

function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>

Parametrar

lockTokens

string[]

Lås token

options

AcknowledgeEventsOptions

Alternativ för bekräftelse

Returer

Promise<AcknowledgeResult>

receiveEvents<T>(ReceiveEventsOptions)

Ta emot batch med molnhändelser från händelseprenumerationen.

function receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>

Parametrar

options

ReceiveEventsOptions

Alternativ för att ta emot

Returer

Promise<ReceiveResult<T>>

rejectEvents(string[], RejectEventsOptions)

Avvisa batch med molnhändelser.

function rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>

Parametrar

lockTokens

string[]

Lås token

options

RejectEventsOptions

Alternativ för att avvisa

Returer

Promise<RejectResult>

releaseEvents(string[], ReleaseEventsOptions)

Versionsbatch med molnhändelser. Servern svarar med en HTTP 200-statuskod om minst en händelse har släppts. Svarstexten innehåller uppsättningen med frisläppta lockTokens, tillsammans med andra misslyckade lockTokens med motsvarande felinformation.

function releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>

Parametrar

lockTokens

string[]

Lås token

options

ReleaseEventsOptions

Alternativ för att släppa

Returer

Promise<ReleaseResult>

renewEventLocks(string[], RenewEventLocksOptions)

Förnya låset för batch med molnhändelser.

function renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>

Parametrar

lockTokens

string[]

Lås token

options

RenewEventLocksOptions

Alternativ för att förnya

Returer

Promise<RenewLocksResult>