@azure/eventgrid-system-events package

Interfaces

AcsChatEventBase	Schema of common properties of all chat events
AcsChatEventInThreadBase	Schema of common properties of all thread-level chat events
AcsChatMessageDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.
AcsChatMessageDeletedInThreadEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.
AcsChatMessageEditedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.
AcsChatMessageEditedInThreadEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.
AcsChatMessageEventBase	Schema of common properties of all chat message events
AcsChatMessageEventInThreadBase	Schema of common properties of all thread-level chat message events
AcsChatMessageReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.
AcsChatMessageReceivedInThreadEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.
AcsChatParticipantAddedToThreadEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.
AcsChatParticipantAddedToThreadWithUserEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.
AcsChatParticipantRemovedFromThreadEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.
AcsChatParticipantRemovedFromThreadWithUserEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.
AcsChatThreadCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.
AcsChatThreadCreatedWithUserEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.
AcsChatThreadDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.
AcsChatThreadEventBase	Schema of common properties of all chat thread events
AcsChatThreadEventInThreadBase	Schema of common properties of all chat thread events
AcsChatThreadParticipant	Schema of the chat thread participant
AcsChatThreadPropertiesUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.
AcsChatThreadPropertiesUpdatedPerUserEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.
AcsChatThreadWithUserDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.
AcsEmailDeliveryReportReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event.
AcsEmailDeliveryReportStatusDetails	Detailed information about the status if any
AcsEmailEngagementTrackingReportReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.
AcsIncomingCallCustomContext	Custom Context of Incoming Call
AcsIncomingCallEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event
AcsMessageButtonContent	Message Button Content
AcsMessageChannelEventError	Message Channel Event Error
AcsMessageContext	Message Context
AcsMessageDeliveryStatusUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.
AcsMessageEventData	Schema of common properties of all chat thread events
AcsMessageInteractiveButtonReplyContent	Message Interactive button reply content for a user to business message
AcsMessageInteractiveContent	Message Interactive Content
AcsMessageInteractiveListReplyContent	Message Interactive list reply content for a user to business message
AcsMessageMediaContent	Message Media Content
AcsMessageReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.
AcsRecordingChunkInfo	Schema for all properties of Recording Chunk Information.
AcsRecordingFileStatusUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.
AcsRecordingStorageInfo	Schema for all properties of Recording Storage Information.
AcsRouterChannelConfiguration	Router Channel Configuration
AcsRouterCommunicationError	Router Communication Error
AcsRouterEventData	Schema of common properties of all Router events
AcsRouterJobCancelledEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event
AcsRouterJobClassificationFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event
AcsRouterJobClassifiedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event
AcsRouterJobClosedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event
AcsRouterJobCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event
AcsRouterJobDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event
AcsRouterJobEventData	Schema of common properties of all Router Job events
AcsRouterJobExceptionTriggeredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event
AcsRouterJobQueuedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event
AcsRouterJobReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event
AcsRouterJobSchedulingFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event
AcsRouterJobUnassignedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event
AcsRouterJobWaitingForActivationEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event
AcsRouterJobWorkerSelectorsExpiredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event
AcsRouterQueueDetails	Router Queue Details
AcsRouterWorkerDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event
AcsRouterWorkerDeregisteredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event
AcsRouterWorkerEventData	Schema of common properties of all Router Worker events
AcsRouterWorkerOfferAcceptedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event
AcsRouterWorkerOfferDeclinedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event
AcsRouterWorkerOfferExpiredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event
AcsRouterWorkerOfferIssuedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event
AcsRouterWorkerOfferRevokedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event
AcsRouterWorkerRegisteredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event
AcsRouterWorkerSelector	Router Job Worker Selector
AcsRouterWorkerUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.
AcsSmsDeliveryAttempt	Schema for details of a delivery attempt
AcsSmsDeliveryReportReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.
AcsSmsEventBase	Schema of common properties of all SMS events
AcsSmsReceivedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.
AcsUserDisconnectedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.
ApiCenterApiDefinitionAddedEventData	Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.
ApiCenterApiDefinitionUpdatedEventData	Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.
ApiCenterApiSpecification	API specification details.
ApiManagementApiCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.
ApiManagementApiDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.
ApiManagementApiReleaseCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event.
ApiManagementApiReleaseDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event.
ApiManagementApiReleaseUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event.
ApiManagementApiUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.
ApiManagementGatewayApiAddedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event.
ApiManagementGatewayApiRemovedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event.
ApiManagementGatewayCertificateAuthorityCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event.
ApiManagementGatewayCertificateAuthorityDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event.
ApiManagementGatewayCertificateAuthorityUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event.
ApiManagementGatewayCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event.
ApiManagementGatewayDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event.
ApiManagementGatewayHostnameConfigurationCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event.
ApiManagementGatewayHostnameConfigurationDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event.
ApiManagementGatewayHostnameConfigurationUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event.
ApiManagementGatewayUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.
ApiManagementProductCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.
ApiManagementProductDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.
ApiManagementProductUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.
ApiManagementSubscriptionCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.
ApiManagementSubscriptionDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.
ApiManagementSubscriptionUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.
ApiManagementUserCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.
ApiManagementUserDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.
ApiManagementUserUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.
AppConfigurationKeyValueDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.
AppConfigurationKeyValueModifiedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.
AppConfigurationSnapshotCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.
AppConfigurationSnapshotEventData	Schema of common properties of snapshot events
AppConfigurationSnapshotModifiedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.
AppEventTypeDetail	Detail of action on the app.
AppServicePlanEventTypeDetail	Detail of action on the app service plan.
AvsClusterCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.
AvsClusterDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.
AvsClusterEventData	Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.
AvsClusterFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.
AvsClusterUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.
AvsClusterUpdatingEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.
AvsPrivateCloudEventData	Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.
AvsPrivateCloudFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.
AvsPrivateCloudUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.
AvsPrivateCloudUpdatingEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.
AvsScriptExecutionCancelledEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.
AvsScriptExecutionEventData	Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.
AvsScriptExecutionFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.
AvsScriptExecutionFinishedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.
AvsScriptExecutionStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.
CloudEvent	Cloud Event Schema.
CommunicationIdentifierModel	Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model must be interpreted as a union: Apart from rawId, at most one further property may be set.
CommunicationUserIdentifierModel	A user that got created with an Azure Communication Services resource.
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.
ContainerRegistryEventConnectedRegistry	The connected registry information if the event is generated by a connected registry.
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.
ContainerServiceClusterSupportEndedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event
ContainerServiceClusterSupportEndingEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event
ContainerServiceClusterSupportEventData	Schema of common properties of cluster support events
ContainerServiceNewKubernetesVersionAvailableEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event
ContainerServiceNodePoolRollingEventData	Schema of common properties of node pool rolling events
ContainerServiceNodePoolRollingFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event
ContainerServiceNodePoolRollingStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event
ContainerServiceNodePoolRollingSucceededEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event
DataBoxCopyCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event.
DataBoxCopyStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event.
DataBoxOrderCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event.
DeviceConnectionStateEvent	Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).
DeviceConnectionStateEventInfo	Information about the device connection state event.
DeviceLifeCycleEvent	Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).
DeviceTelemetryEvent	Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).
DeviceTwin	A portion of the properties that can be written only by the application back-end, and read by the device.
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.
EventGridEvent	An event in the in the Event Grid Schema.
EventGridMqttClientCreatedOrUpdatedEventData	Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.
EventGridMqttClientDeletedEventData	Event data for Microsoft.EventGrid.MQTTClientDeleted event.
EventGridMqttClientEventData	Schema of the Data property of an EventGridEvent for MQTT Client state changes.
EventGridMqttClientSessionConnectedEventData	Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.
EventGridMqttClientSessionDisconnectedEventData	Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.
EventHubCaptureFileCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.
HealthcareDicomImageCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.
HealthcareDicomImageDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.
HealthcareDicomImageUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.
HealthcareFhirResourceCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event.
HealthcareFhirResourceDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event.
HealthcareFhirResourceUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated 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.
KeyVaultAccessPolicyChangedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.
KeyVaultCertificateExpiredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.
KeyVaultCertificateNearExpiryEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.
KeyVaultCertificateNewVersionCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.
KeyVaultKeyExpiredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.
KeyVaultKeyNearExpiryEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.
KeyVaultKeyNewVersionCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.
KeyVaultSecretExpiredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.
KeyVaultSecretNearExpiryEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.
KeyVaultSecretNewVersionCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.
MachineLearningServicesDatasetDriftDetectedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.
MachineLearningServicesModelDeployedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.
MachineLearningServicesModelRegisteredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.
MachineLearningServicesRunCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.
MachineLearningServicesRunStatusChangedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.
MapsGeofenceEnteredEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.
MapsGeofenceEvent	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.
MicrosoftTeamsAppIdentifierModel	A Microsoft Teams application.
MicrosoftTeamsUserIdentifierModel	A Microsoft Teams user.
PhoneNumberIdentifierModel	A phone number.
PolicyInsightsPolicyStateChangedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateChanged event.
PolicyInsightsPolicyStateCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event.
PolicyInsightsPolicyStateDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateDeleted event.
RedisExportRDBCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.
RedisImportRDBCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.
RedisPatchingCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.
RedisScalingCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.
ResourceActionCancelEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.
ResourceActionFailureEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.
ResourceActionSuccessEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.
ResourceAuthorization	The details of the authorization for the resource.
ResourceDeleteCancelEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.
ResourceDeleteFailureEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.
ResourceDeleteSuccessEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.
ResourceHttpRequest	The details of the HTTP request.
ResourceNotificationsHealthResourcesAnnotatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated event.
ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged event.
ResourceNotificationsOperationalDetails	details of operational info
ResourceNotificationsResourceDeletedDetails	Describes the schema of the properties under resource info which are common across all ARN system topic delete events
ResourceNotificationsResourceDeletedEventData	Describes the schema of the common properties across all ARN system topic delete events
ResourceNotificationsResourceManagementCreatedOrUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.Resources.CreatedOrUpdated event.
ResourceNotificationsResourceManagementDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ResourceNotifications.Resources.Deleted event.
ResourceNotificationsResourceUpdatedDetails	Describes the schema of the properties under resource info which are common across all ARN system topic events
ResourceNotificationsResourceUpdatedEventData	Describes the schema of the common properties across all ARN system topic events
ResourceWriteCancelEventData	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.
ResourceWriteFailureEventData	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.
ResourceWriteSuccessEventData	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.
ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event.
ServiceBusActiveMessagesAvailableWithNoListenersEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.
ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event.
ServiceBusDeadletterMessagesAvailableWithNoListenersEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners 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.
StorageAsyncOperationInitiatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.
StorageBlobCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.
StorageBlobDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.
StorageBlobInventoryPolicyCompletedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.
StorageBlobRenamedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.
StorageBlobTierChangedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.
StorageDirectoryCreatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.
StorageDirectoryDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.
StorageDirectoryRenamedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.
StorageLifecyclePolicyActionSummaryDetail	Execution statistics of a specific policy action in a Blob Management cycle.
StorageLifecyclePolicyCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.
StorageTaskAssignmentCompletedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.
StorageTaskAssignmentQueuedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.
StorageTaskCompletedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.
StorageTaskQueuedEventData	Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.
SubscriptionDeletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent event.
SubscriptionValidationEventData	Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.
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.
SystemEventNameToEventData	A mapping of event type names to event data type interfaces.
WebAppServicePlanUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event.
WebAppServicePlanUpdatedEventDataSku	sku of app service plan.
WebAppUpdatedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event.
WebBackupOperationCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted event.
WebBackupOperationFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed event.
WebBackupOperationStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted event.
WebRestoreOperationCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted event.
WebRestoreOperationFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed event.
WebRestoreOperationStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted event.
WebSlotSwapCompletedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event.
WebSlotSwapFailedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event.
WebSlotSwapStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event.
WebSlotSwapWithPreviewCancelledEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewCancelled event.
WebSlotSwapWithPreviewStartedEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted event.

