@azure/eventgrid package

Classes

EventGridClient
EventGridClientContext

Interfaces

AppConfigurationKeyValueDeletedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.

AppConfigurationKeyValueModifiedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.

BaseResource
CloudError
ContainerRegistryArtifactEventData

The content of the event request message.

ContainerRegistryArtifactEventTarget

The target of the event.

ContainerRegistryChartDeletedEventData

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

ContainerRegistryChartPushedEventData

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

ContainerRegistryEventActor

The agent that initiated the event. For most situations, this could be from the authorization context of the request.

ContainerRegistryEventData

The content of the event request message.

ContainerRegistryEventRequest

The request that generated the event.

ContainerRegistryEventSource

The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.

ContainerRegistryEventTarget

The target of the event.

ContainerRegistryImageDeletedEventData

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

ContainerRegistryImagePushedEventData

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

DeviceConnectionStateEventInfo

Information about the device connection state event.

DeviceConnectionStateEventProperties

Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).

DeviceLifeCycleEventProperties

Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).

DeviceTelemetryEventProperties

Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).

DeviceTwinInfo

Information about the device twin, which is the cloud representation of application device metadata.

DeviceTwinInfoProperties

Properties JSON element.

DeviceTwinInfoX509Thumbprint

The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate.

DeviceTwinMetadata

Metadata information for the properties JSON document.

DeviceTwinProperties

A portion of the properties that can be written only by the application back-end, and read by the device.

EventGridEvent

Properties of an event published to an Event Grid topic.

EventHubCaptureFileCreatedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.

IotHubDeviceConnectedEventData

Event data for Microsoft.Devices.DeviceConnected event.

IotHubDeviceCreatedEventData

Event data for Microsoft.Devices.DeviceCreated event.

IotHubDeviceDeletedEventData

Event data for Microsoft.Devices.DeviceDeleted event.

IotHubDeviceDisconnectedEventData

Event data for Microsoft.Devices.DeviceDisconnected event.

IotHubDeviceTelemetryEventData

Event data for Microsoft.Devices.DeviceTelemetry event.

KeyVaultCertificateExpiredEventData

Schema of the Data property of an EventGridEvent for an CertificateExpired event.

KeyVaultCertificateNearExpiryEventData

Schema of the Data property of an EventGridEvent for an CertificateNearExpiry event.

KeyVaultCertificateNewVersionCreatedEventData

Schema of the Data property of an EventGridEvent for an CertificateNewVersionCreated event.

KeyVaultKeyExpiredEventData

Schema of the Data property of an EventGridEvent for an KeyExpired event.

KeyVaultKeyNearExpiryEventData

Schema of the Data property of an EventGridEvent for an KeyNearExpiry event.

KeyVaultKeyNewVersionCreatedEventData

Schema of the Data property of an EventGridEvent for an KeyNewVersionCreated event.

KeyVaultSecretExpiredEventData

Schema of the Data property of an EventGridEvent for an SecretExpired event.

KeyVaultSecretNearExpiryEventData

Schema of the Data property of an EventGridEvent for an SecretNearExpiry event.

KeyVaultSecretNewVersionCreatedEventData

Schema of the Data property of an EventGridEvent for an SecretNewVersionCreated event.

MachineLearningServicesDatasetDriftDetectedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.DatasetDriftDetected event.

MachineLearningServicesModelDeployedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelDeployed event.

MachineLearningServicesModelRegisteredEventData

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelRegistered event.

MachineLearningServicesRunCompletedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.RunCompleted event.

MapsGeofenceEnteredEventData

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

MapsGeofenceEventProperties

Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).

MapsGeofenceExitedEventData

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

MapsGeofenceGeometry

The geofence geometry.

MapsGeofenceResultEventData

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

MediaJobCanceledEventData

Job canceled event data

MediaJobCancelingEventData

Job canceling event data

MediaJobError

Details of JobOutput errors.

MediaJobErrorDetail

Details of JobOutput errors.

