Class EventGridPublisherClient

Package version

Client class for publishing events to the Event Grid Service.

Hierarchy

EventGridPublisherClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new EventGridPublisherClient(endpointUrl: string, credential: KeyCredential | SignatureCredential, options?: EventGridPublisherClientOptions): EventGridPublisherClient

- Defined in eventGridClient.ts:71
Creates an instance of EventGridPublisherClient.

Example usage:
```
import { EventGridPublisherClient, AzureKeyCredential } from "@azure/eventgrid";

const client = new EventGridPublisherClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);
```
Parameters
- endpointUrl: string
  
  The URL to the EventGrid endpoint, e.g. https://eg-topic.westus2-1.eventgrid.azure.net/api/events
- credential: KeyCredential | SignatureCredential
  
  Used to authenticate requests to the service.
- Default value options: EventGridPublisherClientOptions = {}
  
  Used to configure the Event Grid Client
Returns EventGridPublisherClient

Properties

apiVersion

apiVersion: string

The version of the Even Grid service.

endpointUrl

endpointUrl: string

The URL to the Event Grid endpoint.

Methods

sendCloudEvents

sendCloudEvents(events: SendCloudEventInput<any>[], options?: SendCloudEventsOptions): Promise<SendEventsResponse>

- Defined in eventGridClient.ts:144
Publishes events in the Cloud Events 1.0 schema. The topic must be configured to expect events in the Cloud Events 1.0 schema.

Parameters
- events: SendCloudEventInput<any>[]
- Optional options: SendCloudEventsOptions
Returns Promise<SendEventsResponse>

sendCustomSchemaEvents

sendCustomSchemaEvents(events: Record<string, any>[], options?: SendCustomSchemaEventsOptions): Promise<SendEventsResponse>

- Defined in eventGridClient.ts:166
Publishes events written using a custom schema. The topic must be configured to expect events in a custom schema.

Parameters
- events: Record<string, any>[]
- Optional options: SendCustomSchemaEventsOptions
Returns Promise<SendEventsResponse>

sendEvents

sendEvents(events: SendEventGridEventInput<any>[], options?: SendEventsOptions): Promise<SendEventsResponse>

- Defined in eventGridClient.ts:122
Publishes events in the Event Grid scheama. The topic must be configured to expect events in the Event Grid schema.

Parameters
- events: SendEventGridEventInput<any>[]
- Optional options: SendEventsOptions
Returns Promise<SendEventsResponse>

Generated using TypeDoc