Share via

@azure/eventgrid-systemevents package

Interfaces

AcsCallEndReason

Schema of calling event reason properties
AcsCallEndedBy

Schema of calling event ended by properties
AcsCallEndedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallEnded event.
AcsCallGroup

Schema of calling event group properties
AcsCallParticipant

Schema of common properties of all participant event user
AcsCallParticipantAddedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallParticipantAdded event.
AcsCallParticipantEvent

Schema of common properties of all participant events
AcsCallParticipantRemovedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallParticipantRemoved event.
AcsCallRoom

Schema of calling event room properties
AcsCallStartedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallStarted event.
AcsCallingEvent

Schema of common properties of all calling events
AcsChatAzureBotCommandReceivedInThreadEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatAzureBotCommandReceivedInThread event.
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.
AcsChatTypingIndicatorReceivedInThreadEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatTypingIndicatorReceivedInThread 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
AcsMessageReactionContent

Message Reaction 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.
ApiManagementCircuitBreaker

Information related to the circuit breaker configured on the backend.
ApiManagementCircuitBreakerClosedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.CircuitBreaker.Closed event.
ApiManagementCircuitBreakerOpenedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.CircuitBreaker.Opened event.
ApiManagementExpiredGatewayToken

Information related to a gateway token that has expired for a self-hosted gateway deployment.
ApiManagementGateway

Information related to a given self-hosted gateway deployment.
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.
ApiManagementGatewayTokenExpiredEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayTokenExpired event.
ApiManagementGatewayTokenNearExpiryEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayTokenNearExpiry event.
ApiManagementGatewayUpdatedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.
ApiManagementNearExpiryGatewayToken

Information related to a gateway token that is near expiry for a self-hosted gateway deployment.
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.
EdgeSolutionVersionPublishedEventData

Schema of the Data property of an EventGridEvent for a Microsoft.Edge.SolutionVersionPublished event.
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

AcsCallEndedByKind

Call ended participant kind.
KnownAcsCallEndedByKind can be used interchangeably with AcsCallEndedByKind, this enum contains the known values that the service supports.

Known values supported by the service

Participant: Participant
MicrosoftInternal: MicrosoftInternal
AcsCallParticipantKind

Call participant kind.
<xref:KnownAcsCallParticipantKind> can be used interchangeably with AcsCallParticipantKind, this enum contains the known values that the service supports.

Known values supported by the service

Attendee: Attendee
Presenter: Presenter
Organizer: Organizer
Consumer: Consumer
Collaborator: Collaborator
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: Hard bounce detected while sending the email
Delivered: The email was delivered
Failed: The email failed to be delivered
FilteredSpam: The message was identified as spam and was rejected or blocked (not quarantined).
Quarantined: The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION).
Suppressed: The email was 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: Messaged interactive reply type is ButtonReply
listReply: Messaged interactive reply type is ListReply
unknown: Messaged interactive reply type is 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: Updated message channel type is 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: Read
delivered: Delivered
failed: Failed
sent: Sent
warning: Warning
unknown: Unknown
AcsRecordingChannelType

Recording channel type
KnownAcsRecordingChannelType can be used interchangeably with AcsRecordingChannelType, this enum contains the known values that the service supports.

Known values supported by the service

Mixed: Mixed channel type
Unmixed: Unmixed channel type
AcsRecordingContentType

Recording content type
KnownAcsRecordingContentType can be used interchangeably with AcsRecordingContentType, this enum contains the known values that the service supports.

Known values supported by the service

AudioVideo: AudioVideo content type
Audio: Audio content type
AcsRecordingFormatType

Recording format type
KnownAcsRecordingFormatType can be used interchangeably with AcsRecordingFormatType, this enum contains the known values that the service supports.

Known values supported by the service

