@azure/eventgrid

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ACSChatMemberAddedToThreadWithUserEventData

ACSChatMemberAddedToThreadWithUserEventData: ACSChatThreadEventBase & { addedBy?: undefined | string; memberAdded?: ACSChatThreadMember; time?: Date }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberAddedToThreadWithUser event.

ACSChatMemberRemovedFromThreadWithUserEventData

ACSChatMemberRemovedFromThreadWithUserEventData: ACSChatThreadEventBase & { memberRemoved?: ACSChatThreadMember; removedBy?: undefined | string; time?: Date }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberRemovedFromThreadWithUser event.

ACSChatMessageDeletedEventData

ACSChatMessageDeletedEventData: ACSChatMessageEventBase & { deleteTime?: Date }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageDeleted event.

ACSChatMessageEditedEventData

ACSChatMessageEditedEventData: ACSChatMessageEventBase & { editTime?: Date; messageBody?: undefined | string }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageEdited event.

ACSChatMessageEventBase

ACSChatMessageEventBase: ACSChatEventBase & { composeTime?: Date; messageId?: undefined | string; senderDisplayName?: undefined | string; senderId?: undefined | string; type?: undefined | string; version?: undefined | number }

Schema of common properties of all chat message events

ACSChatMessageReceivedEventData

ACSChatMessageReceivedEventData: ACSChatMessageEventBase & { messageBody?: undefined | string }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageReceived event.

ACSChatThreadCreatedWithUserEventData

ACSChatThreadCreatedWithUserEventData: ACSChatThreadEventBase & { createdBy?: undefined | string; members?: ACSChatThreadMember[]; properties?: undefined | {} }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadCreatedWithUser event.

ACSChatThreadEventBase

ACSChatThreadEventBase: ACSChatEventBase & { createTime?: Date; version?: undefined | number }

Schema of common properties of all chat thread events

ACSChatThreadPropertiesUpdatedPerUserEventData

ACSChatThreadPropertiesUpdatedPerUserEventData: ACSChatThreadEventBase & { editTime?: Date; editedBy?: undefined | string; properties?: undefined | {} }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.

ACSChatThreadWithUserDeletedEventData

ACSChatThreadWithUserDeletedEventData: ACSChatThreadEventBase & { deleteTime?: Date; deletedBy?: undefined | string }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadWithUserDeleted event.

AcssmsDeliveryReportReceivedEventData

AcssmsDeliveryReportReceivedEventData: AcssmsEventBase & { deliveryAttempts?: AcssmsDeliveryAttempt[]; deliveryStatus?: undefined | string; deliveryStatusDetails?: undefined | string; receivedTimestamp?: Date }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSDeliveryReportReceived event.

AcssmsReceivedEventData

AcssmsReceivedEventData: AcssmsEventBase & { message?: undefined | string; receivedTimestamp?: Date }

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSReceived event.

AppAction

Defines values for AppAction.

AsyncStatus

AsyncStatus: "Started" | "Completed" | "Failed"

Defines values for AsyncStatus.

ContainerRegistryChartDeletedEventData

ContainerRegistryChartDeletedEventData: ContainerRegistryArtifactEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.

ContainerRegistryChartPushedEventData

ContainerRegistryChartPushedEventData: ContainerRegistryArtifactEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.

ContainerRegistryImageDeletedEventData

ContainerRegistryImageDeletedEventData: ContainerRegistryEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.

ContainerRegistryImagePushedEventData

ContainerRegistryImagePushedEventData: ContainerRegistryEventData & {}

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.

CustomEventDataDeserializer

CustomEventDataDeserializer: (o: any) => Promise<any>

A function which provides custom logic to be used when decoding events.

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

EventGridPublisherClientOptions

EventGridPublisherClientOptions: PipelineOptions

Options for the Event Grid Client.

IotHubDeviceConnectedEventData

IotHubDeviceConnectedEventData: DeviceConnectionStateEventProperties & {}

Event data for Microsoft.Devices.DeviceConnected event.

IotHubDeviceCreatedEventData

IotHubDeviceCreatedEventData: DeviceLifeCycleEventProperties & {}

Event data for Microsoft.Devices.DeviceCreated event.

IotHubDeviceDeletedEventData

IotHubDeviceDeletedEventData: DeviceLifeCycleEventProperties & {}

Event data for Microsoft.Devices.DeviceDeleted event.

IotHubDeviceDisconnectedEventData

IotHubDeviceDisconnectedEventData: DeviceConnectionStateEventProperties & {}

Event data for Microsoft.Devices.DeviceDisconnected event.

IotHubDeviceTelemetryEventData

IotHubDeviceTelemetryEventData: DeviceTelemetryEventProperties & {}

Event data for Microsoft.Devices.DeviceTelemetry event.

KnownSystemEventTypes