MediaJobErroredEventData

Job error state event data

MediaJobFinishedEventData

Job finished event data

MediaJobOutput

The event data for a Job output.

MediaJobOutputAsset

The event data for a Job output asset.

MediaJobOutputCanceledEventData

Job output canceled event data

MediaJobOutputCancelingEventData

Job output canceling event data

MediaJobOutputErroredEventData

Job output error event data

MediaJobOutputFinishedEventData

Job output finished event data

MediaJobOutputProcessingEventData

Job output processing event data

MediaJobOutputProgressEventData

Job Output Progress Event Data.

MediaJobOutputScheduledEventData

Job output scheduled event data

MediaJobOutputStateChangeEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.

MediaJobProcessingEventData

Job processing event data

MediaJobScheduledEventData

Job scheduled event data

MediaJobStateChangeEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.

MediaLiveEventConnectionRejectedEventData

Encoder connection rejected event data.

MediaLiveEventEncoderConnectedEventData

Encoder connect event data.

MediaLiveEventEncoderDisconnectedEventData

Encoder disconnected event data.

MediaLiveEventIncomingDataChunkDroppedEventData

Ingest fragment dropped event data.

MediaLiveEventIncomingStreamReceivedEventData

Encoder connect event data.

MediaLiveEventIncomingStreamsOutOfSyncEventData

Incoming streams out of sync event data.

MediaLiveEventIncomingVideoStreamsOutOfSyncEventData

Incoming video stream out of synch event data.

MediaLiveEventIngestHeartbeatEventData

Ingest fragment dropped event data.

MediaLiveEventTrackDiscontinuityDetectedEventData

Ingest track discontinuity detected event data.

ResourceActionCancelData

Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.

ResourceActionFailureData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.

ResourceActionSuccessData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.

ResourceDeleteCancelData

Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.

ResourceDeleteFailureData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.

ResourceDeleteSuccessData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.

ResourceWriteCancelData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteCancel event. This is raised when a resource create or update operation is canceled.

ResourceWriteFailureData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteFailure event. This is raised when a resource create or update operation fails.

ResourceWriteSuccessData

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceWriteSuccess event. This is raised when a resource create or update operation succeeds.

ServiceBusActiveMessagesAvailableWithNoListenersEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.

ServiceBusDeadletterMessagesAvailableWithNoListenersEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.

SignalRServiceClientConnectionConnectedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.

SignalRServiceClientConnectionDisconnectedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.

StorageBlobCreatedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.

StorageBlobDeletedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.

StorageBlobRenamedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobRenamed event.

StorageDirectoryCreatedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryCreated event.

StorageDirectoryDeletedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryDeleted event.

StorageDirectoryRenamedEventData

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryRenamed event.

SubscriptionDeletedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.

SubscriptionValidationEventData

Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.

SubscriptionValidationResponse

To complete an event subscription validation handshake, a subscriber can use either the validationCode or the validationUrl received in a SubscriptionValidationEvent. When the validationCode is used, the SubscriptionValidationResponse can be used to build the response.

Type Aliases

MediaJobErrorCategory

Defines values for MediaJobErrorCategory. Possible values include: 'Service', 'Download', 'Upload', 'Configuration', 'Content'

MediaJobErrorCode

Defines values for MediaJobErrorCode. Possible values include: 'ServiceError', 'ServiceTransientError', 'DownloadNotAccessible', 'DownloadTransientError', 'UploadNotAccessible', 'UploadTransientError', 'ConfigurationUnsupported', 'ContentMalformed', 'ContentUnsupported'

MediaJobOutputUnion

Contains the possible cases for MediaJobOutput.

MediaJobRetry

Defines values for MediaJobRetry. Possible values include: 'DoNotRetry', 'MayRetry'

MediaJobState

Defines values for MediaJobState. Possible values include: 'Canceled', 'Canceling', 'Error', 'Finished', 'Processing', 'Queued', 'Scheduled'