Type Aliases

AcsEmailDeliveryReportStatus	The status of the email. Any value other than Delivered is considered failed. KnownAcsEmailDeliveryReportStatus can be used interchangeably with AcsEmailDeliveryReportStatus, this enum contains the known values that the service supports. Known values supported by the service Bounced Delivered Failed FilteredSpam Quarantined Suppressed
AcsInteractiveReplyKind	Interactive reply kind KnownAcsInteractiveReplyKind can be used interchangeably with AcsInteractiveReplyKind, this enum contains the known values that the service supports. Known values supported by the service buttonReply listReply unknown
AcsMessageChannelKind	Message channel kind KnownAcsMessageChannelKind can be used interchangeably with AcsMessageChannelKind, this enum contains the known values that the service supports. Known values supported by the service whatsapp
AcsMessageDeliveryStatus	Message delivery status KnownAcsMessageDeliveryStatus can be used interchangeably with AcsMessageDeliveryStatus, this enum contains the known values that the service supports. Known values supported by the service read delivered failed sent warning unknown
AcsRouterJobStatus	Acs Router Job Status KnownAcsRouterJobStatus can be used interchangeably with AcsRouterJobStatus, this enum contains the known values that the service supports. Known values supported by the service PendingClassification Queued Assigned Completed Closed Cancelled ClassificationFailed Created PendingSchedule Scheduled ScheduleFailed WaitingForActivation
AcsRouterLabelOperator	Router Job Worker Selector Label Operator KnownAcsRouterLabelOperator can be used interchangeably with AcsRouterLabelOperator, this enum contains the known values that the service supports. Known values supported by the service Equal NotEqual Greater Less GreaterThanOrEqual LessThanOrEqual
AcsRouterUpdatedWorkerProperty	Worker properties that can be updated KnownAcsRouterUpdatedWorkerProperty can be used interchangeably with AcsRouterUpdatedWorkerProperty, this enum contains the known values that the service supports. Known values supported by the service AvailableForOffers TotalCapacity QueueAssignments Labels Tags ChannelConfigurations
AcsRouterWorkerSelectorState	Router Worker Selector State KnownAcsRouterWorkerSelectorState can be used interchangeably with AcsRouterWorkerSelectorState, this enum contains the known values that the service supports. Known values supported by the service active expired
AcsUserEngagement	The type of engagement user have with email. KnownAcsUserEngagement can be used interchangeably with AcsUserEngagement, this enum contains the known values that the service supports. Known values supported by the service view click
AppAction	Type of action of the operation KnownAppAction can be used interchangeably with AppAction, this enum contains the known values that the service supports. Known values supported by the service Restarted Stopped ChangedAppSettings Started Completed Failed
AppServicePlanAction	Type of action on the app service plan. KnownAppServicePlanAction can be used interchangeably with AppServicePlanAction, this enum contains the known values that the service supports. Known values supported by the service Updated
AsyncStatus	Asynchronous operation status of the operation on the app service plan. KnownAsyncStatus can be used interchangeably with AsyncStatus, this enum contains the known values that the service supports. Known values supported by the service Started Completed Failed
CommunicationCloudEnvironmentModel	Communication cloud environment model. KnownCommunicationCloudEnvironmentModel can be used interchangeably with CommunicationCloudEnvironmentModel, this enum contains the known values that the service supports. Known values supported by the service public dod gcch
CommunicationIdentifierModelKind	Communication model identifier kind KnownCommunicationIdentifierModelKind can be used interchangeably with CommunicationIdentifierModelKind, this enum contains the known values that the service supports. Known values supported by the service unknown communicationUser phoneNumber microsoftTeamsUser
DataBoxStageName	Schema of DataBox Stage Name enumeration. KnownDataBoxStageName can be used interchangeably with DataBoxStageName, this enum contains the known values that the service supports. Known values supported by the service CopyStarted CopyCompleted OrderCompleted
EventGridMqttClientDisconnectionReason	EventGrid MQTT Client Disconnection Reason KnownEventGridMqttClientDisconnectionReason can be used interchangeably with EventGridMqttClientDisconnectionReason, this enum contains the known values that the service supports. Known values supported by the service ClientAuthenticationError ClientAuthorizationError ClientError ClientInitiatedDisconnect ConnectionLost IpForbidden QuotaExceeded ServerError ServerInitiatedDisconnect SessionOverflow SessionTakenOver
EventGridMqttClientState	EventGrid MQTT Client State KnownEventGridMqttClientState can be used interchangeably with EventGridMqttClientState, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
HealthcareFhirResourceType	Schema of FHIR resource type enumeration. KnownHealthcareFhirResourceType can be used interchangeably with HealthcareFhirResourceType, this enum contains the known values that the service supports. Known values supported by the service Account ActivityDefinition AdverseEvent AllergyIntolerance Appointment AppointmentResponse AuditEvent Basic Binary BiologicallyDerivedProduct BodySite BodyStructure Bundle CapabilityStatement CarePlan CareTeam CatalogEntry ChargeItem ChargeItemDefinition Claim ClaimResponse ClinicalImpression CodeSystem Communication CommunicationRequest CompartmentDefinition Composition ConceptMap Condition Consent Contract Coverage CoverageEligibilityRequest CoverageEligibilityResponse DataElement DetectedIssue Device DeviceComponent DeviceDefinition DeviceMetric DeviceRequest DeviceUseStatement DiagnosticReport DocumentManifest DocumentReference DomainResource EffectEvidenceSynthesis EligibilityRequest EligibilityResponse Encounter Endpoint EnrollmentRequest EnrollmentResponse EpisodeOfCare EventDefinition Evidence EvidenceVariable ExampleScenario ExpansionProfile ExplanationOfBenefit FamilyMemberHistory Flag Goal GraphDefinition Group GuidanceResponse HealthcareService ImagingManifest ImagingStudy Immunization ImmunizationEvaluation ImmunizationRecommendation ImplementationGuide InsurancePlan Invoice Library Linkage List Location Measure MeasureReport Media Medication MedicationAdministration MedicationDispense MedicationKnowledge MedicationRequest MedicationStatement MedicinalProduct MedicinalProductAuthorization MedicinalProductContraindication MedicinalProductIndication MedicinalProductIngredient MedicinalProductInteraction MedicinalProductManufactured MedicinalProductPackaged MedicinalProductPharmaceutical MedicinalProductUndesirableEffect MessageDefinition MessageHeader MolecularSequence NamingSystem NutritionOrder Observation ObservationDefinition OperationDefinition OperationOutcome Organization OrganizationAffiliation Parameters Patient PaymentNotice PaymentReconciliation Person PlanDefinition Practitioner PractitionerRole Procedure ProcedureRequest ProcessRequest ProcessResponse Provenance Questionnaire QuestionnaireResponse ReferralRequest RelatedPerson RequestGroup ResearchDefinition ResearchElementDefinition ResearchStudy ResearchSubject Resource RiskAssessment RiskEvidenceSynthesis Schedule SearchParameter Sequence ServiceDefinition ServiceRequest Slot Specimen SpecimenDefinition StructureDefinition StructureMap Subscription Substance SubstanceNucleicAcid SubstancePolymer SubstanceProtein SubstanceReferenceInformation SubstanceSourceMaterial SubstanceSpecification SupplyDelivery SupplyRequest Task TerminologyCapabilities TestReport TestScript ValueSet VerificationResult VisionPrescription
KnownSystemEventTypes	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.
RecordingChannelType	Recording channel type KnownRecordingChannelType can be used interchangeably with RecordingChannelType, this enum contains the known values that the service supports. Known values supported by the service Mixed Unmixed
RecordingContentType	Recording content type KnownRecordingContentType can be used interchangeably with RecordingContentType, this enum contains the known values that the service supports. Known values supported by the service AudioVideo Audio
RecordingFormatType	Recording format type KnownRecordingFormatType can be used interchangeably with RecordingFormatType, this enum contains the known values that the service supports. Known values supported by the service Wav Mp3 Mp4
ServiceApiVersions	Type of ServiceApiVersions
StampKind	Kind of environment where app service plan is. KnownStampKind can be used interchangeably with StampKind, this enum contains the known values that the service supports. Known values supported by the service Public AseV1 AseV2
StorageBlobAccessTier	The access tier of the blob. KnownStorageBlobAccessTier can be used interchangeably with StorageBlobAccessTier, this enum contains the known values that the service supports. Known values supported by the service Hot Cool Cold Archive Default
StorageTaskAssignmentCompletedStatus	The status for a storage task. KnownStorageTaskAssignmentCompletedStatus can be used interchangeably with StorageTaskAssignmentCompletedStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed
StorageTaskCompletedStatus	The status for a storage task. KnownStorageTaskCompletedStatus can be used interchangeably with StorageTaskCompletedStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed

