@azure/eventgrid-namespaces package

Classes

AzureKeyCredential

A static-key-based credential that supports updating the underlying key value.

EventGridDeserializer

EventGridDeserializer is used to aid in processing events delivered by EventGrid. It can deserialize a JSON encoded payload of either a single event or batch of events as well as be used to convert the result of JSON.parse into an EventGridEvent or CloudEvent like object.

Unlike normal JSON deseralization, EventGridDeserializer does some additional conversions:

  • The consumer parses the event time property into a Date object, for ease of use.
  • When deserializing an event in the CloudEvent schema, if the event contains binary data, it is base64 decoded and returned as an instance of the Uint8Array type.
EventGridReceiverClient

Event Grid Namespaces Client

EventGridSenderClient

Event Grid Namespaces Client

Interfaces

AcknowledgeEventsOptionalParams

The base options type for all operations.

AcknowledgeEventsOptions

Acknowledge Events Options

AcknowledgeResult

The result of the Acknowledge operation.

BrokerProperties

Properties of the Event Broker operation.

CloudEvent

An event in the Cloud Event 1.0 schema.

EventGridClientOptions
EventGridReceiverClientOptions

Event Grid Receiver Client Options

EventGridSenderClientOptions

Event Grid Sender Client Options

FailedLockToken

Failed LockToken information.

OperationOptions

The base options type for all operations.

ReceiveDetails

Receive operation details per Cloud Event.

ReceiveEventsOptionalParams

The base options type for all operations.

ReceiveEventsOptions

Receive Events Options

ReceiveResult

Details of the Receive operation response.

RejectEventsOptionalParams

The base options type for all operations.

RejectEventsOptions

Reject Events Options

RejectResult

The result of the Reject operation.

ReleaseEventsOptions

Release Events Options

ReleaseResult

The result of the Release operation.

RenewEventLocksOptionalParams

The base options type for all operations.

RenewEventLocksOptions

Renew Event Locks Options

RenewLocksResult

The result of the RenewLock operation.

SendEventOptionalParams

The base options type for all operations.

SendEventsOptionalParams

The base options type for all operations.

SendEventsOptions

Send Events Options

Type Aliases

ReleaseDelay

"0", "10", "60", "600", "3600"

Enums

KnownReleaseDelay

Known values of ReleaseDelay that the service accepts.