EventGridSenderClient class

Event Grid Namespaces Client

Constructors

EventGridSenderClient(string, AzureKeyCredential | TokenCredential, string, EventGridSenderClientOptions)

Azure Messaging EventGrid Client

Methods

sendEvents<T>(CloudEvent<T> | CloudEvent<T>[], SendEventsOptions)

Publish Cloud Events to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.

Constructor Details

EventGridSenderClient(string, AzureKeyCredential | TokenCredential, string, EventGridSenderClientOptions)

Azure Messaging EventGrid Client

new EventGridSenderClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, options?: EventGridSenderClientOptions)

Parameters

endpoint

string

topicName

string

Method Details

sendEvents<T>(CloudEvent<T> | CloudEvent<T>[], SendEventsOptions)

Publish Cloud Events to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error.

function sendEvents<T>(events: CloudEvent<T> | CloudEvent<T>[], options?: SendEventsOptions): Promise<void>

Parameters

events

CloudEvent<T> | CloudEvent<T>[]

Events to publish

options
SendEventsOptions

Options to publish

Returns

Promise<void>