KnownSystemEventTypes: "Microsoft.AppConfiguration.KeyValueDeleted" | "Microsoft.AppConfiguration.KeyValueModified" | "Microsoft.Communication.ChatMessageReceived" | "Microsoft.Communication.ChatMessageEdited" | "Microsoft.Communication.ChatMessageDeleted" | "Microsoft.Communication.ChatThreadCreatedWithUser" | "Microsoft.Communication.ChatThreadWithUserDeleted" | "Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser" | "Microsoft.Communication.ChatMemberAddedToThreadWithUser" | "Microsoft.Communication.ChatMemberRemovedFromThreadWithUser" | "Microsoft.Communication.SMSDeliveryReportReceived" | "Microsoft.Communication.SMSReceived" | "Microsoft.ContainerRegistry.ImagePushed" | "Microsoft.ContainerRegistry.ImageDeleted" | "Microsoft.ContainerRegistry.ChartDeleted" | "Microsoft.ContainerRegistry.ChartPushed" | "Microsoft.Devices.DeviceCreated" | "Microsoft.Devices.DeviceDeleted" | "Microsoft.Devices.DeviceConnected" | "Microsoft.Devices.DeviceDisconnected" | "Microsoft.Devices.DeviceTelemetry" | "Microsoft.EventGrid.SubscriptionValidationEvent" | "Microsoft.EventGrid.SubscriptionDeletedEvent" | "Microsoft.EventHub.CaptureFileCreated" | "Microsoft.MachineLearningServices.DatasetDriftDetected" | "Microsoft.MachineLearningServices.ModelDeployed" | "Microsoft.MachineLearningServices.ModelRegistered" | "Microsoft.MachineLearningServices.RunCompleted" | "Microsoft.MachineLearningServices.RunStatusChanged" | "Microsoft.Maps.GeofenceEntered" | "Microsoft.Maps.GeofenceExited" | "Microsoft.Maps.GeofenceResult" | "Microsoft.Media.JobStateChange" | "Microsoft.Media.JobOutputStateChange" | "Microsoft.Media.JobScheduled" | "Microsoft.Media.JobProcessing" | "Microsoft.Media.JobCanceling" | "Microsoft.Media.JobFinished" | "Microsoft.Media.JobCanceled" | "Microsoft.Media.JobErrored" | "Microsoft.Media.JobOutputCanceled" | "Microsoft.Media.JobOutputCanceling" | "Microsoft.Media.JobOutputErrored" | "Microsoft.Media.JobOutputFinished" | "Microsoft.Media.JobOutputProcessing" | "Microsoft.Media.JobOutputScheduled" | "Microsoft.Media.JobOutputProgress" | "Microsoft.Media.LiveEventEncoderConnected" | "Microsoft.Media.LiveEventConnectionRejected" | "Microsoft.Media.LiveEventEncoderDisconnected" | "Microsoft.Media.LiveEventIncomingStreamReceived" | "Microsoft.Media.LiveEventIncomingStreamsOutOfSync" | "Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync" | "Microsoft.Media.LiveEventIncomingDataChunkDropped" | "Microsoft.Media.LiveEventIngestHeartbeat" | "Microsoft.Media.LiveEventTrackDiscontinuityDetected" | "Microsoft.Resources.ResourceWriteSuccess" | "Microsoft.Resources.ResourceWriteFailure" | "Microsoft.Resources.ResourceWriteCancel" | "Microsoft.Resources.ResourceDeleteSuccess" | "Microsoft.Resources.ResourceDeleteFailure" | "Microsoft.Resources.ResourceDeleteCancel" | "Microsoft.Resources.ResourceActionSuccess" | "Microsoft.Resources.ResourceActionFailure" | "Microsoft.Resources.ResourceActionCancel" | "Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners" | "Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener" | "Microsoft.Storage.BlobCreated" | "Microsoft.Storage.BlobDeleted" | "Microsoft.Storage.BlobRenamed" | "Microsoft.Storage.DirectoryCreated" | "Microsoft.Storage.DirectoryDeleted" | "Microsoft.Storage.DirectoryRenamed" | "Microsoft.Storage.LifecyclePolicyCompleted" | "Microsoft.Web.AppUpdated" | "Microsoft.Web.BackupOperationStarted" | "Microsoft.Web.BackupOperationCompleted" | "Microsoft.Web.BackupOperationFailed" | "Microsoft.Web.RestoreOperationStarted" | "Microsoft.Web.RestoreOperationCompleted" | "Microsoft.Web.RestoreOperationFailed" | "Microsoft.Web.SlotSwapStarted" | "Microsoft.Web.SlotSwapCompleted" | "Microsoft.Web.SlotSwapFailed" | "Microsoft.Web.SlotSwapWithPreviewStarted" | "Microsoft.Web.SlotSwapWithPreviewCancelled" | "Microsoft.Web.AppServicePlanUpdated"

The Event Types for all System Events. These may be used with isSystemEvent to determine if an event is a system event of a given type.

MapsGeofenceEnteredEventData

MapsGeofenceEnteredEventData: MapsGeofenceEventProperties & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.

MapsGeofenceExitedEventData

MapsGeofenceExitedEventData: MapsGeofenceEventProperties & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.

MapsGeofenceResultEventData

MapsGeofenceResultEventData: MapsGeofenceEventProperties & {}

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.

MediaJobCanceledEventData

MediaJobCanceledEventData: MediaJobStateChangeEventData & { outputs?: MediaJobOutputUnion[] }

Job canceled event data

MediaJobCancelingEventData

MediaJobCancelingEventData: MediaJobStateChangeEventData & {}

Job canceling event data

MediaJobErrorCategory

MediaJobErrorCategory: "Service" | "Download" | "Upload" | "Configuration" | "Content"

Defines values for MediaJobErrorCategory.

MediaJobErrorCode

Defines values for MediaJobErrorCode.

MediaJobErroredEventData

MediaJobErroredEventData: MediaJobStateChangeEventData & { outputs?: MediaJobOutputUnion[] }

Job error state event data

MediaJobFinishedEventData

MediaJobFinishedEventData: MediaJobStateChangeEventData & { outputs?: MediaJobOutputUnion[] }

Job finished event data

MediaJobOutputAsset

