EventGridClient class

Csomag:

@azure/eventgrid

Event Grid-ügyfél

Konstruktorok

EventGridClient(string, AzureKeyCredential, EventGridClientOptions)

Azure Messaging EventGrid-ügyfél

Metódusok

acknowledgeCloudEvents(string[], string, string, AcknowledgeCloudEventsOptions)	Felhőesemények kötegének nyugtázása. A kiszolgáló HTTP 200 állapotkóddal válaszol, ha legalább egy eseményt sikeresen nyugtáz. A válasz törzse tartalmazza a sikeresen nyugtázható lockTokenek készletét, valamint a többi sikertelen lockTokenst a megfelelő hibainformációkkal együtt. A sikeresen elismert események a továbbiakban nem lesznek elérhetők a felhasználók számára.
publishCloudEvent<T>(CloudEvent<T>, string, PublishCloudEventOptions)	Egyfelhős esemény közzététele névtértémakörben. Sikeresség esetén a kiszolgáló egy HTTP 200 állapotkóddal válaszol, válaszként egy üres JSON-objektummal. Ellenkező esetben a kiszolgáló különböző hibakódokat adhat vissza. Például: 401: amely az engedélyezési hibát jelzi, 403: amely azt jelzi, hogy túllépte a kvótát, vagy az üzenet túl nagy, 410: ami azt jelzi, hogy adott témakör nem található, 400: hibás kérés esetén, és 500: belső kiszolgálóhiba esetén.
publishCloudEvents<T>(CloudEvent<T>[], string, PublishCloudEventsOptions)	Batch Cloud-esemény közzététele a névtér témakörében. Sikeresség esetén a kiszolgáló egy HTTP 200 állapotkóddal válaszol, válaszként egy üres JSON-objektummal. Ellenkező esetben a kiszolgáló különböző hibakódokat adhat vissza. Például: 401: amely az engedélyezési hibát jelzi, 403: amely azt jelzi, hogy túllépte a kvótát, vagy az üzenet túl nagy, 410: ami azt jelzi, hogy adott témakör nem található, 400: hibás kérés esetén, és 500: belső kiszolgálóhiba esetén.
receiveCloudEvents<T>(string, string, ReceiveCloudEventsOptions)	Felhőesemények kötegének fogadása az esemény-előfizetésből.
rejectCloudEvents(string[], string, string, RejectCloudEventsOptions)	A felhőesemények kötegének elvetése.
releaseCloudEvents(string[], string, string, ReleaseCloudEventsOptions)	Felhőesemények kiadási kötegének kiadása. A kiszolgáló HTTP 200 állapotkóddal válaszol, ha legalább egy esemény sikeresen megjelent. A válasz törzse tartalmazza a sikeresen kiadott lockTokens készletet, valamint a többi sikertelen lockTokenst a hozzájuk tartozó hibainformációkkal együtt.
renewCloudEventLocks(string[], string, string, RenewCloudEventLocksOptions)	A felhőesemények kötegének zárolásának megújítása.

Konstruktor adatai

EventGridClient(string, AzureKeyCredential, EventGridClientOptions)

Azure Messaging EventGrid-ügyfél

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

Paraméterek

endpoint

string

credential

AzureKeyCredential

options

EventGridClientOptions

Metódus adatai

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

Felhőesemények kötegének nyugtázása. A kiszolgáló HTTP 200 állapotkóddal válaszol, ha legalább egy eseményt sikeresen nyugtáz. A válasz törzse tartalmazza a sikeresen nyugtázható lockTokenek készletét, valamint a többi sikertelen lockTokenst a megfelelő hibainformációkkal együtt. A sikeresen elismert események a továbbiakban nem lesznek elérhetők a felhasználók számára.

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

Paraméterek

lockTokens

string[]

Jogkivonatok zárolása

topicName

string

Téma neve

eventSubscriptionName

string

Az esemény-előfizetés neve

options

AcknowledgeCloudEventsOptions

Nyugtázandó beállítások

Válaszok

Promise<AcknowledgeResult>

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

Egyfelhős esemény közzététele névtértémakörben. Sikeresség esetén a kiszolgáló egy HTTP 200 állapotkóddal válaszol, válaszként egy üres JSON-objektummal. Ellenkező esetben a kiszolgáló különböző hibakódokat adhat vissza. Például: 401: amely az engedélyezési hibát jelzi, 403: amely azt jelzi, hogy túllépte a kvótát, vagy az üzenet túl nagy, 410: ami azt jelzi, hogy adott témakör nem található, 400: hibás kérés esetén, és 500: belső kiszolgálóhiba esetén.

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

Paraméterek

event

CloudEvent<T>

Közzéteendő esemény

topicName

string

Az esemény közzétételének témaköre

options

PublishCloudEventOptions

Közzétételi beállítások

Válaszok

Promise<PublishResultOutput>

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

Batch Cloud-esemény közzététele a névtér témakörében. Sikeresség esetén a kiszolgáló egy HTTP 200 állapotkóddal válaszol, válaszként egy üres JSON-objektummal. Ellenkező esetben a kiszolgáló különböző hibakódokat adhat vissza. Például: 401: amely az engedélyezési hibát jelzi, 403: amely azt jelzi, hogy túllépte a kvótát, vagy az üzenet túl nagy, 410: ami azt jelzi, hogy adott témakör nem található, 400: hibás kérés esetén, és 500: belső kiszolgálóhiba esetén.

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

Paraméterek

events

CloudEvent<T>[]

Közzéteendő események

topicName

string

Az esemény közzétételének témaköre

options

PublishCloudEventsOptions

Közzétételi beállítások

Válaszok

Promise<PublishResultOutput>

receiveCloudEvents<T>(string, string, ReceiveCloudEventsOptions)

Felhőesemények kötegének fogadása az esemény-előfizetésből.

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

Paraméterek

topicName

string

Fogadandó téma

eventSubscriptionName

string

Az esemény-előfizetés neve

options

ReceiveCloudEventsOptions

Fogadási lehetőségek

Válaszok

Promise<ReceiveResult<T>>

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

A felhőesemények kötegének elvetése.

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

Paraméterek

lockTokens

string[]

Jogkivonatok zárolása

topicName

string

Téma neve

eventSubscriptionName

string

Az esemény-előfizetés neve

options

RejectCloudEventsOptions

Elutasítandó beállítások

Válaszok

Promise<RejectResult>

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

Felhőesemények kiadási kötegének kiadása. A kiszolgáló HTTP 200 állapotkóddal válaszol, ha legalább egy esemény sikeresen megjelent. A válasz törzse tartalmazza a sikeresen kiadott lockTokens készletet, valamint a többi sikertelen lockTokenst a hozzájuk tartozó hibainformációkkal együtt.

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

Paraméterek

lockTokens

string[]

Jogkivonatok zárolása

topicName

string

Téma neve

eventSubscriptionName

string

Az esemény-előfizetés neve

options

ReleaseCloudEventsOptions

A kiadási lehetőségek

Válaszok

Promise<ReleaseResult>

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

A felhőesemények kötegének zárolásának megújítása.

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

Paraméterek

lockTokens

string[]

Jogkivonatok zárolása

topicName

string

Téma neve

eventSubscriptionName

string

Az esemény-előfizetés neve

options

RenewCloudEventLocksOptions

Megújítási lehetőségek

Válaszok

Promise<RenewCloudEventLocksResult>