UNPKG

@azure/eventgrid-system-events

Version:

An isomorphic client library for the Azure Event Grid service.

974 lines 178 kB
/** Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event. */ export interface ApiCenterApiDefinitionAddedEventData { /** API definition title. */ title: string; /** API definition description. */ description?: string; /** API definition specification. */ specification?: ApiCenterApiSpecification; } /** API specification details. */ export interface ApiCenterApiSpecification { /** Specification name. */ name: string; /** Specification version. */ version?: string; } /** Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event. */ export interface ApiCenterApiDefinitionUpdatedEventData { /** API definition title. */ title: string; /** API definition description. */ description?: string; /** API definition specification. */ specification?: ApiCenterApiSpecification; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event. */ export interface ApiManagementUserCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event. */ export interface ApiManagementUserUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event. */ export interface ApiManagementUserDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event. */ export interface ApiManagementSubscriptionCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event. */ export interface ApiManagementSubscriptionUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event. */ export interface ApiManagementSubscriptionDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event. */ export interface ApiManagementProductCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event. */ export interface ApiManagementProductUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event. */ export interface ApiManagementProductDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event. */ export interface ApiManagementApiCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event. */ export interface ApiManagementApiUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event. */ export interface ApiManagementApiDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event. */ export interface ApiManagementApiReleaseCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event. */ export interface ApiManagementApiReleaseUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event. */ export interface ApiManagementApiReleaseDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event. */ export interface ApiManagementGatewayCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event. */ export interface ApiManagementGatewayUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event. */ export interface ApiManagementGatewayDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event. */ export interface ApiManagementGatewayHostnameConfigurationCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/hostnameConfigurations/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event. */ export interface ApiManagementGatewayHostnameConfigurationUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/hostnameConfigurations/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event. */ export interface ApiManagementGatewayHostnameConfigurationDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/hostnameConfigurations/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event. */ export interface ApiManagementGatewayCertificateAuthorityCreatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/certificateAuthorities/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event. */ export interface ApiManagementGatewayCertificateAuthorityUpdatedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/certificateAuthorities/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event. */ export interface ApiManagementGatewayCertificateAuthorityDeletedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/certificateAuthorities/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event. */ export interface ApiManagementGatewayApiAddedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/apis/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event. */ export interface ApiManagementGatewayApiRemovedEventData { /** The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/gateways/<GatewayName>/apis/<ResourceName>` */ resourceUri?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event. */ export interface AppConfigurationKeyValueModifiedEventData { /** The key used to identify the key-value that was modified. */ key?: string; /** The label, if any, used to identify the key-value that was modified. */ label?: string; /** The etag representing the new state of the key-value. */ etag?: string; /** The sync token representing the server state after the event. */ syncToken?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event. */ export interface AppConfigurationKeyValueDeletedEventData { /** The key used to identify the key-value that was deleted. */ key?: string; /** The label, if any, used to identify the key-value that was deleted. */ label?: string; /** The etag representing the key-value that was deleted. */ etag?: string; /** The sync token representing the server state after the event. */ syncToken?: string; } /** Schema of common properties of snapshot events */ export interface AppConfigurationSnapshotEventData { /** The name of the snapshot. */ name?: string; /** The etag representing the new state of the snapshot. */ etag?: string; /** The sync token representing the server state after the event. */ syncToken?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event. */ export interface AppConfigurationSnapshotCreatedEventData extends AppConfigurationSnapshotEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event. */ export interface AppConfigurationSnapshotModifiedEventData extends AppConfigurationSnapshotEventData { } /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events. */ export interface AvsPrivateCloudEventData { /** Id of the operation that caused this event. */ operationId: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event. */ export interface AvsPrivateCloudUpdatingEventData extends AvsPrivateCloudEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event. */ export interface AvsPrivateCloudUpdatedEventData extends AvsPrivateCloudEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event. */ export interface AvsPrivateCloudFailedEventData extends AvsPrivateCloudEventData { /** Failure reason of an event. */ failureMessage?: string; } /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events. */ export interface AvsClusterEventData { /** Id of the operation that caused this event. */ operationId: string; /** Hosts added to the cluster in this event, if any. */ addedHostNames?: string[]; /** Hosts removed from the cluster in this event, if any. */ removedHostNames?: string[]; /** Hosts in Maintenance mode in the cluster, if any. */ inMaintenanceHostNames?: string[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event. */ export interface AvsClusterCreatedEventData extends AvsClusterEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event. */ export interface AvsClusterDeletedEventData extends AvsClusterEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event. */ export interface AvsClusterUpdatingEventData extends AvsClusterEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event. */ export interface AvsClusterUpdatedEventData extends AvsClusterEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event. */ export interface AvsClusterFailedEventData extends AvsClusterEventData { /** Failure reason of an event. */ failureMessage?: string; } /** Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events. */ export interface AvsScriptExecutionEventData { /** Id of the operation that caused this event. */ operationId: string; /** Cmdlet referenced in the execution that caused this event. */ cmdletId: string; /** Stdout outputs from the execution, if any. */ output?: string[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event. */ export interface AvsScriptExecutionStartedEventData extends AvsScriptExecutionEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event. */ export interface AvsScriptExecutionFinishedEventData extends AvsScriptExecutionEventData { /** Named outputs of completed execution, if any. */ namedOutputs: Record<string, string>; } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event. */ export interface AvsScriptExecutionCancelledEventData extends AvsScriptExecutionEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event. */ export interface AvsScriptExecutionFailedEventData extends AvsScriptExecutionEventData { /** Failure reason of an event. */ failureMessage?: string; } /** Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event */ export interface AcsIncomingCallEventData { /** The communication identifier of the target user. */ toCommunicationIdentifier: CommunicationIdentifierModel; /** The communication identifier of the user who initiated the call. */ fromCommunicationIdentifier: CommunicationIdentifierModel; /** The Id of the server call */ serverCallId?: string; /** Display name of caller. */ callerDisplayName?: string; /** Custom Context of Incoming Call */ customContext: AcsIncomingCallCustomContext; /** Signed incoming call context. */ incomingCallContext?: string; /** The communication identifier of the user on behalf of whom the call is made. */ onBehalfOfCallee?: CommunicationIdentifierModel; /** CorrelationId (CallId). */ correlationId?: string; } /** 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. */ export interface CommunicationIdentifierModel { /** The identifier kind. Only required in responses. */ kind: CommunicationIdentifierModelKind; /** Raw Id of the identifier. Optional in requests, required in responses. */ rawId?: string; /** The communication user. */ communicationUser: CommunicationUserIdentifierModel; /** The phone number. */ phoneNumber: PhoneNumberIdentifierModel; /** The Microsoft Teams user. */ microsoftTeamsUser: MicrosoftTeamsUserIdentifierModel; /** The Microsoft Teams application. */ microsoftTeamsApp: MicrosoftTeamsAppIdentifierModel; } /** Known values of {@link CommunicationIdentifierModelKind} that the service accepts. */ export declare enum KnownCommunicationIdentifierModelKind { /** unknown */ unknown = "unknown", /** communicationUser */ communicationUser = "communicationUser", /** phoneNumber */ phoneNumber = "phoneNumber", /** microsoftTeamsUser */ microsoftTeamsUser = "microsoftTeamsUser" } /** * Communication model identifier kind * {@link 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** */ export type CommunicationIdentifierModelKind = string; /** A user that got created with an Azure Communication Services resource. */ export interface CommunicationUserIdentifierModel { /** The Id of the communication user. */ id: string; } /** A phone number. */ export interface PhoneNumberIdentifierModel { /** The phone number in E.164 format. */ value: string; } /** A Microsoft Teams user. */ export interface MicrosoftTeamsUserIdentifierModel { /** The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. */ userId: string; /** True if the Microsoft Teams user is anonymous. By default false if missing. */ isAnonymous?: boolean; /** The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. */ cloud: CommunicationCloudEnvironmentModel; } /** Known values of {@link CommunicationCloudEnvironmentModel} that the service accepts. */ export declare enum KnownCommunicationCloudEnvironmentModel { /** public */ "public" = "public", /** dod */ dod = "dod", /** gcch */ gcch = "gcch" } /** * Communication cloud environment model. * {@link 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** */ export type CommunicationCloudEnvironmentModel = string; /** A Microsoft Teams application. */ export interface MicrosoftTeamsAppIdentifierModel { /** The Id of the Microsoft Teams application */ appId: string; /** The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. */ cloud: CommunicationCloudEnvironmentModel; } /** Custom Context of Incoming Call */ export interface AcsIncomingCallCustomContext { /** Sip Headers for incoming call */ sipHeaders: Record<string, string>; /** Voip Headers for incoming call */ voipHeaders: Record<string, string>; } /** Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event. */ export interface AcsUserDisconnectedEventData { /** The communication identifier of the user who was disconnected */ userCommunicationIdentifier: CommunicationIdentifierModel; } /** Schema of common properties of all chat events */ export interface AcsChatEventBase { /** The communication identifier of the target user */ recipientCommunicationIdentifier: CommunicationIdentifierModel; /** The transaction id will be used as co-relation vector */ transactionId?: string; /** The chat thread id */ threadId?: string; } /** Schema of common properties of all thread-level chat events */ export interface AcsChatEventInThreadBase { /** The transaction id will be used as co-relation vector */ transactionId?: string; /** The chat thread id */ threadId?: string; } /** Schema of common properties of all chat message events */ export interface AcsChatMessageEventBase extends AcsChatEventBase { /** The chat message id */ messageId?: string; /** The communication identifier of the sender */ senderCommunicationIdentifier: CommunicationIdentifierModel; /** The display name of the sender */ senderDisplayName?: string; /** The original compose time of the message */ composeTime: Date; /** The type of the message */ type?: string; /** The version of the message */ version?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event. */ export interface AcsChatMessageReceivedEventData extends AcsChatMessageEventBase { /** The body of the chat message */ messageBody?: string; /** The chat message metadata */ metadata: Record<string, string>; } /** Schema of common properties of all thread-level chat message events */ export interface AcsChatMessageEventInThreadBase extends AcsChatEventInThreadBase { /** The chat message id */ messageId?: string; /** The communication identifier of the sender */ senderCommunicationIdentifier: CommunicationIdentifierModel; /** The display name of the sender */ senderDisplayName?: string; /** The original compose time of the message */ composeTime: Date; /** The type of the message */ type?: string; /** The version of the message */ version?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event. */ export interface AcsChatMessageReceivedInThreadEventData extends AcsChatMessageEventInThreadBase { /** The body of the chat message */ messageBody?: string; /** The chat message metadata */ metadata: Record<string, string>; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event. */ export interface AcsChatMessageEditedEventData extends AcsChatMessageEventBase { /** The body of the chat message */ messageBody?: string; /** The chat message metadata */ metadata: Record<string, string>; /** The time at which the message was edited */ editTime: Date; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event. */ export interface AcsChatMessageEditedInThreadEventData extends AcsChatMessageEventInThreadBase { /** The body of the chat message */ messageBody?: string; /** The chat message metadata */ metadata: Record<string, string>; /** The time at which the message was edited */ editTime: Date; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event. */ export interface AcsChatMessageDeletedEventData extends AcsChatMessageEventBase { /** The time at which the message was deleted */ deleteTime: Date; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event. */ export interface AcsChatMessageDeletedInThreadEventData extends AcsChatMessageEventInThreadBase { /** The time at which the message was deleted */ deleteTime: Date; } /** Schema of common properties of all chat thread events */ export interface AcsChatThreadEventBase extends AcsChatEventBase { /** The original creation time of the thread */ createTime: Date; /** The version of the thread */ version?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event. */ export interface AcsChatThreadCreatedWithUserEventData extends AcsChatThreadEventBase { /** The communication identifier of the user who created the thread */ createdByCommunicationIdentifier: CommunicationIdentifierModel; /** The thread properties */ properties: Record<string, any>; /** The thread metadata */ metadata: Record<string, string>; /** The list of properties of participants who are part of the thread */ participants: AcsChatThreadParticipant[]; } /** Schema of the chat thread participant */ export interface AcsChatThreadParticipant { /** The name of the user */ displayName?: string; /** The communication identifier of the user */ participantCommunicationIdentifier: CommunicationIdentifierModel; /** The metadata of the user */ metadata: Record<string, string>; } /** Schema of common properties of all chat thread events */ export interface AcsChatThreadEventInThreadBase extends AcsChatEventInThreadBase { /** The original creation time of the thread */ createTime: Date; /** The version of the thread */ version?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event. */ export interface AcsChatThreadCreatedEventData extends AcsChatThreadEventInThreadBase { /** The communication identifier of the user who created the thread */ createdByCommunicationIdentifier: CommunicationIdentifierModel; /** The thread properties */ properties: Record<string, any>; /** The thread metadata */ metadata: Record<string, string>; /** The list of properties of participants who are part of the thread */ participants: AcsChatThreadParticipant[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event. */ export interface AcsChatThreadWithUserDeletedEventData extends AcsChatThreadEventBase { /** The communication identifier of the user who deleted the thread */ deletedByCommunicationIdentifier: CommunicationIdentifierModel; /** The deletion time of the thread */ deleteTime: Date; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event. */ export interface AcsChatThreadDeletedEventData extends AcsChatThreadEventInThreadBase { /** The communication identifier of the user who deleted the thread */ deletedByCommunicationIdentifier: CommunicationIdentifierModel; /** The deletion time of the thread */ deleteTime: Date; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event. */ export interface AcsChatThreadPropertiesUpdatedPerUserEventData extends AcsChatThreadEventBase { /** The communication identifier of the user who updated the thread properties */ editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ editTime: Date; /** The thread metadata */ metadata: Record<string, string>; /** The updated thread properties */ properties: Record<string, any>; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event. */ export interface AcsChatThreadPropertiesUpdatedEventData extends AcsChatThreadEventInThreadBase { /** The communication identifier of the user who updated the thread properties */ editedByCommunicationIdentifier: CommunicationIdentifierModel; /** The time at which the properties of the thread were updated */ editTime: Date; /** The updated thread properties */ properties: Record<string, any>; /** The thread metadata */ metadata: Record<string, string>; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event. */ export interface AcsChatParticipantAddedToThreadWithUserEventData extends AcsChatThreadEventBase { /** The time at which the user was added to the thread */ time: Date; /** The communication identifier of the user who added the user */ addedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was added */ participantAdded: AcsChatThreadParticipant; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event. */ export interface AcsChatParticipantRemovedFromThreadWithUserEventData extends AcsChatThreadEventBase { /** The time at which the user was removed to the thread */ time: Date; /** The communication identifier of the user who removed the user */ removedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was removed */ participantRemoved: AcsChatThreadParticipant; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event. */ export interface AcsChatParticipantAddedToThreadEventData extends AcsChatEventInThreadBase { /** The time at which the user was added to the thread */ time: Date; /** The communication identifier of the user who added the user */ addedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was added */ participantAdded: AcsChatThreadParticipant; /** The version of the thread */ version?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event. */ export interface AcsChatParticipantRemovedFromThreadEventData extends AcsChatEventInThreadBase { /** The time at which the user was removed to the thread */ time: Date; /** The communication identifier of the user who removed the user */ removedByCommunicationIdentifier: CommunicationIdentifierModel; /** The details of the user who was removed */ participantRemoved: AcsChatThreadParticipant; /** The version of the thread */ version?: number; } /** Schema of common properties of all SMS events */ export interface AcsSmsEventBase { /** The identity of the SMS message */ messageId?: string; /** The identity of SMS message sender */ from?: string; /** The identity of SMS message receiver */ to?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event. */ export interface AcsSmsDeliveryReportReceivedEventData extends AcsSmsEventBase { /** Status of Delivery */ deliveryStatus?: string; /** Details about Delivery Status */ deliveryStatusDetails?: string; /** List of details of delivery attempts made */ deliveryAttempts: AcsSmsDeliveryAttempt[]; /** The time at which the SMS delivery report was received */ receivedTimestamp: Date; /** Customer Content */ tag?: string; } /** Schema for details of a delivery attempt */ export interface AcsSmsDeliveryAttempt { /** TimeStamp when delivery was attempted */ timestamp: Date; /** Number of segments that were successfully delivered */ segmentsSucceeded?: number; /** Number of segments whose delivery failed */ segmentsFailed?: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event. */ export interface AcsSmsReceivedEventData extends AcsSmsEventBase { /** The SMS content */ message?: string; /** The time at which the SMS was received */ receivedTimestamp: Date; /** Number of segments in the message */ segmentCount: number; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event. */ export interface AcsRecordingFileStatusUpdatedEventData { /** The details of recording storage information */ recordingStorageInfo: AcsRecordingStorageInfo; /** The time at which the recording started */ recordingStartTime: Date; /** The recording duration in milliseconds */ recordingDurationMs?: number; /** The recording content type- AudioVideo, or Audio */ recordingContentType: RecordingContentType; /** The recording channel type - Mixed, Unmixed */ recordingChannelType: RecordingChannelType; /** The recording format type - Mp4, Mp3, Wav */ recordingFormatType: RecordingFormatType; /** The reason for ending recording session */ sessionEndReason?: string; } /** Schema for all properties of Recording Storage Information. */ export interface AcsRecordingStorageInfo { /** List of details of recording chunks information */ recordingChunks: AcsRecordingChunkInfo[]; } /** Schema for all properties of Recording Chunk Information. */ export interface AcsRecordingChunkInfo { /** The documentId of the recording chunk */ documentId?: string; /** The index of the recording chunk */ index?: number; /** The reason for ending the recording chunk */ endReason?: string; /** The location of the metadata for this chunk */ metadataLocation?: string; /** The location of the content for this chunk */ contentLocation?: string; /** The location to delete all chunk storage */ deleteLocation?: string; } /** Known values of {@link RecordingContentType} that the service accepts. */ export declare enum KnownRecordingContentType { /** AudioVideo */ AudioVideo = "AudioVideo", /** Audio */ Audio = "Audio" } /** * Recording content type * {@link 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** */ export type RecordingContentType = string; /** Known values of {@link RecordingChannelType} that the service accepts. */ export declare enum KnownRecordingChannelType { /** Mixed */ Mixed = "Mixed", /** Unmixed */ Unmixed = "Unmixed" } /** * Recording channel type * {@link 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** */ export type RecordingChannelType = string; /** Known values of {@link RecordingFormatType} that the service accepts. */ export declare enum KnownRecordingFormatType { /** Wav */ Wav = "Wav", /** Mp3 */ Mp3 = "Mp3", /** Mp4 */ Mp4 = "Mp4" } /** * Recording format type * {@link 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** */ export type RecordingFormatType = string; /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event. */ export interface AcsEmailDeliveryReportReceivedEventData { /** The Sender Email Address */ sender: string; /** The recipient Email Address */ recipient: string; /** The Internet Message Id of the email that has been sent */ internetMessageId: string; /** The Id of the email that has been sent */ messageId?: string; /** The status of the email. Any value other than Delivered is considered failed. */ status: AcsEmailDeliveryReportStatus; /** Detailed information about the status if any */ deliveryStatusDetails: AcsEmailDeliveryReportStatusDetails; /** The time at which the email delivery report received timestamp */ deliveryAttemptTimestamp: Date; } /** Known values of {@link AcsEmailDeliveryReportStatus} that the service accepts. */ export declare enum KnownAcsEmailDeliveryReportStatus { /** Bounced */ Bounced = "Bounced", /** Delivered */ Delivered = "Delivered", /** Failed */ Failed = "Failed", /** FilteredSpam */ FilteredSpam = "FilteredSpam", /** Quarantined */ Quarantined = "Quarantined", /** Suppressed */ Suppressed = "Suppressed" } /** * The status of the email. Any value other than Delivered is considered failed. * {@link KnownAcsEmailDeliveryReportStatus} can be used interchangeably with AcsEmailDeliveryReportStatus, * this enum contains the known values that the service supports. * ### Known values supported by the service * **Bounced** * **Delivered** * **Failed** * **FilteredSpam** * **Quarantined** * **Suppressed** */ export type AcsEmailDeliveryReportStatus = string; /** Detailed information about the status if any */ export interface AcsEmailDeliveryReportStatusDetails { /** Detailed status message */ statusMessage?: string; /** Recipient mail server host name */ recipientMailServerHostName?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event. */ export interface AcsEmailEngagementTrackingReportReceivedEventData { /** The Sender Email Address */ sender?: string; /** The Recipient Email Address */ recipient?: string; /** The Id of the email that has been sent */ messageId?: string; /** The time at which the user interacted with the email */ userActionTimestamp: Date; /** The context of the type of engagement user had with email */ engagementContext?: string; /** The user agent interacting with the email */ userAgent?: string; /** The type of engagement user have with email */ engagement: AcsUserEngagement; } /** Known values of {@link AcsUserEngagement} that the service accepts. */ export declare enum KnownAcsUserEngagement { /** view */ view = "view", /** click */ click = "click" } /** * The type of engagement user have with email. * {@link 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** */ export type AcsUserEngagement = string; /** Schema of common properties of all Router events */ export interface AcsRouterEventData { /** Router Event Job ID */ jobId?: string; /** Router Event Channel Reference */ channelReference?: string; /** Router Event Channel ID */ channelId?: string; } /** Schema of common properties of all Router Job events */ export interface AcsRouterJobEventData extends AcsRouterEventData { /** Router Job events Queue Id */ queueId?: string; /** Router Job events Labels */ labels: Record<string, string>; /** Router Jobs events Tags */ tags: Record<string, string>; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event */ export interface AcsRouterJobCancelledEventData extends AcsRouterJobEventData { /** Router Job Note */ note?: string; /** Router Job Disposition Code */ dispositionCode?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event */ export interface AcsRouterJobClassificationFailedEventData extends AcsRouterJobEventData { /** Router Job Classification Policy Id */ classificationPolicyId?: string; /** Router Job Classification Failed Errors */ errors: AcsRouterCommunicationError[]; } /** Router Communication Error */ export interface AcsRouterCommunicationError { /** Router Communication Error Code */ code?: string; /** Router Communication Error Message */ message?: string; /** Router Communication Error Target */ target?: string; /** Router Communication Inner Error */ innererror: AcsRouterCommunicationError; /** List of Router Communication Errors */ details: AcsRouterCommunicationError[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event */ export interface AcsRouterJobClassifiedEventData extends AcsRouterJobEventData { /** Router Job Queue Info */ queueDetails: AcsRouterQueueDetails; /** Router Job Classification Policy Id */ classificationPolicyId?: string; /** Router Job Priority */ priority?: number; /** Router Job Attached Worker Selector */ attachedWorkerSelectors: AcsRouterWorkerSelector[]; } /** Router Queue Details */ export interface AcsRouterQueueDetails { /** Router Queue Id */ id?: string; /** Router Queue Name */ name?: string; /** Router Queue Labels */ labels: Record<string, string>; } /** Router Job Worker Selector */ export interface AcsRouterWorkerSelector { /** Router Job Worker Selector Key */ key?: string; /** Router Job Worker Selector Label Operator */ labelOperator: AcsRouterLabelOperator; /** Router Job Worker Selector Value */ labelValue: any; /** Router Job Worker Selector Time to Live in Seconds */ ttlSeconds: number; /** Router Job Worker Selector State */ state: AcsRouterWorkerSelectorState; /** Router Job Worker Selector Expiration Time */ expirationTime: Date; } /** Known values of {@link AcsRouterLabelOperator} that the service accepts. */ export declare enum KnownAcsRouterLabelOperator { /** Equal */ Equal = "Equal", /** NotEqual */ NotEqual = "NotEqual", /** Greater */ Greater = "Greater", /** Less */ Less = "Less", /** GreaterThanOrEqual */ GreaterThanOrEqual = "GreaterThanOrEqual", /** LessThanOrEqual */ LessThanOrEqual = "LessThanOrEqual" } /** * Router Job Worker Selector Label Operator * {@link 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** */ export type AcsRouterLabelOperator = string; /** Known values of {@link AcsRouterWorkerSelectorState} that the service accepts. */ export declare enum KnownAcsRouterWorkerSelectorState { /** active */ active = "active", /** expired */ expired = "expired" } /** * Router Worker Selector State * {@link KnownAcsRouterWorkerSelectorState} can be used interchangeably with AcsRouterWorkerSelectorState, * this enum contains the known values that the service supports. * ### Known values supported by the service * **active** * **expired** */ export type AcsRouterWorkerSelectorState = string; /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event */ export interface AcsRouterJobClosedEventData extends AcsRouterJobEventData { /** Router Job Closed Assignment Id */ assignmentId?: string; /** Router Job Closed Worker Id */ workerId?: string; /** Router Job Closed Disposition Code */ dispositionCode?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event */ export interface AcsRouterJobCompletedEventData extends AcsRouterJobEventData { /** Router Job Completed Assignment Id */ assignmentId?: string; /** Router Job Completed Worker Id */ workerId?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event */ export interface AcsRouterJobDeletedEventData extends AcsRouterJobEventData { } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event */ export interface AcsRouterJobExceptionTriggeredEventData extends AcsRouterJobEventData { /** Router Job Exception Triggered Rule Key */ ruleKey?: string; /** Router Job Exception Triggered Rule Id */ exceptionRuleId?: string; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event */ export interface AcsRouterJobQueuedEventData extends AcsRouterJobEventData { /** Router Job Priority */ priority?: number; /** Router Job Queued Attached Worker Selector */ attachedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Queued Requested Worker Selector */ requestedWorkerSelectors: AcsRouterWorkerSelector[]; } /** Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event */ export interface AcsRouterJobReceivedEventData extends AcsRouterJobEventData { /** Router Job Received Job Status */ jobStatus: AcsRouterJobStatus; /** Router Job Classification Policy Id */ classificationPolicyId?: string; /** Router Job Priority */ priority?: number; /** Router Job Received Requested Worker Selectors */ requestedWorkerSelectors: AcsRouterWorkerSelector[]; /** Router Job Received Scheduled Time in UTC */ scheduledOn: Date; /** Unavailable For Matching for Router Job Received */ unavailableForMatching: boolean; } /** Known values of {@link AcsRouterJobStatus} that the service accepts. */ export declare enum KnownAcsRouterJobStatus { /** PendingClassification */ PendingClassification =