MediaJobOutputAsset: MediaJobOutput & { assetName?: undefined | string }

The event data for a Job output asset.

MediaJobOutputCanceledEventData

MediaJobOutputCanceledEventData: MediaJobOutputStateChangeEventData & {}

Job output canceled event data

MediaJobOutputCancelingEventData

MediaJobOutputCancelingEventData: MediaJobOutputStateChangeEventData & {}

Job output canceling event data

MediaJobOutputErroredEventData

MediaJobOutputErroredEventData: MediaJobOutputStateChangeEventData & {}

Job output error event data

MediaJobOutputFinishedEventData

MediaJobOutputFinishedEventData: MediaJobOutputStateChangeEventData & {}

Job output finished event data

MediaJobOutputProcessingEventData

MediaJobOutputProcessingEventData: MediaJobOutputStateChangeEventData & {}

Job output processing event data

MediaJobOutputScheduledEventData

MediaJobOutputScheduledEventData: MediaJobOutputStateChangeEventData & {}

Job output scheduled event data

MediaJobOutputUnion

MediaJobOutputUnion: MediaJobOutput | MediaJobOutputAsset

MediaJobProcessingEventData

MediaJobProcessingEventData: MediaJobStateChangeEventData & {}

Job processing event data

MediaJobRetry

MediaJobRetry: "DoNotRetry" | "MayRetry"

Defines values for MediaJobRetry.

MediaJobScheduledEventData

MediaJobScheduledEventData: MediaJobStateChangeEventData & {}

Job scheduled event data

MediaJobState

Defines values for MediaJobState.

SendCloudEventsOptions

SendCloudEventsOptions: OperationOptions

Options for the send cloud events operation.

SendCustomSchemaEventsOptions

SendCustomSchemaEventsOptions: OperationOptions

Options for the send custom schema events operation.

SendEventsOptions

SendEventsOptions: OperationOptions

Options for the send events operation.

StampKind

StampKind: "Public" | "AseV1" | "AseV2"

Defines values for StampKind.

Variables

Const API_KEY_HEADER_NAME

API_KEY_HEADER_NAME: "aeg-sas-key" = "aeg-sas-key"

The name of the header to include when a Shared Key is used for authentication.

Const CLOUD_EVENT_1_0_SPEC_VERSION

CLOUD_EVENT_1_0_SPEC_VERSION: "1.0" = "1.0"

Const DEFAULT_API_VERSION

DEFAULT_API_VERSION: "2018-01-01" = "2018-01-01"

Const EVENT_GRID_SCHEMA_METADATA_VERSION

EVENT_GRID_SCHEMA_METADATA_VERSION: "1" = "1"

Const SAS_TOKEN_HEADER_NAME

SAS_TOKEN_HEADER_NAME: "aeg-sas-token" = "aeg-sas-token"

The name of the header to include when Shared Access Signature is used for authentication.

Const SDK_VERSION

SDK_VERSION: string = "3.0.0-beta.2"

Const cloudEventReservedPropertyNames

cloudEventReservedPropertyNames: Object = ["specversion","id","source","type","datacontenttype","dataschema","subject","time","data"]

Property names defined by the CloudEvents 1.0 specification, these may not be reused as the names of extension properties.

Const logger

logger: any = createClientLogger("eventgrid")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/eventgrid" = "@azure/eventgrid"

Const packageVersion

packageVersion: "3.0.0-beta.2" = "3.0.0-beta.2"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

convertCloudEventToModelType

convertCloudEventToModelType(event: SendCloudEventInput<any>): CloudEventWireModel

- Defined in eventGridClient.ts:200
internal

Parameters
- event: SendCloudEventInput<any>
Returns CloudEventWireModel

convertEventGridEventToModelType

convertEventGridEventToModelType(event: SendEventGridEventInput<any>): EventGridEventWireModel

- Defined in eventGridClient.ts:183
internal

Parameters
- event: SendEventGridEventInput<any>
Returns EventGridEventWireModel

createEventGridCredentialPolicy

createEventGridCredentialPolicy(credential: KeyCredential | SignatureCredential): RequestPolicyFactory

- Defined in eventGridAuthenticationPolicy.ts:31
Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for Event Grid

Parameters
- credential: KeyCredential | SignatureCredential
Returns RequestPolicyFactory

dateToServiceTimeString

dateToServiceTimeString(d: Date): string

- Defined in util.ts:19
Stringifies a Date object in the format expected by the Event Grid service, for use in a Shared Access Signiture.

The service expects this time string to be in the same format as what is returned by the .NET DateTime.ToString method, using the "en-US" culture.

This corresponds to the .NET format string: "M/d/yyyy h:mm:ss tt". For example, the date "June 5th, 2020, 12:09:03 PM" is represented as the string "6/5/2020 12:09:03 PM"

The service expects a UTC time, so this method returns a string based on the UTC time of the provided Date.

Parameters
- d: Date
  
  The Date object to convert to a string.
Returns string

generateSharedAccessSignature

generateSharedAccessSignature(endpointUrl: string, credential: KeyCredential, expiresOnUtc: Date, options?: GenerateSharedAccessSignatureOptions): Promise<string>

- Defined in generateSharedAccessSignature.ts:26
Generate a shared access signature, which allows a client to send events to an Event Grid Topic or Domain for a limited period of time. This function may only be called when the EventGridPublisherClient was constructed with a KeyCredential instance.

Parameters
- endpointUrl: string
  
  The endpoint for the topic or domain you wish to generate a shared access signature for.