Wav: WAV format
Mp3: MP3 format
Mp4: MP4 format
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: Router Job Status Pending Classification
Queued: Router Job Status Queued
Assigned: Router Job Status Assigned
Completed: Router Job Status Completed
Closed: Router Job Status Closed
Cancelled: Router Job Status Cancelled
ClassificationFailed: Router Job Status Classification Failed
Created: Router Job Status Created
PendingSchedule: Router Job Status Pending Schedule
Scheduled: Router Job Status Scheduled
ScheduleFailed: Router Job Status Schedule Failed
WaitingForActivation: Router Job Status Waiting For Activation
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: Router Label Operator Equal
NotEqual: Router Label Operator Not Equal
Greater: Router Label Operator Greater
Less: Router Label Operator Less
GreaterThanOrEqual: Router Label Operator Greater than or equal
LessThanOrEqual: Router Label Operator Less than or equal
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: AvailableForOffers
TotalCapacity: TotalCapacity
QueueAssignments: QueueAssignments
Labels: Labels
Tags: Tags
ChannelConfigurations: 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: Router Worker Selector State Active
expired: Router Worker Selector State 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: View
click: 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: Web app was restarted.
Stopped: Web app was stopped.
ChangedAppSettings: There was an operation to change app setting on the web app.
Started: The job has started.
Completed: The job has completed.
Failed: The job has failed to complete.
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: App Service plan is being 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: Async operation has started.
Completed: Async operation has completed.
Failed: Async operation failed to complete.
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: Public
dod: Dod
gcch: 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: Unknown
communicationUser: Communication User
phoneNumber: Phone Number
microsoftTeamsUser: Microsoft Teams User
microsoftTeamsApp: Microsoft Teams App
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: Copy has started
CopyCompleted: Copy has completed
OrderCompleted: Order has been completed
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: The client got disconnected for any authentication reasons (for example, certificate expired, client got disabled, or client configuration changed).
ClientAuthorizationError: The client got disconnected for any authorization reasons (for example, because of a change in the configuration of topic spaces, permission bindings, or client groups).
ClientError: The client sent a bad request or used one of the unsupported features that resulted in a connection termination by the service.
ClientInitiatedDisconnect: The client initiated a graceful disconnect through a DISCONNECT packet for MQTT or a close frame for MQTT over WebSocket.
ConnectionLost: The client-server connection is lost. (EXCHANGE ONLINE PROTECTION).
IpForbidden: The client's IP address is blocked by IP filter or Private links configuration.
QuotaExceeded: The client exceeded one or more of the throttling limits that resulted in a connection termination by the service.
ServerError: The connection got terminated due to an unexpected server error.
ServerInitiatedDisconnect: The server initiates a graceful disconnect for any operational reason.
SessionOverflow: The client's queue for unacknowledged QoS1 messages reached its limit, which resulted in a connection termination by the server.
SessionTakenOver: The client reconnected with the same authentication name, which resulted in the termination of the previous connection.
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: Enabled
Disabled: 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: The FHIR resource type defined in STU3 and R4.
ActivityDefinition: The FHIR resource type defined in STU3 and R4.
AdverseEvent: The FHIR resource type defined in STU3 and R4.
AllergyIntolerance: The FHIR resource type defined in STU3 and R4.
Appointment: The FHIR resource type defined in STU3 and R4.
AppointmentResponse: The FHIR resource type defined in STU3 and R4.
AuditEvent: The FHIR resource type defined in STU3 and R4.
Basic: The FHIR resource type defined in STU3 and R4.
Binary: The FHIR resource type defined in STU3 and R4.
BiologicallyDerivedProduct: The FHIR resource type defined in R4.
BodySite: The FHIR resource type defined in STU3.
BodyStructure: The FHIR resource type defined in R4.
Bundle: The FHIR resource type defined in STU3 and R4.
CapabilityStatement: The FHIR resource type defined in STU3 and R4.
CarePlan: The FHIR resource type defined in STU3 and R4.
CareTeam: The FHIR resource type defined in STU3 and R4.
CatalogEntry: The FHIR resource type defined in R4.
ChargeItem: The FHIR resource type defined in STU3 and R4.
ChargeItemDefinition: The FHIR resource type defined in R4.
Claim: The FHIR resource type defined in STU3 and R4.
ClaimResponse: The FHIR resource type defined in STU3 and R4.
ClinicalImpression: The FHIR resource type defined in STU3 and R4.
CodeSystem: The FHIR resource type defined in STU3 and R4.
Communication: The FHIR resource type defined in STU3 and R4.
CommunicationRequest: The FHIR resource type defined in STU3 and R4.
CompartmentDefinition: The FHIR resource type defined in STU3 and R4.
Composition: The FHIR resource type defined in STU3 and R4.
ConceptMap: The FHIR resource type defined in STU3 and R4.
Condition: The FHIR resource type defined in STU3 and R4.
Consent: The FHIR resource type defined in STU3 and R4.
Contract: The FHIR resource type defined in STU3 and R4.
Coverage: The FHIR resource type defined in STU3 and R4.
CoverageEligibilityRequest: The FHIR resource type defined in R4.
CoverageEligibilityResponse: The FHIR resource type defined in R4.
DataElement: The FHIR resource type defined in STU3.
DetectedIssue: The FHIR resource type defined in STU3 and R4.
Device: The FHIR resource type defined in STU3 and R4.
DeviceComponent: The FHIR resource type defined in STU3.
DeviceDefinition: The FHIR resource type defined in R4.
DeviceMetric: The FHIR resource type defined in STU3 and R4.
DeviceRequest: The FHIR resource type defined in STU3 and R4.
DeviceUseStatement: The FHIR resource type defined in STU3 and R4.
DiagnosticReport: The FHIR resource type defined in STU3 and R4.
DocumentManifest: The FHIR resource type defined in STU3 and R4.
DocumentReference: The FHIR resource type defined in STU3 and R4.
DomainResource: The FHIR resource type defined in STU3 and R4.
EffectEvidenceSynthesis: The FHIR resource type defined in R4.
EligibilityRequest: The FHIR resource type defined in STU3.
EligibilityResponse: The FHIR resource type defined in STU3.
Encounter: The FHIR resource type defined in STU3 and R4.
Endpoint: The FHIR resource type defined in STU3 and R4.
EnrollmentRequest: The FHIR resource type defined in STU3 and R4.
EnrollmentResponse: The FHIR resource type defined in STU3 and R4.
EpisodeOfCare: The FHIR resource type defined in STU3 and R4.
EventDefinition: The FHIR resource type defined in R4.
Evidence: The FHIR resource type defined in R4.
EvidenceVariable: The FHIR resource type defined in R4.
ExampleScenario: The FHIR resource type defined in R4.
ExpansionProfile: The FHIR resource type defined in STU3.
ExplanationOfBenefit: The FHIR resource type defined in STU3 and R4.
FamilyMemberHistory: The FHIR resource type defined in STU3 and R4.
Flag: The FHIR resource type defined in STU3 and R4.
Goal: The FHIR resource type defined in STU3 and R4.
GraphDefinition: The FHIR resource type defined in STU3 and R4.
Group: The FHIR resource type defined in STU3 and R4.
GuidanceResponse: The FHIR resource type defined in STU3 and R4.
HealthcareService: The FHIR resource type defined in STU3 and R4.
ImagingManifest: The FHIR resource type defined in STU3.
ImagingStudy: The FHIR resource type defined in STU3 and R4.
Immunization: The FHIR resource type defined in STU3 and R4.
ImmunizationEvaluation: The FHIR resource type defined in R4.
ImmunizationRecommendation: The FHIR resource type defined in STU3 and R4.
ImplementationGuide: The FHIR resource type defined in STU3 and R4.
InsurancePlan: The FHIR resource type defined in R4.
Invoice: The FHIR resource type defined in R4.
Library: The FHIR resource type defined in STU3 and R4.
Linkage: The FHIR resource type defined in STU3 and R4.
List: The FHIR resource type defined in STU3 and R4.
Location: The FHIR resource type defined in STU3 and R4.
Measure: The FHIR resource type defined in STU3 and R4.
MeasureReport: The FHIR resource type defined in STU3 and R4.
Media: The FHIR resource type defined in STU3 and R4.
Medication: The FHIR resource type defined in STU3 and R4.
MedicationAdministration: The FHIR resource type defined in STU3 and R4.
MedicationDispense: The FHIR resource type defined in STU3 and R4.
MedicationKnowledge: The FHIR resource type defined in R4.
MedicationRequest: The FHIR resource type defined in STU3 and R4.
MedicationStatement: The FHIR resource type defined in STU3 and R4.
MedicinalProduct: The FHIR resource type defined in R4.
MedicinalProductAuthorization: The FHIR resource type defined in R4.
MedicinalProductContraindication: The FHIR resource type defined in R4.
MedicinalProductIndication: The FHIR resource type defined in R4.
MedicinalProductIngredient: The FHIR resource type defined in R4.
MedicinalProductInteraction: The FHIR resource type defined in R4.
MedicinalProductManufactured: The FHIR resource type defined in R4.
MedicinalProductPackaged: The FHIR resource type defined in R4.
MedicinalProductPharmaceutical: The FHIR resource type defined in R4.
MedicinalProductUndesirableEffect: The FHIR resource type defined in R4.
MessageDefinition: The FHIR resource type defined in STU3 and R4.
MessageHeader: The FHIR resource type defined in STU3 and R4.
MolecularSequence: The FHIR resource type defined in R4.
NamingSystem: The FHIR resource type defined in STU3 and R4.
NutritionOrder: The FHIR resource type defined in STU3 and R4.
Observation: The FHIR resource type defined in STU3 and R4.
ObservationDefinition: The FHIR resource type defined in R4.
OperationDefinition: The FHIR resource type defined in STU3 and R4.
OperationOutcome: The FHIR resource type defined in STU3 and R4.
Organization: The FHIR resource type defined in STU3 and R4.
OrganizationAffiliation: The FHIR resource type defined in R4.
Parameters: The FHIR resource type defined in STU3 and R4.
Patient: The FHIR resource type defined in STU3 and R4.
PaymentNotice: The FHIR resource type defined in STU3 and R4.
PaymentReconciliation: The FHIR resource type defined in STU3 and R4.
Person: The FHIR resource type defined in STU3 and R4.
PlanDefinition: The FHIR resource type defined in STU3 and R4.
Practitioner: The FHIR resource type defined in STU3 and R4.
PractitionerRole: The FHIR resource type defined in STU3 and R4.
Procedure: The FHIR resource type defined in STU3 and R4.
ProcedureRequest: The FHIR resource type defined in STU3.
ProcessRequest: The FHIR resource type defined in STU3.
ProcessResponse: The FHIR resource type defined in STU3.
Provenance: The FHIR resource type defined in STU3 and R4.
Questionnaire: The FHIR resource type defined in STU3 and R4.
QuestionnaireResponse: The FHIR resource type defined in STU3 and R4.
ReferralRequest: The FHIR resource type defined in STU3.
RelatedPerson: The FHIR resource type defined in STU3 and R4.
RequestGroup: The FHIR resource type defined in STU3 and R4.
ResearchDefinition: The FHIR resource type defined in R4.
ResearchElementDefinition: The FHIR resource type defined in R4.
ResearchStudy: The FHIR resource type defined in STU3 and R4.
ResearchSubject: The FHIR resource type defined in STU3 and R4.
Resource: The FHIR resource type defined in STU3 and R4.
RiskAssessment: The FHIR resource type defined in STU3 and R4.
RiskEvidenceSynthesis: The FHIR resource type defined in R4.
Schedule: The FHIR resource type defined in STU3 and R4.
SearchParameter: The FHIR resource type defined in STU3 and R4.
Sequence: The FHIR resource type defined in STU3.
ServiceDefinition: The FHIR resource type defined in STU3.
ServiceRequest: The FHIR resource type defined in R4.
Slot: The FHIR resource type defined in STU3 and R4.
Specimen: The FHIR resource type defined in STU3 and R4.
SpecimenDefinition: The FHIR resource type defined in R4.
StructureDefinition: The FHIR resource type defined in STU3 and R4.
StructureMap: The FHIR resource type defined in STU3 and R4.
Subscription: The FHIR resource type defined in STU3 and R4.
Substance: The FHIR resource type defined in STU3 and R4.
SubstanceNucleicAcid: The FHIR resource type defined in R4.
SubstancePolymer: The FHIR resource type defined in R4.
SubstanceProtein: The FHIR resource type defined in R4.
SubstanceReferenceInformation: The FHIR resource type defined in R4.
SubstanceSourceMaterial: The FHIR resource type defined in R4.
SubstanceSpecification: The FHIR resource type defined in R4.
SupplyDelivery: The FHIR resource type defined in STU3 and R4.
SupplyRequest: The FHIR resource type defined in STU3 and R4.
Task: The FHIR resource type defined in STU3 and R4.
TerminologyCapabilities: The FHIR resource type defined in R4.
TestReport: The FHIR resource type defined in STU3 and R4.
TestScript: The FHIR resource type defined in STU3 and R4.
ValueSet: The FHIR resource type defined in STU3 and R4.
VerificationResult: The FHIR resource type defined in R4.
VisionPrescription: The FHIR resource type defined in STU3 and R4.
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.
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: App Service Plan is running on a public stamp.
AseV1: App Service Plan is running on an App Service Environment V1.
AseV2: App Service Plan is running on an App Service Environment V2.
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: The blob is in access tier Hot
Cool: The blob is in access tier Cool
Cold: The blob is in access tier Cold
Archive: The blob is in access tier Archive
Default: The blob is in access tier Default(Inferred)
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: Succeeded
Failed: 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: Succeeded
Failed: Failed