Enums

KnownAcsEmailDeliveryReportStatus	Known values of AcsEmailDeliveryReportStatus that the service accepts.
KnownAcsInteractiveReplyKind	Known values of AcsInteractiveReplyKind that the service accepts.
KnownAcsMessageChannelKind	Known values of AcsMessageChannelKind that the service accepts.
KnownAcsMessageDeliveryStatus	Known values of AcsMessageDeliveryStatus that the service accepts.
KnownAcsRouterJobStatus	Known values of AcsRouterJobStatus that the service accepts.
KnownAcsRouterLabelOperator	Known values of AcsRouterLabelOperator that the service accepts.
KnownAcsRouterUpdatedWorkerProperty	Known values of AcsRouterUpdatedWorkerProperty that the service accepts.
KnownAcsRouterWorkerSelectorState	Known values of AcsRouterWorkerSelectorState that the service accepts.
KnownAcsUserEngagement	Known values of AcsUserEngagement that the service accepts.
KnownAppAction	Known values of AppAction that the service accepts.
KnownAppServicePlanAction	Known values of AppServicePlanAction that the service accepts.
KnownAsyncStatus	Known values of AsyncStatus that the service accepts.
KnownCommunicationCloudEnvironmentModel	Known values of CommunicationCloudEnvironmentModel that the service accepts.
KnownCommunicationIdentifierModelKind	Known values of CommunicationIdentifierModelKind that the service accepts.
KnownDataBoxStageName	Known values of DataBoxStageName that the service accepts.
KnownEventGridMqttClientDisconnectionReason	Known values of EventGridMqttClientDisconnectionReason that the service accepts.
KnownEventGridMqttClientState	Known values of EventGridMqttClientState that the service accepts.
KnownHealthcareFhirResourceType	Known values of HealthcareFhirResourceType that the service accepts.
KnownRecordingChannelType	Known values of RecordingChannelType that the service accepts.
KnownRecordingContentType	Known values of RecordingContentType that the service accepts.
KnownRecordingFormatType	Known values of RecordingFormatType that the service accepts.
KnownStampKind	Known values of StampKind that the service accepts.
KnownStorageBlobAccessTier	Known values of StorageBlobAccessTier that the service accepts.
KnownStorageTaskAssignmentCompletedStatus	Known values of StorageTaskAssignmentCompletedStatus that the service accepts.
KnownStorageTaskCompletedStatus	Known values of StorageTaskCompletedStatus that the service accepts.

Functions

isSystemEvent<T>(T, EventGridEvent<unknown>)	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
isSystemEvent<T>(T, CloudEvent<unknown>)	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

Function Details

isSystemEvent<T>(T, EventGridEvent<unknown>)

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

function isSystemEvent<T>(eventType: T, event: EventGridEvent<unknown>): event

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

isSystemEvent<T>(T, CloudEvent<unknown>)

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

function isSystemEvent<T>(eventType: T, event: CloudEvent<unknown>): event

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