- credential: KeyCredential
  
  The credential to use when generating the shared access signatrue.
- expiresOnUtc: Date
- Optional options: GenerateSharedAccessSignatureOptions
  
  Options to control how the signature is generated.
Returns Promise<string>

isCloudEventLike

isCloudEventLike(o: EventGridEvent<unknown> | CloudEvent<unknown>): o is CloudEvent<unknown>

- Defined in predicates.ts:376
isCloudEventLike returns "true" when the event is a CloudEvent

Parameters
- o: EventGridEvent<unknown> | CloudEvent<unknown>
  
  Either an EventGrid our CloudEvent event.
Returns o is CloudEvent<unknown>

isKeyCredentialLike

isKeyCredentialLike(o: any): o is KeyCredential

- Defined in util.ts:44
Returns true if the credential object is like the KeyCredential interface (i.e. it has a key property).

Parameters
- o: any
Returns o is KeyCredential

isSystemEvent

isSystemEvent<T>(eventType: T, event: EventGridEvent<unknown>): event is EventGridEvent<SystemEventNameToEventData[T]>
isSystemEvent<T>(eventType: T, event: CloudEvent<unknown>): event is CloudEvent<SystemEventNameToEventData[T]>

- Defined in predicates.ts:390
iSystemEvent returns "true" when a given event is a system event of a given type. When using TypeScript, this function acts as a custom type guard and allows the TypeScript compiler to identify the underlying data

Type parameters
- T: KnownSystemEventTypes
Parameters
- eventType: T
  
  The type of system event to check for, e.g., "Microsoft.AppConfiguration.KeyValueDeleted"
- event: EventGridEvent<unknown>
  
  The event to test.
Returns event is EventGridEvent<SystemEventNameToEventData[T]>
- Defined in predicates.ts:403
iSystemEvent returns "true" when a given event is a system event of a given type. When using TypeScript, this function acts as a custom type guard and allows the TypeScript compiler to identify the underlying data

Type parameters
- T: KnownSystemEventTypes
Parameters
- eventType: T
  
  The type of system event to check for, e.g., "Microsoft.AppConfiguration.KeyValueDeleted"
- event: CloudEvent<unknown>
  
  The event to test.
Returns event is CloudEvent<SystemEventNameToEventData[T]>

jsonParseDeserializer

jsonParseDeserializer(o: any): Promise<any>

- Defined in systemEventDecoders.ts:299
Parameters
- o: any
Returns Promise<any>

makeDeserializerFromMapper

makeDeserializerFromMapper(mapper: Mapper, initialDeserializers?: CustomEventDataDeserializer[]): CustomEventDataDeserializer

- Defined in systemEventDecoders.ts:280
Parameters
- mapper: Mapper
- Optional initialDeserializers: CustomEventDataDeserializer[]
Returns CustomEventDataDeserializer

parseAndWrap

parseAndWrap(jsonStringOrObject: string | object): any[]

- Defined in util.ts:48
Parameters
- jsonStringOrObject: string | object
Returns any[]

validateCloudEventEvent

validateCloudEventEvent(o: any): void

- Defined in util.ts:91
Parameters
- o: any
Returns void

validateEventGridEvent

validateEventGridEvent(o: any): void

- Defined in util.ts:67
Parameters
- o: any
Returns void

validateOptionalStringProperties

validateOptionalStringProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:126
Parameters
- o: any
- propertyNames: string[]
Returns void

validateRequiredAnyProperties

validateRequiredAnyProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:118
Parameters
- o: any
- propertyNames: string[]
Returns void

validateRequiredStringProperties

validateRequiredStringProperties(o: any, propertyNames: string[]): void

- Defined in util.ts:104
Parameters
- o: any
- propertyNames: string[]
Returns void

Object literals

Const ACSChatEventBase

ACSChatEventBase: object

type

type: object

className

className: string = "ACSChatEventBase"

name

modelProperties

type

type: object

name

memberAdded

memberAdded: object

serializedName

serializedName: string = "memberAdded"

type

type: object

className

className: string = "ACSChatThreadMember"

name

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

Const ACSChatMemberRemovedFromThreadWithUserEventData

ACSChatMemberRemovedFromThreadWithUserEventData: object

type

type: object

className

className: string = "ACSChatMemberRemovedFromThreadWithUserEventData"

name

modelProperties

modelProperties: object

memberRemoved

type

type: object

name

Const ACSChatMessageEditedEventData

ACSChatMessageEditedEventData: object

type

type: object

className

className: string = "ACSChatMessageEditedEventData"

name

modelProperties

modelProperties: object

editTime

editTime: object

serializedName

serializedName: string = "editTime"

type

type: object

name

messageBody

messageBody: object

serializedName

serializedName: string = "messageBody"

type

type: object

name

Const ACSChatMessageEventBase

ACSChatMessageEventBase: object

type

type: object

className

className: string = "ACSChatMessageEventBase"

name

modelProperties

type

type: object

name

Const ACSChatThreadCreatedWithUserEventData

ACSChatThreadCreatedWithUserEventData: object

type

type: object

className

className: string = "ACSChatThreadCreatedWithUserEventData"

name

modelProperties

className

className: string = "ACSChatThreadEventBase"

name

modelProperties

modelProperties: object

createTime

createTime: object

serializedName

serializedName: string = "createTime"

type

type: object

name

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

Const ACSChatThreadMember

ACSChatThreadMember: object

type

type: object

className

className: string = "ACSChatThreadMember"

name

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

serializedName

serializedName: string = "editTime"

type

type: object

name

editedBy