Enums

KnownAcsCallEndedByKind

Call ended participant kind.
KnownAcsEmailDeliveryReportStatus

The status of the email. Any value other than Delivered is considered failed.
KnownAcsInteractiveReplyKind

Interactive reply kind
KnownAcsMessageChannelKind

Message channel kind
KnownAcsMessageDeliveryStatus

Message delivery status
KnownAcsRecordingChannelType

Recording channel type
KnownAcsRecordingContentType

Recording content type
KnownAcsRecordingFormatType

Recording format type
KnownAcsRouterJobStatus

Acs Router Job Status
KnownAcsRouterLabelOperator

Router Job Worker Selector Label Operator
KnownAcsRouterUpdatedWorkerProperty

Worker properties that can be updated
KnownAcsRouterWorkerSelectorState

Router Worker Selector State
KnownAcsUserEngagement

The type of engagement user have with email.
KnownAppAction

Type of action of the operation
KnownAppServicePlanAction

Type of action on the app service plan.
KnownAsyncStatus

Asynchronous operation status of the operation on the app service plan.
KnownCommunicationCloudEnvironmentModel

Communication cloud environment model.
KnownCommunicationIdentifierModelKind

Communication model identifier kind
KnownDataBoxStageName

Schema of DataBox Stage Name enumeration.
KnownEventGridMqttClientDisconnectionReason

EventGrid MQTT Client Disconnection Reason
KnownEventGridMqttClientState

EventGrid MQTT Client State
KnownHealthcareFhirResourceType

Schema of FHIR resource type enumeration.
KnownStampKind

Kind of environment where app service plan is.
KnownStorageBlobAccessTier

The access tier of the blob.
KnownStorageTaskAssignmentCompletedStatus

The status for a storage task.
KnownStorageTaskCompletedStatus

The status for a storage task.

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