EventGridClient class

Klien Azure Messaging EventGrid

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

Parameter

Mengakui batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil diakui. Isi respons akan mencakup kumpulan lockToken yang berhasil diakui, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai. Peristiwa yang berhasil diakui tidak akan lagi tersedia untuk konsumen mana pun.

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

Parameter

Mengembalikan

Terbitkan topik Peristiwa Cloud Tunggal ke namespace. Jika berhasil, server merespons dengan kode status HTTP 200 dengan objek JSON kosong sebagai respons. Jika tidak, server dapat mengembalikan berbagai kode kesalahan. Misalnya, 401: yang menunjukkan kegagalan otorisasi, 403: yang menunjukkan kuota terlampaui atau pesan terlalu besar, 410: yang menunjukkan bahwa topik tertentu tidak ditemukan, 400: untuk permintaan buruk, dan 500: untuk kesalahan server internal.

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

Parameter

Mengembalikan

Publikasikan topik Batch Cloud Event ke namespace. Jika berhasil, server merespons dengan kode status HTTP 200 dengan objek JSON kosong sebagai respons. Jika tidak, server dapat mengembalikan berbagai kode kesalahan. Misalnya, 401: yang menunjukkan kegagalan otorisasi, 403: yang menunjukkan kuota terlampaui atau pesan terlalu besar, 410: yang menunjukkan bahwa topik tertentu tidak ditemukan, 400: untuk permintaan buruk, dan 500: untuk kesalahan server internal.

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

Parameter

Mengembalikan

Terima Batch Peristiwa Cloud dari Langganan Peristiwa.

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

Parameter

Mengembalikan

Tolak batch Peristiwa Cloud.

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

Parameter

Mengembalikan

Rilis batch Peristiwa Cloud. Server merespons dengan kode status HTTP 200 jika setidaknya satu peristiwa berhasil dirilis. Isi respons akan mencakup kumpulan lockToken yang berhasil dirilis, bersama dengan lockTokens lain yang gagal dengan informasi kesalahan yang sesuai.

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

Parameter

Mengembalikan

Perbarui kunci untuk batch Peristiwa Cloud.

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

Parameter

Mengembalikan