editedBy: object

serializedName

serializedName: string = "editedBy"

type

type: object

name

properties

className

className: string = "ACSChatThreadWithUserDeletedEventData"

name

modelProperties

modelProperties: object

deleteTime

deleteTime: object

serializedName

serializedName: string = "deleteTime"

type

type: object

name

deletedBy

deletedBy: object

serializedName

serializedName: string = "deletedBy"

type

type: object

name

Const AcssmsDeliveryAttempt

AcssmsDeliveryAttempt: object

type

type: object

className

className: string = "AcssmsDeliveryAttempt"

name

modelProperties

serializedName

serializedName: string = "action"

type

type: object

name

Const AppServicePlanEventTypeDetail

AppServicePlanEventTypeDetail: object

type

type: object

className

className: string = "AppServicePlanEventTypeDetail"

name

modelProperties

modelProperties: object

action

action: object

defaultValue

defaultValue: string = "Updated"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "action"

type

type: object

type

type: object

name

source

source: object

required

required: boolean = true

serializedName

serializedName: string = "source"

type

type: object

name

specversion

type

type: object

name

Const ContainerRegistryArtifactEventData

ContainerRegistryArtifactEventData: object

type

type: object

className

className: string = "ContainerRegistryArtifactEventData"

name

modelProperties

serializedName

serializedName: string = "digest"

type

type: object

name

mediaType

mediaType: object

serializedName

serializedName: string = "mediaType"

type

type: object

type: object

className

className: string = "ContainerRegistryEventActor"

name

modelProperties

modelProperties: object

name

serializedName

serializedName: string = "name"

type

type: object

name

Const ContainerRegistryEventData

ContainerRegistryEventData: object

type

type: object

className

className: string = "ContainerRegistryEventData"

name

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

name

actor

name

Const ContainerRegistryEventRequest

ContainerRegistryEventRequest: object

type

type: object

className

className: string = "ContainerRegistryEventRequest"

name

modelProperties

type

type: object

name

hubName

hubName: object

serializedName

serializedName: string = "hubName"

type

type: object

name

twin

twin: object

serializedName

serializedName: string = "twin"

type

type: object

className

className: string = "DeviceTwinInfo"

name

Const DeviceTelemetryEventProperties

DeviceTelemetryEventProperties: object

type

type: object

className

className: string = "DeviceTelemetryEventProperties"

name

modelProperties

modelProperties: object

body

name

modelProperties

modelProperties: object

primaryThumbprint

primaryThumbprint: object

serializedName

serializedName: string = "primaryThumbprint"

type

type: object

name

secondaryThumbprint

secondaryThumbprint: object

serializedName

serializedName: string = "secondaryThumbprint"

type

type: object

name

Const DeviceTwinMetadata

DeviceTwinMetadata: object

type

type: object

className

className: string = "DeviceTwinMetadata"

EventGridEvent: object

type

type: object

className

className: string = "EventGridEvent"

name

modelProperties

name

modelProperties

modelProperties: object

expiredGeofenceGeometryId

expiredGeofenceGeometryId: object

serializedName

serializedName: string = "expiredGeofenceGeometryId"

type

type: object

MapsGeofenceGeometry: object

type

type: object

className

className: string = "MapsGeofenceGeometry"

name

modelProperties

type

type: object

className

className: string = "MediaJobCanceledEventData"

name

modelProperties

className

className: string = "MediaJobCancelingEventData"

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

element

element: object

type

type: object

className

className: string = "MediaJobErrorDetail"

name

message

className

className: string = "MediaJobFinishedEventData"

name

modelProperties

modelProperties: object

outputs

outputs: object

serializedName

serializedName: string = "outputs"

type

type: object

name

element

element: object

type

type: object

className

className: string = "MediaJobOutput"

name

Const MediaJobOutput

MediaJobOutput: object

type

type: object

className

className: string = "MediaJobOutput"

name

uberParent

uberParent: string = "MediaJobOutput"

modelProperties

modelProperties: object

error

error: object

type: object

name

state

state: object

required

required: boolean = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: Object = ["Canceled","Canceling","Error","Finished","Processing","Queued","Scheduled"]

name

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "@odata\.type"

serializedName

name

modelProperties

modelProperties: object

Const MediaJobOutputStateChangeEventData

name

previousState

className

className: string = "MediaJobScheduledEventData"

name

modelProperties

modelProperties: object

Const MediaJobStateChangeEventData

allowedValues

allowedValues: Object = ["Canceled","Canceling","Error","Finished","Processing","Queued","Scheduled"]

name

state

state: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: Object = ["Canceled","Canceling","Error","Finished","Processing","Queued","Scheduled"]

name

Const MediaLiveEventConnectionRejectedEventData

MediaLiveEventConnectionRejectedEventData: object

type

type: object

className

className: string = "MediaLiveEventConnectionRejectedEventData"

name

modelProperties

name

Const MediaLiveEventEncoderConnectedEventData

MediaLiveEventEncoderConnectedEventData: object

type

type: object

className

className: string = "MediaLiveEventEncoderConnectedEventData"

name

modelProperties

modelProperties: object

encoderIp

encoderIp: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "encoderIp"

type

type: object

name

timestamp

timestamp: object

serializedName

name

timestamp

timestamp: object

serializedName

name

timestamp

timestamp: object

serializedName

serializedName

serializedName: string = "deleteSummary"

type

type: object

className

className: string = "StorageLifecyclePolicyActionSummaryDetail"

name

scheduleTime

scheduleTime: object

serializedName

