@azure/eventgrid package

Classes

AzureKeyCredential	A static-key-based credential that supports updating the underlying key value.
AzureSASCredential	A static-signature-based credential that supports updating the underlying signature value.
EventGridDeserializer	EventGridDeserializer is used to aid in processing events delivered by EventGrid. It can deserialize a JSON encoded payload of either a single event or batch of events as well as be used to convert the result of JSON.parse into an EventGridEvent or CloudEvent like object. Unlike normal JSON deseralization, EventGridDeserializer does some additional conversions: The consumer parses the event time property into a Date object, for ease of use. When deserializing an event in the CloudEvent schema, if the event contains binary data, it is base64 decoded and returned as an instance of the Uint8Array type.
EventGridPublisherClient	Client class for publishing events to the Event Grid Service.

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
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.
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	An event in the Cloud Event 1.0 schema.
CloudEventSendOptions	Options for the send events operation, when the input schema is cloud event.
CommunicationIdentifierModel	Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.
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.
GenerateSharedAccessSignatureOptions
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.
InputSchemaToInputTypeMap	A map of input schema names to shapes of the input for the send method on EventGridPublisherClient.
InputSchemaToOptionsTypeMap	A map of input schema names to shapes of the options bag for the send method on EventGridPublisherClient.
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.
MediaJobCanceledEventData	Job canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceled event.
MediaJobCancelingEventData	Job canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceling event.
MediaJobError	Details of JobOutput errors.
MediaJobErrorDetail	Details of JobOutput errors.
MediaJobErroredEventData	Job error state event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobErrored event.
MediaJobFinishedEventData	Job finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobFinished event.
MediaJobOutput	The event data for a Job output.
MediaJobOutputAsset	The event data for a Job output asset.
MediaJobOutputCanceledEventData	Job output canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceled event.
MediaJobOutputCancelingEventData	Job output canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceling event.
MediaJobOutputErroredEventData	Job output error event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputErrored event.
MediaJobOutputFinishedEventData	Job output finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputFinished event.
MediaJobOutputProcessingEventData	Job output processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputProcessing event.
MediaJobOutputProgressEventData	Job Output Progress Event Data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputProgress event.
MediaJobOutputScheduledEventData	Job output scheduled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputScheduled event.
MediaJobOutputStateChangeEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.
MediaJobProcessingEventData	Job processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobProcessing event.
MediaJobScheduledEventData	Job scheduled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobScheduled event.
MediaJobStateChangeEventData	Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.
MediaLiveEventChannelArchiveHeartbeatEventData	Channel Archive heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventChannelArchiveHeartbeat event.
MediaLiveEventConnectionRejectedEventData	Encoder connection rejected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventConnectionRejected event.
MediaLiveEventEncoderConnectedEventData	Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderConnected event.
MediaLiveEventEncoderDisconnectedEventData	Encoder disconnected event data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.LiveEventEncoderDisconnected event.
MediaLiveEventIncomingDataChunkDroppedEventData	Ingest fragment dropped event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingDataChunkDropped event.
MediaLiveEventIncomingStreamReceivedEventData	Encoder connect event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamReceived event.
MediaLiveEventIncomingStreamsOutOfSyncEventData	Incoming streams out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingStreamsOutOfSync event.
MediaLiveEventIncomingVideoStreamsOutOfSyncEventData	Incoming video stream out of sync event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIncomingVideoStreamsOutOfSync event.
MediaLiveEventIngestHeartbeatEventData	Ingest heartbeat event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventIngestHeartbeat event.
MediaLiveEventTrackDiscontinuityDetectedEventData	Ingest track discontinuity detected event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.LiveEventTrackDiscontinuityDetected 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.
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.
ResourceNotificationsContainerServiceEventResourcesScheduledEventData	Schema of the Data property of an event grid event for a Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted preview event.
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.
SendCloudEventInput	The shape of the input for EventGridProducerClient#sendCloudEvents
SendEventGridEventInput	The shape of the input for EventGridProducerClient#sendEventGridEvents
ServiceBusActiveMessagesAvailableWithNoListenersEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.
ServiceBusDeadletterMessagesAvailableWithNoListenersEventData	Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners 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.
StorageLifecyclePolicyRunSummary	Policy run status of an account in a Blob Management cycle.
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.
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	Defines values for AcsEmailDeliveryReportStatus. 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 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	Defines values for AcsInteractiveReplyKind. 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	Defines values for AcsMessageChannelKind. 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	Defines values for AcsMessageDeliveryStatus. 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	Defines values for AcsRouterJobStatus. 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	Defines values for AcsRouterLabelOperator. 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	Defines values for AcsRouterUpdatedWorkerProperty. 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	Defines values for AcsRouterWorkerSelectorState. 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 Job Worker Selector is Active expired: Router Job Worker Selector has Expire
AcsUserEngagement	Defines values for AcsUserEngagement. 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	Defines values for AppAction. 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	Defines values for AppServicePlanAction. 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	Defines values for AsyncStatus. 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	Defines values for CommunicationCloudEnvironmentModel. 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	Defines values for CommunicationIdentifierModelKind. 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 microsoftTeamsApp
DataBoxStageName	Defines values for DataBoxStageName. 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	Defines values for EventGridMqttClientDisconnectionReason. 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 initiates 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	Defines values for EventGridMqttClientState. 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
EventGridPublisherClientOptions	Options for the Event Grid Client.
HealthcareFhirResourceType	Defines values for HealthcareFhirResourceType. 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.
InputSchema	Allowed schema types, to be used when constructing the EventGridPublisherClient.
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.
MediaJobErrorCategory	Defines values for MediaJobErrorCategory.
MediaJobErrorCode	Defines values for MediaJobErrorCode.
MediaJobOutputUnion
MediaJobRetry	Defines values for MediaJobRetry.
MediaJobState	Defines values for MediaJobState.
RecordingChannelType	Defines values for RecordingChannelType. 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	Defines values for RecordingContentType. 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	Defines values for RecordingFormatType. 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
SendOptions	Options for the send events operation.
StampKind	Defines values for StampKind. 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	Defines values for StorageBlobAccessTier. <xref: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)
StorageLifecycleCompletionStatus	Defines values for StorageLifecycleCompletionStatus. KnownStorageLifecycleCompletionStatus can be used interchangeably with StorageLifecycleCompletionStatus, this enum contains the known values that the service supports. Known values supported by the service Completed CompletedWithError Incomplete
StorageTaskAssignmentCompletedStatus	Defines values for StorageTaskAssignmentCompletedStatus. 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	Defines values for StorageTaskCompletedStatus. 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.
KnownStorageLifecycleCompletionStatus	Known values of StorageLifecycleCompletionStatus that the service accepts.
KnownStorageTaskAssignmentCompletedStatus	Known values of StorageTaskAssignmentCompletedStatus that the service accepts.
KnownStorageTaskCompletedStatus	Known values of StorageTaskCompletedStatus that the service accepts.

Functions

generateSharedAccessSignature(string, KeyCredential, Date, GenerateSharedAccessSignatureOptions)	Generate a shared access signature, which allows a client to send events to an Event Grid Topic or Domain for a limited period of time. This function may only be called when the EventGridPublisherClient was constructed with a KeyCredential instance.
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

generateSharedAccessSignature(string, KeyCredential, Date, GenerateSharedAccessSignatureOptions)

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

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

Parameters

endpointUrl

string

The endpoint for the topic or domain you wish to generate a shared access signature for.

credential

KeyCredential

The credential to use when generating the shared access signatrue.

expiresOnUtc

Date

options

GenerateSharedAccessSignatureOptions

Options to control how the signature is generated.

Returns

Promise<string>

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