serializedName: string = "scheduleTime"

type

type: object

modelProperties: object

validationResponse

validationResponse: object

serializedName

serializedName: string = "validationResponse"

type

type: object

name

Const WebAppServicePlanUpdatedEventData

WebAppServicePlanUpdatedEventData: object

type

type: object

className

className: string = "WebAppServicePlanUpdatedEventData"

name

modelProperties

modelProperties: object

address

address: object

serializedName

serializedName: string = "address"

type

type: object

name

appServicePlanEventTypeDetail

serializedName: string = "Capacity"

type

type: object

name

family

family: object

serializedName

serializedName: string = "Family"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

type: object

className

className: string = "AppEventTypeDetail"

name

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

correlationRequestId

correlationRequestId: object

serializedName

serializedName: string = "correlationRequestId"

type

type: object

defaultValue: string = "2018-01-01"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Const contentType1

contentType1: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/cloudevents-batch+json; charset=utf-8"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Let discriminators

discriminators: object

MediaJobOutput

MediaJobOutput: any = MediaJobOutput

MediaJobOutput.#Microsoft.Media.JobOutputAsset

MediaJobOutput.#Microsoft.Media.JobOutputAsset: any = MediaJobOutputAsset

Const events

events: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

className

className: string = "EventGridEvent"

name

Const events1

events1: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

className

className: string = "CloudEvent"

name

Const events2

events2: object

parameterPath

parameterPath: string = "events"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "events"

type

type: object

name

element

element: object

type

type: object

name

Const publishCloudEventEventsOperationSpec

publishCloudEventEventsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType1]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/api/events"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events1

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const publishCustomEventEventsOperationSpec

publishCustomEventEventsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/api/events"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events2

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const publishEventsOperationSpec

publishEventsOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/api/events"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.events

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.topicHostname]

responses

responses: object

200

200: {}

Type declaration

default

default: {}

Type declaration

Const systemDeserializers

systemDeserializers: object

Microsoft.AppConfiguration.KeyValueDeleted

Microsoft.AppConfiguration.KeyValueDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(AppConfigurationKeyValueDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.AppConfiguration.KeyValueModified

Microsoft.AppConfiguration.KeyValueModified: (o: any) => Promise<any> = makeDeserializerFromMapper(AppConfigurationKeyValueModifiedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatMemberAddedToThreadWithUser

Microsoft.Communication.ChatMemberAddedToThreadWithUser: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatMemberAddedToThreadWithUserEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatMemberRemovedFromThreadWithUser

Microsoft.Communication.ChatMemberRemovedFromThreadWithUser: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatMemberRemovedFromThreadWithUserEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatMessageDeleted

Microsoft.Communication.ChatMessageDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatMessageDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatMessageEdited

Microsoft.Communication.ChatMessageEdited: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatMessageEditedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatMessageReceived

Microsoft.Communication.ChatMessageReceived: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatMessageReceivedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatThreadCreatedWithUser

Microsoft.Communication.ChatThreadCreatedWithUser: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatThreadCreatedWithUserEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser

Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatThreadPropertiesUpdatedPerUserEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.ChatThreadWithUserDeleted

Microsoft.Communication.ChatThreadWithUserDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(ACSChatThreadWithUserDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.SMSDeliveryReportReceived

Microsoft.Communication.SMSDeliveryReportReceived: (o: any) => Promise<any> = makeDeserializerFromMapper(AcssmsDeliveryReportReceivedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Communication.SMSReceived

Microsoft.Communication.SMSReceived: (o: any) => Promise<any> = makeDeserializerFromMapper(AcssmsReceivedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ContainerRegistry.ChartDeleted

Microsoft.ContainerRegistry.ChartDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(ContainerRegistryEventData,[jsonParseDeserializer])

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ContainerRegistry.ChartPushed

Microsoft.ContainerRegistry.ChartPushed: (o: any) => Promise<any> = makeDeserializerFromMapper(ContainerRegistryEventData,[jsonParseDeserializer])

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ContainerRegistry.ImageDeleted

Microsoft.ContainerRegistry.ImageDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(ContainerRegistryEventData,[jsonParseDeserializer])

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ContainerRegistry.ImagePushed

Microsoft.ContainerRegistry.ImagePushed: (o: any) => Promise<any> = makeDeserializerFromMapper(ContainerRegistryEventData,[jsonParseDeserializer])

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Devices.DeviceConnected

Microsoft.Devices.DeviceConnected: (o: any) => Promise<any> = makeDeserializerFromMapper(IotHubDeviceConnectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Devices.DeviceCreated

Microsoft.Devices.DeviceCreated: (o: any) => Promise<any> = makeDeserializerFromMapper(IotHubDeviceCreatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Devices.DeviceDeleted

Microsoft.Devices.DeviceDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(IotHubDeviceDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Devices.DeviceDisconnected

Microsoft.Devices.DeviceDisconnected: (o: any) => Promise<any> = makeDeserializerFromMapper(IotHubDeviceDisconnectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Devices.DeviceTelemetry

Microsoft.Devices.DeviceTelemetry: (o: any) => Promise<any> = makeDeserializerFromMapper(IotHubDeviceTelemetryEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.EventGrid.SubscriptionDeletedEvent

Microsoft.EventGrid.SubscriptionDeletedEvent: (o: any) => Promise<any> = makeDeserializerFromMapper(SubscriptionDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.EventGrid.SubscriptionValidationEvent

Microsoft.EventGrid.SubscriptionValidationEvent: (o: any) => Promise<any> = makeDeserializerFromMapper(SubscriptionValidationEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.EventHub.CaptureFileCreated

Microsoft.EventHub.CaptureFileCreated: (o: any) => Promise<any> = makeDeserializerFromMapper(EventHubCaptureFileCreatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.MachineLearningServices.DatasetDriftDetected

Microsoft.MachineLearningServices.DatasetDriftDetected: (o: any) => Promise<any> = makeDeserializerFromMapper(MachineLearningServicesDatasetDriftDetectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.MachineLearningServices.ModelDeployed

Microsoft.MachineLearningServices.ModelDeployed: (o: any) => Promise<any> = makeDeserializerFromMapper(MachineLearningServicesModelDeployedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.MachineLearningServices.ModelRegistered

Microsoft.MachineLearningServices.ModelRegistered: (o: any) => Promise<any> = makeDeserializerFromMapper(MachineLearningServicesModelRegisteredEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.MachineLearningServices.RunCompleted

Microsoft.MachineLearningServices.RunCompleted: (o: any) => Promise<any> = makeDeserializerFromMapper(MachineLearningServicesRunCompletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.MachineLearningServices.RunStatusChanged

Microsoft.MachineLearningServices.RunStatusChanged: (o: any) => Promise<any> = makeDeserializerFromMapper(MachineLearningServicesRunStatusChangedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Maps.GeofenceEntered

Microsoft.Maps.GeofenceEntered: (o: any) => Promise<any> = makeDeserializerFromMapper(MapsGeofenceEnteredEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Maps.GeofenceExited

Microsoft.Maps.GeofenceExited: (o: any) => Promise<any> = makeDeserializerFromMapper(MapsGeofenceExitedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Maps.GeofenceResult

Microsoft.Maps.GeofenceResult: (o: any) => Promise<any> = makeDeserializerFromMapper(MapsGeofenceResultEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobCanceled

Microsoft.Media.JobCanceled: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobCanceledEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobCanceling

Microsoft.Media.JobCanceling: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobCancelingEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobErrored

Microsoft.Media.JobErrored: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobErroredEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobFinished

Microsoft.Media.JobFinished: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobFinishedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputCanceled

Microsoft.Media.JobOutputCanceled: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputCanceledEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputCanceling

Microsoft.Media.JobOutputCanceling: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputCancelingEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputErrored

Microsoft.Media.JobOutputErrored: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputErroredEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputFinished

Microsoft.Media.JobOutputFinished: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputFinishedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputProcessing

Microsoft.Media.JobOutputProcessing: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputProcessingEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputProgress

Microsoft.Media.JobOutputProgress: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputProgressEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputScheduled

Microsoft.Media.JobOutputScheduled: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputScheduledEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobOutputStateChange

Microsoft.Media.JobOutputStateChange: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobOutputStateChangeEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobProcessing

Microsoft.Media.JobProcessing: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobProcessingEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobScheduled

Microsoft.Media.JobScheduled: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobScheduledEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.JobStateChange

Microsoft.Media.JobStateChange: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaJobStateChangeEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventConnectionRejected

Microsoft.Media.LiveEventConnectionRejected: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventConnectionRejectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventEncoderConnected

Microsoft.Media.LiveEventEncoderConnected: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventEncoderConnectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventEncoderDisconnected

Microsoft.Media.LiveEventEncoderDisconnected: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventEncoderDisconnectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventIncomingDataChunkDropped

Microsoft.Media.LiveEventIncomingDataChunkDropped: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventIncomingDataChunkDroppedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventIncomingStreamReceived

Microsoft.Media.LiveEventIncomingStreamReceived: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventIncomingStreamReceivedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventIncomingStreamsOutOfSync

Microsoft.Media.LiveEventIncomingStreamsOutOfSync: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventIncomingStreamsOutOfSyncEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync

Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventIncomingVideoStreamsOutOfSyncEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventIngestHeartbeat

Microsoft.Media.LiveEventIngestHeartbeat: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventIngestHeartbeatEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Media.LiveEventTrackDiscontinuityDetected

Microsoft.Media.LiveEventTrackDiscontinuityDetected: (o: any) => Promise<any> = makeDeserializerFromMapper(MediaLiveEventTrackDiscontinuityDetectedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceActionCancel

Microsoft.Resources.ResourceActionCancel: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceActionCancelEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceActionFailure

Microsoft.Resources.ResourceActionFailure: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceActionFailureEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceActionSuccess

Microsoft.Resources.ResourceActionSuccess: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceActionSuccessEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceDeleteCancel

Microsoft.Resources.ResourceDeleteCancel: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceDeleteCancelEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceDeleteFailure

Microsoft.Resources.ResourceDeleteFailure: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceDeleteFailureEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceDeleteSuccess

Microsoft.Resources.ResourceDeleteSuccess: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceDeleteSuccessEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceWriteCancel

Microsoft.Resources.ResourceWriteCancel: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceWriteCancelEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceWriteFailure

Microsoft.Resources.ResourceWriteFailure: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceWriteFailureEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Resources.ResourceWriteSuccess

Microsoft.Resources.ResourceWriteSuccess: (o: any) => Promise<any> = makeDeserializerFromMapper(ResourceWriteSuccessEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners

Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners: (o: any) => Promise<any> = makeDeserializerFromMapper(ServiceBusActiveMessagesAvailableWithNoListenersEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener

Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListener: (o: any) => Promise<any> = makeDeserializerFromMapper(ServiceBusDeadletterMessagesAvailableWithNoListenersEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.BlobCreated

Microsoft.Storage.BlobCreated: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageBlobCreatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.BlobDeleted

Microsoft.Storage.BlobDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageBlobDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.BlobRenamed

Microsoft.Storage.BlobRenamed: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageBlobRenamedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.DirectoryCreated

Microsoft.Storage.DirectoryCreated: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageDirectoryCreatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.DirectoryDeleted

Microsoft.Storage.DirectoryDeleted: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageDirectoryDeletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.DirectoryRenamed

Microsoft.Storage.DirectoryRenamed: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageDirectoryRenamedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Storage.LifecyclePolicyCompleted

Microsoft.Storage.LifecyclePolicyCompleted: (o: any) => Promise<any> = makeDeserializerFromMapper(StorageLifecyclePolicyCompletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.AppServicePlanUpdated

Microsoft.Web.AppServicePlanUpdated: (o: any) => Promise<any> = makeDeserializerFromMapper(WebAppServicePlanUpdatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.AppUpdated

Microsoft.Web.AppUpdated: (o: any) => Promise<any> = makeDeserializerFromMapper(WebAppUpdatedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.BackupOperationCompleted

Microsoft.Web.BackupOperationCompleted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebBackupOperationCompletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.BackupOperationFailed

Microsoft.Web.BackupOperationFailed: (o: any) => Promise<any> = makeDeserializerFromMapper(WebBackupOperationFailedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.BackupOperationStarted

Microsoft.Web.BackupOperationStarted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebBackupOperationStartedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.RestoreOperationCompleted

Microsoft.Web.RestoreOperationCompleted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebRestoreOperationCompletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.RestoreOperationFailed

Microsoft.Web.RestoreOperationFailed: (o: any) => Promise<any> = makeDeserializerFromMapper(WebRestoreOperationFailedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.RestoreOperationStarted

Microsoft.Web.RestoreOperationStarted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebRestoreOperationStartedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.SlotSwapCompleted

Microsoft.Web.SlotSwapCompleted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebSlotSwapCompletedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.SlotSwapFailed

Microsoft.Web.SlotSwapFailed: (o: any) => Promise<any> = makeDeserializerFromMapper(WebSlotSwapFailedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.SlotSwapStarted

Microsoft.Web.SlotSwapStarted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebSlotSwapStartedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.SlotSwapWithPreviewCancelled

Microsoft.Web.SlotSwapWithPreviewCancelled: (o: any) => Promise<any> = makeDeserializerFromMapper(WebSlotSwapWithPreviewCancelledEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Microsoft.Web.SlotSwapWithPreviewStarted

Microsoft.Web.SlotSwapWithPreviewStarted: (o: any) => Promise<any> = makeDeserializerFromMapper(WebSlotSwapWithPreviewStartedEventData)

Type declaration

- (o: any): Promise<any>
- Parameters
  - o: any
  Returns Promise<any>

Const topicHostname

topicHostname: object

parameterPath

parameterPath: string = "topicHostname"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "topicHostname"

type

type: object

name

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ACSChatMemberAddedToThreadWithUserEventData

ACSChatMemberRemovedFromThreadWithUserEventData

ACSChatMessageDeletedEventData

ACSChatMessageEditedEventData

ACSChatMessageEventBase

ACSChatMessageReceivedEventData

ACSChatThreadCreatedWithUserEventData

ACSChatThreadEventBase

ACSChatThreadPropertiesUpdatedPerUserEventData

ACSChatThreadWithUserDeletedEventData

AcssmsDeliveryReportReceivedEventData

AcssmsReceivedEventData

AppAction

AsyncStatus

ContainerRegistryChartDeletedEventData

ContainerRegistryChartPushedEventData

ContainerRegistryImageDeletedEventData

ContainerRegistryImagePushedEventData

CustomEventDataDeserializer

Type declaration

Parameters

o: any

Returns Promise<any>

EventGridPublisherClientOptions

IotHubDeviceConnectedEventData

IotHubDeviceCreatedEventData

IotHubDeviceDeletedEventData

IotHubDeviceDisconnectedEventData

IotHubDeviceTelemetryEventData

KnownSystemEventTypes

MapsGeofenceEnteredEventData

MapsGeofenceExitedEventData

MapsGeofenceResultEventData

MediaJobCanceledEventData

MediaJobCancelingEventData

MediaJobErrorCategory

MediaJobErrorCode

MediaJobErroredEventData

MediaJobFinishedEventData

MediaJobOutputAsset

MediaJobOutputCanceledEventData

MediaJobOutputCancelingEventData

MediaJobOutputErroredEventData

MediaJobOutputFinishedEventData

MediaJobOutputProcessingEventData

MediaJobOutputScheduledEventData

MediaJobOutputUnion

MediaJobProcessingEventData

MediaJobRetry

MediaJobScheduledEventData

MediaJobState

SendCloudEventsOptions

SendCustomSchemaEventsOptions

SendEventsOptions

StampKind

Variables

Const API_KEY_HEADER_NAME

Const CLOUD_EVENT_1_0_SPEC_VERSION

Const DEFAULT_API_VERSION

Const EVENT_GRID_SCHEMA_METADATA_VERSION

Const SAS_TOKEN_HEADER_NAME

Const SDK_VERSION

Const cloudEventReservedPropertyNames

Const logger

Const packageName

Const packageVersion

Const serializer

Functions

convertCloudEventToModelType

Parameters

event: SendCloudEventInput<any>

Returns CloudEventWireModel