{ "swagger": "2.0", "info": { "title": "Azure.Messaging.SystemEvents", "version": "2018-01-01", "description": "Azure Messaging EventGrid SystemEvents", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "produces": [ "application/json" ], "consumes": [ "application/json" ], "tags": [], "paths": {}, "definitions": { "AcsCallEndReasonProperties": { "type": "object", "description": "Schema of calling event reason properties", "properties": { "code": { "type": "integer", "format": "int32", "description": "Reason code for ending the call." }, "subCode": { "type": "integer", "format": "int32", "description": "Reason subcode for ending the call." }, "phrase": { "type": "string", "description": "Reason for the ending the call." } } }, "AcsCallEndedByKind": { "type": "string", "description": "Call ended participant kind.", "enum": [ "Participant", "MicrosoftInternal" ], "x-ms-enum": { "name": "AcsCallEndedByKind", "modelAsString": true, "values": [ { "name": "Participant", "value": "Participant", "description": "Participant" }, { "name": "MicrosoftInternal", "value": "MicrosoftInternal", "description": "MicrosoftInternal" } ] } }, "AcsCallEndedByProperties": { "type": "object", "description": "Schema of calling event ended by properties", "properties": { "communicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the call ended by" }, "type": { "$ref": "#/definitions/AcsCallEndedByKind", "description": "The type of call ended by.", "x-ms-client-name": "kind" }, "name": { "type": "string", "description": "The name of the call ended by." } }, "required": [ "communicationIdentifier", "name" ] }, "AcsCallEndedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallEnded event.", "properties": { "endedBy": { "$ref": "#/definitions/AcsCallEndedByProperties", "description": "The communication identifier of the user who was disconnected" }, "reason": { "$ref": "#/definitions/AcsCallEndReasonProperties", "description": "The reason for ending the call." }, "callDurationInSeconds": { "type": "number", "format": "double", "description": "Duration of the call in seconds." } }, "allOf": [ { "$ref": "#/definitions/AcsCallingEventProperties" } ] }, "AcsCallGroupProperties": { "type": "object", "description": "Schema of calling event group properties", "properties": { "id": { "type": "string", "description": "Group Id." } } }, "AcsCallParticipantAddedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallParticipantAdded event.", "allOf": [ { "$ref": "#/definitions/AcsCallParticipantEventData" } ] }, "AcsCallParticipantEventData": { "type": "object", "description": "Schema of common properties of all participant events", "properties": { "user": { "$ref": "#/definitions/AcsCallParticipantProperties", "description": "The user of the call participant" }, "displayName": { "type": "string", "description": "The display name of the participant." }, "participantId": { "type": "string", "description": "The id of the participant." }, "userAgent": { "type": "string", "description": "The user agent of the participant." } }, "allOf": [ { "$ref": "#/definitions/AcsCallingEventProperties" } ] }, "AcsCallParticipantKind": { "type": "string", "description": "Call participant kind.", "enum": [ "Attendee", "Presenter", "Organizer", "Consumer", "Collaborator" ], "x-ms-enum": { "name": "AcsCallParticipantKind", "modelAsString": true, "values": [ { "name": "Attendee", "value": "Attendee", "description": "Attendee" }, { "name": "Presenter", "value": "Presenter", "description": "Presenter" }, { "name": "Organizer", "value": "Organizer", "description": "Organizer" }, { "name": "Consumer", "value": "Consumer", "description": "Consumer" }, { "name": "Collaborator", "value": "Collaborator", "description": "Collaborator" } ] } }, "AcsCallParticipantProperties": { "type": "object", "description": "Schema of common properties of all participant event user", "properties": { "communicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the participant user" }, "role": { "$ref": "#/definitions/AcsCallParticipantKind", "description": "The role of the participant" } } }, "AcsCallParticipantRemovedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallParticipantRemoved event.", "allOf": [ { "$ref": "#/definitions/AcsCallParticipantEventData" } ] }, "AcsCallRoomProperties": { "type": "object", "description": "Schema of calling event room properties", "properties": { "id": { "type": "string", "description": "Room Id." } } }, "AcsCallStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallStarted event.", "allOf": [ { "$ref": "#/definitions/AcsCallingEventProperties" } ] }, "AcsCallingEventProperties": { "type": "object", "description": "Schema of common properties of all calling events", "properties": { "startedBy": { "$ref": "#/definitions/AcsCallParticipantProperties", "description": "The call participant who initiated the call." }, "serverCallId": { "type": "string", "description": "The call id of the server" }, "group": { "$ref": "#/definitions/AcsCallGroupProperties", "description": "The group metadata" }, "room": { "$ref": "#/definitions/AcsCallRoomProperties", "description": "The room metadata" }, "isTwoParty": { "type": "boolean", "description": "Is two-party in calling event." }, "correlationId": { "type": "string", "description": "The correlationId of calling event" }, "isRoomsCall": { "type": "boolean", "description": "Is the calling event a room call." } }, "required": [ "startedBy", "serverCallId", "correlationId" ] }, "AcsChatAzureBotCommandReceivedInThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatAzureBotCommandReceivedInThread event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ] }, "AcsChatEventBaseProperties": { "type": "object", "description": "Schema of common properties of all chat events", "properties": { "recipientCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the target user" }, "transactionId": { "type": "string", "description": "The transaction id will be used as co-relation vector" }, "threadId": { "type": "string", "description": "The chat thread id" } }, "required": [ "recipientCommunicationIdentifier", "threadId" ] }, "AcsChatEventInThreadBaseProperties": { "type": "object", "description": "Schema of common properties of all thread-level chat events", "properties": { "transactionId": { "type": "string", "description": "The transaction id will be used as co-relation vector" }, "threadId": { "type": "string", "description": "The chat thread id" } }, "required": [ "threadId" ] }, "AcsChatMessageDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeleted event.", "properties": { "deleteTime": { "type": "string", "format": "date-time", "description": "The time at which the message was deleted" } }, "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ] }, "AcsChatMessageDeletedInThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageDeletedInThread event.", "properties": { "deleteTime": { "type": "string", "format": "date-time", "description": "The time at which the message was deleted" } }, "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ] }, "AcsChatMessageEditedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEdited event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "editTime": { "type": "string", "format": "date-time", "description": "The time at which the message was edited" } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ] }, "AcsChatMessageEditedInThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageEditedInThread event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "editTime": { "type": "string", "format": "date-time", "description": "The time at which the message was edited" } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ] }, "AcsChatMessageEventBaseProperties": { "type": "object", "description": "Schema of common properties of all chat message events", "properties": { "messageId": { "type": "string", "description": "The chat message id" }, "senderCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the sender" }, "senderDisplayName": { "type": "string", "description": "The display name of the sender" }, "sequenceId": { "type": "integer", "format": "int64", "description": "The Sequence id of the message" }, "composeTime": { "type": "string", "format": "date-time", "description": "The original compose time of the message" }, "type": { "type": "string", "description": "The type of the message" }, "version": { "type": "integer", "format": "int64", "description": "The version of the message" } }, "required": [ "messageId", "senderCommunicationIdentifier", "type" ], "allOf": [ { "$ref": "#/definitions/AcsChatEventBaseProperties" } ] }, "AcsChatMessageEventInThreadBaseProperties": { "type": "object", "description": "Schema of common properties of all thread-level chat message events", "properties": { "messageId": { "type": "string", "description": "The chat message id" }, "senderCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the sender" }, "senderDisplayName": { "type": "string", "description": "The display name of the sender" }, "sequenceId": { "type": "integer", "format": "int64", "description": "The Sequence id of the message" }, "composeTime": { "type": "string", "format": "date-time", "description": "The original compose time of the message" }, "type": { "type": "string", "description": "The type of the message" }, "version": { "type": "integer", "format": "int64", "description": "The version of the message" } }, "required": [ "messageId", "senderCommunicationIdentifier", "type" ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ] }, "AcsChatMessageReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceived event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventBaseProperties" } ] }, "AcsChatMessageReceivedInThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatMessageReceivedInThread event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ] }, "AcsChatParticipantAddedToThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantAdded event.", "properties": { "time": { "type": "string", "format": "date-time", "description": "The time at which the user was added to the thread" }, "addedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who added the user" }, "participantAdded": { "$ref": "#/definitions/AcsChatThreadParticipantProperties", "description": "The details of the user who was added" }, "version": { "type": "integer", "format": "int64", "description": "The version of the thread" } }, "required": [ "addedByCommunicationIdentifier", "participantAdded" ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ] }, "AcsChatParticipantAddedToThreadWithUserEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantAddedToThreadWithUser event.", "properties": { "time": { "type": "string", "format": "date-time", "description": "The time at which the user was added to the thread" }, "addedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who added the user" }, "participantAdded": { "$ref": "#/definitions/AcsChatThreadParticipantProperties", "description": "The details of the user who was added" } }, "required": [ "addedByCommunicationIdentifier", "participantAdded" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ] }, "AcsChatParticipantRemovedFromThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadParticipantRemoved event.", "properties": { "time": { "type": "string", "format": "date-time", "description": "The time at which the user was removed to the thread" }, "removedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who removed the user" }, "participantRemoved": { "$ref": "#/definitions/AcsChatThreadParticipantProperties", "description": "The details of the user who was removed" }, "version": { "type": "integer", "format": "int64", "description": "The version of the thread" } }, "required": [ "removedByCommunicationIdentifier", "participantRemoved" ], "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ] }, "AcsChatParticipantRemovedFromThreadWithUserEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event.", "properties": { "time": { "type": "string", "format": "date-time", "description": "The time at which the user was removed to the thread" }, "removedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who removed the user" }, "participantRemoved": { "$ref": "#/definitions/AcsChatThreadParticipantProperties", "description": "The details of the user who was removed" } }, "required": [ "removedByCommunicationIdentifier", "participantRemoved" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ] }, "AcsChatRetentionPolicy": { "type": "object", "description": "Schema of common properties of all chat retention policy", "properties": { "kind": { "$ref": "#/definitions/AcsChatRetentionPolicyKind", "description": "The chat retention policy kind." }, "deleteThreadAfterDays": { "type": "integer", "format": "int32", "description": "The delete thread after number of days." } } }, "AcsChatRetentionPolicyKind": { "type": "string", "description": "Chat Retention Policy kind", "enum": [ "none", "threadCreationDate" ], "x-ms-enum": { "name": "AcsChatRetentionPolicyKind", "modelAsString": true, "values": [ { "name": "none", "value": "none", "description": "None" }, { "name": "threadCreationDate", "value": "threadCreationDate", "description": "ThreadCreationDate" } ] } }, "AcsChatThreadCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreated event.", "properties": { "createdByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who created the thread" }, "properties": { "type": "object", "description": "The thread properties", "additionalProperties": {} }, "metadata": { "type": "object", "description": "The thread metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "participants": { "type": "array", "description": "The list of properties of participants who are part of the thread", "items": { "$ref": "#/definitions/AcsChatThreadParticipantProperties" }, "readOnly": true }, "retentionPolicy": { "$ref": "#/definitions/AcsChatRetentionPolicy", "description": "The retention policy for the chat." } }, "required": [ "createdByCommunicationIdentifier", "properties", "participants" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ] }, "AcsChatThreadCreatedWithUserEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadCreatedWithUser event.", "properties": { "createdByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who created the thread" }, "properties": { "type": "object", "description": "The thread properties", "additionalProperties": {} }, "metadata": { "type": "object", "description": "The thread metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "participants": { "type": "array", "description": "The list of properties of participants who are part of the thread", "items": { "$ref": "#/definitions/AcsChatThreadParticipantProperties" }, "readOnly": true }, "retentionPolicy": { "$ref": "#/definitions/AcsChatRetentionPolicy", "description": "The retention policy for the chat." } }, "required": [ "createdByCommunicationIdentifier", "properties", "participants" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ] }, "AcsChatThreadDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadDeleted event.", "properties": { "deletedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who deleted the thread" }, "deleteTime": { "type": "string", "format": "date-time", "description": "The deletion time of the thread" }, "reason": { "$ref": "#/definitions/AcsChatThreadDeletedReasonType", "description": "The chat thread deletion reason." } }, "required": [ "deletedByCommunicationIdentifier" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ] }, "AcsChatThreadDeletedReasonType": { "type": "string", "description": "Chat Thread Deletion Reason Type", "enum": [ "deletedByUser", "deletedByPolicy" ], "x-ms-enum": { "name": "AcsChatThreadDeletedReasonType", "modelAsString": true, "values": [ { "name": "deletedByUser", "value": "deletedByUser", "description": "DeletedByUser" }, { "name": "deletedByPolicy", "value": "deletedByPolicy", "description": "DeletedByPolicy" } ] } }, "AcsChatThreadEventBaseProperties": { "type": "object", "description": "Schema of common properties of all chat thread events", "properties": { "createTime": { "type": "string", "format": "date-time", "description": "The original creation time of the thread" }, "version": { "type": "integer", "format": "int64", "description": "The version of the thread" } }, "allOf": [ { "$ref": "#/definitions/AcsChatEventBaseProperties" } ] }, "AcsChatThreadEventInThreadBaseProperties": { "type": "object", "description": "Schema of common properties of all chat thread events", "properties": { "createTime": { "type": "string", "format": "date-time", "description": "The original creation time of the thread" }, "version": { "type": "integer", "format": "int64", "description": "The version of the thread" } }, "allOf": [ { "$ref": "#/definitions/AcsChatEventInThreadBaseProperties" } ] }, "AcsChatThreadParticipantProperties": { "type": "object", "description": "Schema of the chat thread participant", "properties": { "displayName": { "type": "string", "description": "The name of the user" }, "participantCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user" }, "metadata": { "type": "object", "description": "The metadata of the user", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "participantCommunicationIdentifier" ] }, "AcsChatThreadPropertiesUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdated event.", "properties": { "editedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who updated the thread properties" }, "editTime": { "type": "string", "format": "date-time", "description": "The time at which the properties of the thread were updated" }, "properties": { "type": "object", "description": "The updated thread properties", "additionalProperties": {} }, "metadata": { "type": "object", "description": "The thread metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "retentionPolicy": { "$ref": "#/definitions/AcsChatRetentionPolicy", "description": "The retention policy for the chat." } }, "required": [ "editedByCommunicationIdentifier", "properties", "metadata" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventInThreadBaseProperties" } ] }, "AcsChatThreadPropertiesUpdatedPerUserEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.", "properties": { "editedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who updated the thread properties" }, "editTime": { "type": "string", "format": "date-time", "description": "The time at which the properties of the thread were updated" }, "metadata": { "type": "object", "description": "The thread metadata", "additionalProperties": { "type": "string" }, "readOnly": true }, "properties": { "type": "object", "description": "The updated thread properties", "additionalProperties": {} }, "retentionPolicy": { "$ref": "#/definitions/AcsChatRetentionPolicy", "description": "The retention policy for the chat." } }, "required": [ "editedByCommunicationIdentifier", "properties" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ] }, "AcsChatThreadWithUserDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatThreadWithUserDeleted event.", "properties": { "deletedByCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who deleted the thread" }, "deleteTime": { "type": "string", "format": "date-time", "description": "The deletion time of the thread" } }, "required": [ "deletedByCommunicationIdentifier" ], "allOf": [ { "$ref": "#/definitions/AcsChatThreadEventBaseProperties" } ] }, "AcsChatTypingIndicatorReceivedInThreadEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.ChatTypingIndicatorReceivedInThread event.", "properties": { "messageBody": { "type": "string", "description": "The body of the chat message" }, "metadata": { "type": "object", "description": "The chat message metadata", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "messageBody" ], "allOf": [ { "$ref": "#/definitions/AcsChatMessageEventInThreadBaseProperties" } ] }, "AcsEmailDeliveryReportReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailDeliveryReportReceived event.", "properties": { "sender": { "type": "string", "description": "The Sender Email Address" }, "recipient": { "type": "string", "description": "The recipient Email Address" }, "internetMessageId": { "type": "string", "description": "The Internet Message Id of the email that has been sent" }, "messageId": { "type": "string", "description": "The Id of the email that has been sent" }, "status": { "$ref": "#/definitions/AcsEmailDeliveryReportStatus", "description": "The status of the email. Any value other than Delivered is considered failed." }, "deliveryStatusDetails": { "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails", "description": "Detailed information about the status if any" }, "deliveryAttemptTimestamp": { "type": "string", "format": "date-time", "description": "The time at which the email delivery report received timestamp" } }, "required": [ "sender", "recipient", "internetMessageId", "deliveryStatusDetails" ] }, "AcsEmailDeliveryReportStatus": { "type": "string", "description": "The status of the email. Any value other than Delivered is considered failed.", "enum": [ "Bounced", "Delivered", "Failed", "FilteredSpam", "Quarantined", "Suppressed" ], "x-ms-enum": { "name": "AcsEmailDeliveryReportStatus", "modelAsString": true, "values": [ { "name": "Bounced", "value": "Bounced", "description": "Hard bounce detected while sending the email" }, { "name": "Delivered", "value": "Delivered", "description": "The email was delivered" }, { "name": "Failed", "value": "Failed", "description": "The email failed to be delivered" }, { "name": "FilteredSpam", "value": "FilteredSpam", "description": "The message was identified as spam and was rejected or blocked (not quarantined)." }, { "name": "Quarantined", "value": "Quarantined", "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)." }, { "name": "Suppressed", "value": "Suppressed", "description": "The email was suppressed" } ] } }, "AcsEmailDeliveryReportStatusDetails": { "type": "object", "description": "Detailed information about the status if any", "properties": { "statusMessage": { "type": "string", "description": "Detailed status message" }, "recipientMailServerHostName": { "type": "string", "description": "Recipient mail server host name" } } }, "AcsEmailEngagementTrackingReportReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.EmailEngagementTrackingReportReceived event.", "properties": { "sender": { "type": "string", "description": "The Sender Email Address" }, "recipient": { "type": "string", "description": "The Recipient Email Address" }, "messageId": { "type": "string", "description": "The Id of the email that has been sent" }, "userActionTimestamp": { "type": "string", "format": "date-time", "description": "The time at which the user interacted with the email" }, "engagementContext": { "type": "string", "description": "The context of the type of engagement user had with email" }, "userAgent": { "type": "string", "description": "The user agent interacting with the email" }, "engagementType": { "$ref": "#/definitions/AcsUserEngagement", "description": "The type of engagement user have with email", "x-ms-client-name": "engagement" } } }, "AcsIncomingCallCallArrivalDisplayInfo": { "type": "object", "description": "Display metadata associated with an incoming call arrival.", "properties": { "teamsTenantId": { "type": "string", "description": "The destination resource account's Microsoft Teams tenant ID." }, "destinationPhoneNumber": { "type": "string", "description": "The E.164 number dialed for the incoming call." } } }, "AcsIncomingCallCustomContext": { "type": "object", "description": "Custom Context of Incoming Call", "properties": { "sipHeaders": { "type": "object", "description": "Sip Headers for incoming call", "additionalProperties": { "type": "string" }, "readOnly": true }, "voipHeaders": { "type": "object", "description": "Voip Headers for incoming call", "additionalProperties": { "type": "string" }, "readOnly": true }, "teamsPhoneCallDetails": { "$ref": "#/definitions/AcsIncomingCallTeamsPhoneCallDetails", "description": "Teams phone call details associated with the incoming call." } }, "required": [ "sipHeaders", "voipHeaders" ] }, "AcsIncomingCallEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", "properties": { "to": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the target user.", "x-ms-client-name": "toCommunicationIdentifier" }, "from": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who initiated the call.", "x-ms-client-name": "fromCommunicationIdentifier" }, "serverCallId": { "type": "string", "description": "The Id of the server call" }, "callerDisplayName": { "type": "string", "description": "Display name of caller." }, "customContext": { "$ref": "#/definitions/AcsIncomingCallCustomContext", "description": "Custom Context of Incoming Call" }, "incomingCallContext": { "type": "string", "description": "Signed incoming call context." }, "onBehalfOfCallee": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the callee for the \"on behalf of\" call." }, "onBehalfOf": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier on behalf of whom the call is made." }, "callArrivalDisplayInfo": { "$ref": "#/definitions/AcsIncomingCallCallArrivalDisplayInfo", "description": "Display metadata associated with the incoming call arrival." }, "correlationId": { "type": "string", "description": "CorrelationId (CallId)." } }, "required": [ "to", "from", "customContext" ] }, "AcsIncomingCallTeamsPhoneCallDetails": { "type": "object", "description": "Teams phone call details associated with an incoming call.", "properties": { "teamsPhoneCallerDetails": { "$ref": "#/definitions/AcsIncomingCallTeamsPhoneCallerDetails", "description": "Details about the original caller." }, "teamsPhoneSourceDetails": { "$ref": "#/definitions/AcsIncomingCallTeamsPhoneSourceDetails", "description": "Details about the entity that created the call details." }, "sessionId": { "type": "string", "description": "The identifier for the call session." }, "intent": { "type": "string", "description": "The intent of the call." }, "callTopic": { "type": "string", "description": "A short description of the reason for the call." }, "callContext": { "type": "string", "description": "A summary of the call." }, "transcriptUrl": { "type": "string", "description": "The URL for fetching the call transcript." }, "callSentiment": { "type": "string", "description": "The sentiment of the call." }, "suggestedActions": { "type": "string", "description": "Recommended actions for resolving the caller's issue." } } }, "AcsIncomingCallTeamsPhoneCallerDetails": { "type": "object", "description": "Details about the original Teams phone caller.", "properties": { "caller": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The caller's communication identifier." }, "name": { "type": "string", "description": "The caller's name." }, "phoneNumber": { "type": "string", "description": "The caller's phone number." }, "recordId": { "type": "string", "description": "The caller's record identifier." }, "screenPopUrl": { "type": "string", "description": "The URL to display information about the caller." }, "isAuthenticated": { "type": "boolean", "description": "Whether the caller was authenticated." }, "additionalCallerInformation": { "type": "object", "description": "Additional caller information keyed by field name.", "additionalProperties": { "type": "string" } } } }, "AcsIncomingCallTeamsPhoneSourceDetails": { "type": "object", "description": "Details about the entity that supplied the Teams phone call details.", "properties": { "source": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the source entity." }, "language": { "type": "string", "description": "The ISO 639 language of the source entity." }, "status": { "type": "string", "description": "The status of the source entity." }, "intendedTargets": { "type": "object", "description": "The intended targets keyed by target name.", "additionalProperties": { "$ref": "#/definitions/CommunicationIdentifierModel" } } } }, "AcsInteractiveReplyKind": { "type": "string", "description": "Interactive reply kind", "enum": [ "buttonReply", "listReply", "unknown" ], "x-ms-enum": { "name": "AcsInteractiveReplyKind", "modelAsString": true, "values": [ { "name": "buttonReply", "value": "buttonReply", "description": "Messaged interactive reply type is ButtonReply" }, { "name": "listReply", "value": "listReply", "description": "Messaged interactive reply type is ListReply" }, { "name": "unknown", "value": "unknown", "description": "Messaged interactive reply type is Unknown" } ] } }, "AcsMessageButtonContent": { "type": "object", "description": "Message Button Content", "properties": { "text": { "type": "string", "description": "The Text of the button" }, "payload": { "type": "string", "description": "The Payload of the button which was clicked by the user, setup by the business" } } }, "AcsMessageChannelEventError": { "type": "object", "description": "Message Channel Event Error", "properties": { "channelCode": { "type": "string", "description": "The channel error code" }, "channelMessage": { "type": "string", "description": "The channel error message" } } }, "AcsMessageChannelKind": { "type": "string", "description": "Message channel kind", "enum": [ "whatsapp" ], "x-ms-enum": { "name": "AcsMessageChannelKind", "modelAsString": true, "values": [ { "name": "whatsapp", "value": "whatsapp", "description": "Updated message channel type is WhatsApp" } ] } }, "AcsMessageContext": { "type": "object", "description": "Message Context", "properties": { "from": { "type": "string", "description": "The WhatsApp ID for the customer who replied to an inbound message." }, "id": { "type": "string", "description": "The message ID for the sent message for an inbound reply", "x-ms-client-name": "messageId" } } }, "AcsMessageDeliveryStatus": { "type": "string", "description": "Message delivery status", "enum": [ "read", "delivered", "failed", "sent", "warning", "unknown" ], "x-ms-enum": { "name": "AcsMessageDeliveryStatus", "modelAsString": true, "values": [ { "name": "read", "value": "read", "description": "Read" }, { "name": "delivered", "value": "delivered", "description": "Delivered" }, { "name": "failed", "value": "failed", "description": "Failed" }, { "name": "sent", "value": "sent", "description": "Sent" }, { "name": "warning", "value": "warning", "description": "Warning" }, { "name": "unknown", "value": "unknown", "description": "Unknown" } ] } }, "AcsMessageDeliveryStatusUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event.", "properties": { "messageId": { "type": "string", "description": "The message id" }, "toBSUID": { "type": "string", "description": "Optional. The BSUID of the recipient.", "x-ms-client-name": "toBsuid" }, "status": { "$ref": "#/definitions/AcsMessageDeliveryStatus", "description": "The updated message status" }, "channelType": { "$ref": "#/definitions/AcsMessageChannelKind", "description": "The updated message channel type", "x-ms-client-name": "channelKind" } }, "allOf": [ { "$ref": "#/definitions/AcsMessageEventData" } ] }, "AcsMessageEventData": { "type": "object", "description": "Schema of common properties of all chat thread events", "properties": { "from": { "type": "string", "description": "The message sender" }, "to": { "type": "string", "description": "The message recipient" }, "receivedTimeStamp": { "type": "string", "format": "date-time", "description": "The time message was received" }, "error": { "$ref": "#/definitions/AcsMessageChannelEventError", "description": "The channel event error" } }, "required": [ "from", "to" ] }, "AcsMessageInteractiveButtonReplyContent": { "type": "object", "description": "Message Interactive button reply content for a user to business message", "properties": { "id": { "type": "string", "description": "The ID of the button", "x-ms-client-name": "buttonId" }, "title": { "type": "string", "description": "The title of the button" } } }, "AcsMessageInteractiveContent": { "type": "object", "description": "Message Interactive Content", "properties": { "type": { "$ref": "#/definitions/AcsInteractiveReplyKind", "description": "The Message interactive reply type", "x-ms-client-name": "replyKind" }, "buttonReply": { "$ref": "#/definitions/AcsMessageInteractiveButtonReplyContent", "description": "The Message Sent when a customer clicks a button" }, "listReply": { "$ref": "#/definitions/AcsMessageInteractiveListReplyContent", "description": "The Message Sent when a customer selects an item from a list" } } }, "AcsMessageInteractiveListReplyContent": { "type": "object", "description": "Message Interactive list reply content for a user to business message", "properties": { "id": { "type": "string", "description": "The ID of the selected list item", "x-ms-client-name": "listItemId" }, "title": { "type": "string", "description": "The title of the selected list item" }, "description": { "type": "string", "description": "The description of the selected row" } } }, "AcsMessageMediaContent": { "type": "object", "description": "Message Media Content", "properties": { "mimeType": { "type": "string", "description": "Required. The MIME type of the file this media represents" }, "id": { "type": "string", "description": "Required. The media identifier", "x-ms-client-name": "mediaId" }, "fileName": { "type": "string", "description": "Optional. The filename of the underlying media file as specified when uploaded" }, "caption": { "type": "string", "description": "Optional. The caption for the media object, if supported and provided" }, "animated": { "type": "boolean", "description": "Optional. Set to true if the sticker is animated; false otherwise." } }, "required": [ "mimeType", "id" ] }, "AcsMessageReactionContent": { "type": "object", "description": "Message Reaction Content", "properties": { "messageId": { "type": "string", "description": "Required. WhatsApp message ID of the message that the emoji is applied to" }, "emoji": { "type": "string", "description": "Optional. Unicode escape sequence of the emoji." } }, "required": [ "messageId" ] }, "AcsMessageReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.AdvancedMessageReceived event.", "properties": { "content": { "type": "string", "description": "Optional. The message content" }, "messageId": { "type": "string", "description": "Optional. Message ID. Format is Guid as string." }, "fromBSUID": { "type": "string", "description": "Optional. The BSUID of the sender.", "x-ms-client-name": "fromBsuid" }, "channelType": { "$ref": "#/definitions/AcsMessageChannelKind", "description": "Required. The message channel type", "x-ms-client-name": "channelKind" }, "messageType": { "type": "string", "description": "Required. Whatsapp message type" }, "media": { "$ref": "#/definitions/AcsMessageMediaContent", "description": "Optional. The received message media content", "x-ms-client-name": "mediaContent" }, "reaction": { "$ref": "#/definitions/AcsMessageReactionContent", "description": "Optional. The received message reaction content" }, "context": { "$ref": "#/definitions/AcsMessageContext", "description": "Optional. The received message context" }, "button": { "$ref": "#/definitions/AcsMessageButtonContent", "description": "Optional. The received message button content" }, "interactive": { "$ref": "#/definitions/AcsMessageInteractiveContent", "description": "Optional. The received message interactive content", "x-ms-client-name": "interactiveContent" } }, "required": [ "messageType" ], "allOf": [ { "$ref": "#/definitions/AcsMessageEventData" } ] }, "AcsRecordingChannelType": { "type": "string", "description": "Recording channel type", "enum": [ "Mixed", "Unmixed" ], "x-ms-enum": { "name": "AcsRecordingChannelType", "modelAsString": true, "values": [ { "name": "Mixed", "value": "Mixed", "description": "Mixed channel type" }, { "name": "Unmixed", "value": "Unmixed", "description": "Unmixed channel type" } ] } }, "AcsRecordingChunkInfoProperties": { "type": "object", "description": "Schema for all properties of Recording Chunk Information.", "properties": { "documentId": { "type": "string", "description": "The documentId of the recording chunk" }, "index": { "type": "integer", "format": "int64", "description": "The index of the recording chunk" }, "endReason": { "type": "string", "description": "The reason for ending the recording chunk" }, "metadataLocation": { "type": "string", "description": "The location of the metadata for this chunk" }, "contentLocation": { "type": "string", "description": "The location of the content for this chunk" }, "deleteLocation": { "type": "string", "description": "The location to delete all chunk storage" } } }, "AcsRecordingContentType": { "type": "string", "description": "Recording content type", "enum": [ "AudioVideo", "Audio" ], "x-ms-enum": { "name": "AcsRecordingContentType", "modelAsString": true, "values": [ { "name": "AudioVideo", "value": "AudioVideo", "description": "AudioVideo content type" }, { "name": "Audio", "value": "Audio", "description": "Audio content type" } ] } }, "AcsRecordingFileStatusUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RecordingFileStatusUpdated event.", "properties": { "recordingStorageInfo": { "$ref": "#/definitions/AcsRecordingStorageInfoProperties", "description": "The details of recording storage information" }, "recordingStartTime": { "type": "string", "format": "date-time", "description": "The time at which the recording started" }, "recordingDurationMs": { "type": "integer", "format": "int64", "description": "The recording duration in milliseconds" }, "recordingContentType": { "$ref": "#/definitions/AcsRecordingContentType", "description": "The recording content type- AudioVideo, or Audio" }, "recordingChannelType": { "$ref": "#/definitions/AcsRecordingChannelType", "description": "The recording channel type - Mixed, Unmixed" }, "recordingFormatType": { "$ref": "#/definitions/AcsRecordingFormatType", "description": "The recording format type - Mp4, Mp3, Wav" }, "sessionEndReason": { "type": "string", "description": "The reason for ending recording session" } }, "required": [ "recordingStorageInfo" ] }, "AcsRecordingFormatType": { "type": "string", "description": "Recording format type", "enum": [ "Wav", "Mp3", "Mp4" ], "x-ms-enum": { "name": "AcsRecordingFormatType", "modelAsString": true, "values": [ { "name": "Wav", "value": "Wav", "description": "WAV format" }, { "name": "Mp3", "value": "Mp3", "description": "MP3 format" }, { "name": "Mp4", "value": "Mp4", "description": "MP4 format" } ] } }, "AcsRecordingStorageInfoProperties": { "type": "object", "description": "Schema for all properties of Recording Storage Information.", "properties": { "recordingChunks": { "type": "array", "description": "List of details of recording chunks information", "items": { "$ref": "#/definitions/AcsRecordingChunkInfoProperties" }, "readOnly": true } }, "required": [ "recordingChunks" ] }, "AcsRouterChannelConfiguration": { "type": "object", "description": "Router Channel Configuration", "properties": { "channelId": { "type": "string", "description": "Channel ID for Router Job" }, "capacityCostPerJob": { "type": "integer", "format": "int32", "description": "Capacity Cost Per Job for Router Job" }, "maxNumberOfJobs": { "type": "integer", "format": "int32", "description": "Max Number of Jobs for Router Job" } } }, "AcsRouterCommunicationError": { "type": "object", "description": "Router Communication Error", "properties": { "code": { "type": "string", "description": "Router Communication Error Code" }, "message": { "type": "string", "description": "Router Communication Error Message" }, "target": { "type": "string", "description": "Router Communication Error Target" }, "innererror": { "$ref": "#/definitions/AcsRouterCommunicationError", "description": "Router Communication Inner Error" }, "details": { "type": "array", "description": "List of Router Communication Errors", "items": { "$ref": "#/definitions/AcsRouterCommunicationError" }, "readOnly": true } }, "required": [ "innererror", "details" ] }, "AcsRouterEventData": { "type": "object", "description": "Schema of common properties of all Router events", "properties": { "jobId": { "type": "string", "description": "Router Event Job ID" }, "channelReference": { "type": "string", "description": "Router Event Channel Reference" }, "channelId": { "type": "string", "description": "Router Event Channel ID" } } }, "AcsRouterJobCancelledEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCancelled event", "properties": { "note": { "type": "string", "description": "Router Job Note" }, "dispositionCode": { "type": "string", "description": "Router Job Disposition Code" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobClassificationFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassificationFailed event", "properties": { "classificationPolicyId": { "type": "string", "description": "Router Job Classification Policy Id" }, "errors": { "type": "array", "description": "Router Job Classification Failed Errors", "items": { "$ref": "#/definitions/AcsRouterCommunicationError" }, "readOnly": true } }, "required": [ "errors" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobClassifiedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClassified event", "properties": { "queueDetails": { "$ref": "#/definitions/AcsRouterQueueDetails", "description": "Router Job Queue Info" }, "classificationPolicyId": { "type": "string", "description": "Router Job Classification Policy Id" }, "priority": { "type": "integer", "format": "int32", "description": "Router Job Priority" }, "attachedWorkerSelectors": { "type": "array", "description": "Router Job Attached Worker Selector", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true } }, "required": [ "queueDetails", "attachedWorkerSelectors" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobClosedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed event", "properties": { "assignmentId": { "type": "string", "description": "Router Job Closed Assignment Id" }, "workerId": { "type": "string", "description": "Router Job Closed Worker Id" }, "dispositionCode": { "type": "string", "description": "Router Job Closed Disposition Code" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobCompleted event", "properties": { "assignmentId": { "type": "string", "description": "Router Job Completed Assignment Id" }, "workerId": { "type": "string", "description": "Router Job Completed Worker Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted event", "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobEventData": { "type": "object", "description": "Schema of common properties of all Router Job events", "properties": { "queueId": { "type": "string", "description": "Router Job events Queue Id" }, "labels": { "type": "object", "description": "Router Job events Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "tags": { "type": "object", "description": "Router Jobs events Tags", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "labels", "tags" ], "allOf": [ { "$ref": "#/definitions/AcsRouterEventData" } ] }, "AcsRouterJobExceptionTriggeredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobExceptionTriggered event", "properties": { "ruleKey": { "type": "string", "description": "Router Job Exception Triggered Rule Key" }, "exceptionRuleId": { "type": "string", "description": "Router Job Exception Triggered Rule Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobQueuedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued event", "properties": { "priority": { "type": "integer", "format": "int32", "description": "Router Job Priority" }, "attachedWorkerSelectors": { "type": "array", "description": "Router Job Queued Attached Worker Selector", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "requestedWorkerSelectors": { "type": "array", "description": "Router Job Queued Requested Worker Selector", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true } }, "required": [ "attachedWorkerSelectors", "requestedWorkerSelectors" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobReceived event", "properties": { "jobStatus": { "$ref": "#/definitions/AcsRouterJobStatus", "description": "Router Job Received Job Status" }, "classificationPolicyId": { "type": "string", "description": "Router Job Classification Policy Id" }, "priority": { "type": "integer", "format": "int32", "description": "Router Job Priority" }, "requestedWorkerSelectors": { "type": "array", "description": "Router Job Received Requested Worker Selectors", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "scheduledOn": { "type": "string", "format": "date-time", "description": "Router Job Received Scheduled Time in UTC" }, "unavailableForMatching": { "type": "boolean", "description": "Unavailable For Matching for Router Job Received" } }, "required": [ "requestedWorkerSelectors", "unavailableForMatching" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobSchedulingFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobSchedulingFailed event", "properties": { "priority": { "type": "integer", "format": "int32", "description": "Router Job Priority" }, "expiredAttachedWorkerSelectors": { "type": "array", "description": "Router Job Scheduling Failed Attached Worker Selector Expired", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "expiredRequestedWorkerSelectors": { "type": "array", "description": "Router Job Scheduling Failed Requested Worker Selector Expired", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "scheduledOn": { "type": "string", "format": "date-time", "description": "Router Job Scheduling Failed Scheduled Time in UTC" }, "failureReason": { "type": "string", "description": "Router Job Scheduling Failed Reason" } }, "required": [ "expiredAttachedWorkerSelectors", "expiredRequestedWorkerSelectors" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobStatus": { "type": "string", "description": "Acs Router Job Status", "enum": [ "PendingClassification", "Queued", "Assigned", "Completed", "Closed", "Cancelled", "ClassificationFailed", "Created", "PendingSchedule", "Scheduled", "ScheduleFailed", "WaitingForActivation" ], "x-ms-enum": { "name": "AcsRouterJobStatus", "modelAsString": true, "values": [ { "name": "PendingClassification", "value": "PendingClassification", "description": "Router Job Status Pending Classification" }, { "name": "Queued", "value": "Queued", "description": "Router Job Status Queued" }, { "name": "Assigned", "value": "Assigned", "description": "Router Job Status Assigned" }, { "name": "Completed", "value": "Completed", "description": "Router Job Status Completed" }, { "name": "Closed", "value": "Closed", "description": "Router Job Status Closed" }, { "name": "Cancelled", "value": "Cancelled", "description": "Router Job Status Cancelled" }, { "name": "ClassificationFailed", "value": "ClassificationFailed", "description": "Router Job Status Classification Failed" }, { "name": "Created", "value": "Created", "description": "Router Job Status Created" }, { "name": "PendingSchedule", "value": "PendingSchedule", "description": "Router Job Status Pending Schedule" }, { "name": "Scheduled", "value": "Scheduled", "description": "Router Job Status Scheduled" }, { "name": "ScheduleFailed", "value": "ScheduleFailed", "description": "Router Job Status Schedule Failed" }, { "name": "WaitingForActivation", "value": "WaitingForActivation", "description": "Router Job Status Waiting For Activation" } ] } }, "AcsRouterJobUnassignedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobUnassigned event", "properties": { "assignmentId": { "type": "string", "description": "Router Job Unassigned Assignment Id" }, "workerId": { "type": "string", "description": "Router Job Unassigned Worker Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobWaitingForActivationEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWaitingForActivation event", "properties": { "priority": { "type": "integer", "format": "int32", "description": "Router Job Waiting For Activation Priority" }, "expiredAttachedWorkerSelectors": { "type": "array", "description": "Router Job Waiting For Activation Worker Selector Expired", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "expiredRequestedWorkerSelectors": { "type": "array", "description": "Router Job Waiting For Activation Requested Worker Selector Expired", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "scheduledOn": { "type": "string", "format": "date-time", "description": "Router Job Waiting For Activation Scheduled Time in UTC" }, "unavailableForMatching": { "type": "boolean", "description": "Router Job Waiting For Activation Unavailable For Matching" } }, "required": [ "expiredAttachedWorkerSelectors", "expiredRequestedWorkerSelectors", "unavailableForMatching" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterJobWorkerSelectorsExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobWorkerSelectorsExpired event", "properties": { "expiredRequestedWorkerSelectors": { "type": "array", "description": "Router Job Worker Selectors Expired Requested Worker Selectors", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true }, "expiredAttachedWorkerSelectors": { "type": "array", "description": "Router Job Worker Selectors Expired Attached Worker Selectors", "items": { "$ref": "#/definitions/AcsRouterWorkerSelector" }, "readOnly": true } }, "required": [ "expiredRequestedWorkerSelectors", "expiredAttachedWorkerSelectors" ], "allOf": [ { "$ref": "#/definitions/AcsRouterJobEventData" } ] }, "AcsRouterLabelOperator": { "type": "string", "description": "Router Job Worker Selector Label Operator", "enum": [ "Equal", "NotEqual", "Greater", "Less", "GreaterThanOrEqual", "LessThanOrEqual" ], "x-ms-enum": { "name": "AcsRouterLabelOperator", "modelAsString": true, "values": [ { "name": "Equal", "value": "Equal", "description": "Router Label Operator Equal" }, { "name": "NotEqual", "value": "NotEqual", "description": "Router Label Operator Not Equal" }, { "name": "Greater", "value": "Greater", "description": "Router Label Operator Greater" }, { "name": "Less", "value": "Less", "description": "Router Label Operator Less" }, { "name": "GreaterThanOrEqual", "value": "GreaterThanOrEqual", "description": "Router Label Operator Greater than or equal" }, { "name": "LessThanOrEqual", "value": "LessThanOrEqual", "description": "Router Label Operator Less than or equal" } ] } }, "AcsRouterQueueDetails": { "type": "object", "description": "Router Queue Details", "properties": { "id": { "type": "string", "description": "Router Queue Id" }, "name": { "type": "string", "description": "Router Queue Name" }, "labels": { "type": "object", "description": "Router Queue Labels", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "labels" ] }, "AcsRouterUpdatedWorkerProperty": { "type": "string", "description": "Worker properties that can be updated", "enum": [ "AvailableForOffers", "TotalCapacity", "QueueAssignments", "Labels", "Tags", "ChannelConfigurations" ], "x-ms-enum": { "name": "AcsRouterUpdatedWorkerProperty", "modelAsString": true, "values": [ { "name": "AvailableForOffers", "value": "AvailableForOffers", "description": "AvailableForOffers" }, { "name": "TotalCapacity", "value": "TotalCapacity", "description": "TotalCapacity" }, { "name": "QueueAssignments", "value": "QueueAssignments", "description": "QueueAssignments" }, { "name": "Labels", "value": "Labels", "description": "Labels" }, { "name": "Tags", "value": "Tags", "description": "Tags" }, { "name": "ChannelConfigurations", "value": "ChannelConfigurations", "description": "ChannelConfigurations" } ] } }, "AcsRouterWorkerDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeleted event", "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerDeregisteredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerDeregistered event", "properties": { "workerId": { "type": "string", "description": "Router Worker Deregistered Worker Id" } } }, "AcsRouterWorkerEventData": { "type": "object", "description": "Schema of common properties of all Router Worker events", "properties": { "workerId": { "type": "string", "description": "Router Worker events Worker Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterEventData" } ] }, "AcsRouterWorkerOfferAcceptedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferAccepted event", "properties": { "queueId": { "type": "string", "description": "Router Worker Offer Accepted Queue Id" }, "offerId": { "type": "string", "description": "Router Worker Offer Accepted Offer Id" }, "assignmentId": { "type": "string", "description": "Router Worker Offer Accepted Assignment Id" }, "jobPriority": { "type": "integer", "format": "int32", "description": "Router Worker Offer Accepted Job Priority" }, "workerLabels": { "type": "object", "description": "Router Worker Offer Accepted Worker Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "workerTags": { "type": "object", "description": "Router Worker Offer Accepted Worker Tags", "additionalProperties": { "type": "string" }, "readOnly": true }, "jobLabels": { "type": "object", "description": "Router Worker Offer Accepted Job Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "jobTags": { "type": "object", "description": "Router Worker Offer Accepted Job Tags", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "workerLabels", "workerTags", "jobLabels", "jobTags" ], "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerOfferDeclinedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferDeclined event", "properties": { "queueId": { "type": "string", "description": "Router Worker Offer Declined Queue Id" }, "offerId": { "type": "string", "description": "Router Worker Offer Declined Offer Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerOfferExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferExpired event", "properties": { "queueId": { "type": "string", "description": "Router Worker Offer Expired Queue Id" }, "offerId": { "type": "string", "description": "Router Worker Offer Expired Offer Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerOfferIssuedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferIssued event", "properties": { "queueId": { "type": "string", "description": "Router Worker Offer Issued Queue Id" }, "offerId": { "type": "string", "description": "Router Worker Offer Issued Offer Id" }, "jobPriority": { "type": "integer", "format": "int32", "description": "Router Worker Offer Issued Job Priority" }, "workerLabels": { "type": "object", "description": "Router Worker Offer Issued Worker Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "offeredOn": { "type": "string", "format": "date-time", "description": "Router Worker Offer Issued Time in UTC" }, "expiresOn": { "type": "string", "format": "date-time", "description": "Router Worker Offer Issued Expiration Time in UTC" }, "workerTags": { "type": "object", "description": "Router Worker Offer Issued Worker Tags", "additionalProperties": { "type": "string" }, "readOnly": true }, "jobLabels": { "type": "object", "description": "Router Worker Offer Issued Job Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "jobTags": { "type": "object", "description": "Router Worker Offer Issued Job Tags", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "workerLabels", "workerTags", "jobLabels", "jobTags" ], "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerOfferRevokedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerOfferRevoked event", "properties": { "queueId": { "type": "string", "description": "Router Worker Offer Revoked Queue Id" }, "offerId": { "type": "string", "description": "Router Worker Offer Revoked Offer Id" } }, "allOf": [ { "$ref": "#/definitions/AcsRouterWorkerEventData" } ] }, "AcsRouterWorkerRegisteredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerRegistered event", "properties": { "workerId": { "type": "string", "description": "Router Worker Registered Worker Id" }, "queueAssignments": { "type": "array", "description": "Router Worker Registered Queue Info", "items": { "$ref": "#/definitions/AcsRouterQueueDetails" }, "readOnly": true }, "channelConfigurations": { "type": "array", "description": "Router Worker Registered Channel Configuration", "items": { "$ref": "#/definitions/AcsRouterChannelConfiguration" }, "readOnly": true }, "totalCapacity": { "type": "integer", "format": "int32", "description": "Router Worker Register Total Capacity" }, "labels": { "type": "object", "description": "Router Worker Registered Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "tags": { "type": "object", "description": "Router Worker Registered Tags", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "queueAssignments", "channelConfigurations", "labels", "tags" ] }, "AcsRouterWorkerSelector": { "type": "object", "description": "Router Job Worker Selector", "properties": { "key": { "type": "string", "description": "Router Job Worker Selector Key" }, "labelOperator": { "$ref": "#/definitions/AcsRouterLabelOperator", "description": "Router Job Worker Selector Label Operator" }, "value": { "description": "Router Job Worker Selector Value", "x-ms-client-name": "labelValue" }, "ttlSeconds": { "type": "number", "format": "double", "description": "Router Job Worker Selector Time to Live in Seconds" }, "state": { "$ref": "#/definitions/AcsRouterWorkerSelectorState", "description": "Router Job Worker Selector State" }, "expirationTime": { "type": "string", "format": "date-time", "description": "Router Job Worker Selector Expiration Time" } }, "required": [ "value", "ttlSeconds" ] }, "AcsRouterWorkerSelectorState": { "type": "string", "description": "Router Worker Selector State", "enum": [ "active", "expired" ], "x-ms-enum": { "name": "AcsRouterWorkerSelectorState", "modelAsString": true, "values": [ { "name": "Active", "value": "active", "description": "Router Worker Selector State Active" }, { "name": "Expired", "value": "expired", "description": "Router Worker Selector State Expired" } ] } }, "AcsRouterWorkerUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterWorkerUpdated event.", "properties": { "workerId": { "type": "string", "description": "Router Worker Updated Worker Id" }, "queueAssignments": { "type": "array", "description": "Router Worker Updated Queue Info", "items": { "$ref": "#/definitions/AcsRouterQueueDetails" }, "readOnly": true }, "channelConfigurations": { "type": "array", "description": "Router Worker Updated Channel Configuration", "items": { "$ref": "#/definitions/AcsRouterChannelConfiguration" }, "readOnly": true }, "totalCapacity": { "type": "integer", "format": "int32", "description": "Router Worker Updated Total Capacity" }, "labels": { "type": "object", "description": "Router Worker Updated Labels", "additionalProperties": { "type": "string" }, "readOnly": true }, "tags": { "type": "object", "description": "Router Worker Updated Tags", "additionalProperties": { "type": "string" }, "readOnly": true }, "updatedWorkerProperties": { "type": "array", "description": "Router Worker Properties Updated", "items": { "$ref": "#/definitions/AcsRouterUpdatedWorkerProperty" }, "readOnly": true } }, "required": [ "queueAssignments", "channelConfigurations", "labels", "tags", "updatedWorkerProperties" ] }, "AcsSmsDeliveryAttemptProperties": { "type": "object", "description": "Schema for details of a delivery attempt", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "TimeStamp when delivery was attempted" }, "segmentsSucceeded": { "type": "integer", "format": "int32", "description": "Number of segments that were successfully delivered" }, "segmentsFailed": { "type": "integer", "format": "int32", "description": "Number of segments whose delivery failed" } } }, "AcsSmsDeliveryReportReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSDeliveryReportReceived event.", "properties": { "deliveryStatus": { "type": "string", "description": "Status of Delivery" }, "deliveryStatusDetails": { "type": "string", "description": "Details about Delivery Status" }, "deliveryAttempts": { "type": "array", "description": "List of details of delivery attempts made", "items": { "$ref": "#/definitions/AcsSmsDeliveryAttemptProperties" }, "readOnly": true }, "receivedTimestamp": { "type": "string", "format": "date-time", "description": "The time at which the SMS delivery report was received" }, "tag": { "type": "string", "description": "Customer Content" } }, "required": [ "deliveryStatus", "deliveryStatusDetails", "deliveryAttempts" ], "allOf": [ { "$ref": "#/definitions/AcsSmsEventBaseProperties" } ] }, "AcsSmsEventBaseProperties": { "type": "object", "description": "Schema of common properties of all SMS events", "properties": { "messageId": { "type": "string", "description": "The identity of the SMS message" }, "from": { "type": "string", "description": "The identity of SMS message sender" }, "to": { "type": "string", "description": "The identity of SMS message receiver" } }, "required": [ "messageId", "from", "to" ] }, "AcsSmsReceivedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived event.", "properties": { "message": { "type": "string", "description": "The SMS content" }, "receivedTimestamp": { "type": "string", "format": "date-time", "description": "The time at which the SMS was received" }, "segmentCount": { "type": "integer", "format": "int32", "description": "Number of segments in the message" } }, "required": [ "message", "segmentCount" ], "allOf": [ { "$ref": "#/definitions/AcsSmsEventBaseProperties" } ] }, "AcsUserDisconnectedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", "properties": { "userCommunicationIdentifier": { "$ref": "#/definitions/CommunicationIdentifierModel", "description": "The communication identifier of the user who was disconnected" } }, "required": [ "userCommunicationIdentifier" ] }, "AcsUserEngagement": { "type": "string", "description": "The type of engagement user have with email.", "enum": [ "view", "click" ], "x-ms-enum": { "name": "AcsUserEngagement", "modelAsString": true, "values": [ { "name": "view", "value": "view", "description": "View" }, { "name": "click", "value": "click", "description": "Click" } ] } }, "ApiCenterApiDefinitionAddedEventData": { "type": "object", "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded event.", "properties": { "title": { "type": "string", "description": "API definition title." }, "description": { "type": "string", "description": "API definition description." }, "specification": { "$ref": "#/definitions/ApiCenterApiSpecification", "description": "API definition specification." } }, "required": [ "title" ] }, "ApiCenterApiDefinitionUpdatedEventData": { "type": "object", "description": "Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated event.", "properties": { "title": { "type": "string", "description": "API definition title." }, "description": { "type": "string", "description": "API definition description." }, "specification": { "$ref": "#/definitions/ApiCenterApiSpecification", "description": "API definition specification." } }, "required": [ "title" ] }, "ApiCenterApiSpecification": { "type": "object", "description": "API specification details.", "properties": { "name": { "type": "string", "description": "Specification name." }, "version": { "type": "string", "description": "Specification version." } }, "required": [ "name" ] }, "ApiEntityReference": { "type": "object", "description": "The API entity reference.", "properties": { "id": { "type": "string", "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "required": [ "id" ] }, "ApiManagementApiCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementApiDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementApiReleaseCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementApiReleaseDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementApiReleaseUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIReleaseUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementApiUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementCircuitBreakerClosedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.CircuitBreaker.Closed event.", "properties": { "backendName": { "type": "string", "description": "Name of the backend for which the circuit has closed." }, "circuitBreaker": { "$ref": "#/definitions/ApiManagementCircuitBreakerProperties", "description": "Information related to the circuit breaker configured on the backend." } }, "required": [ "backendName", "circuitBreaker" ] }, "ApiManagementCircuitBreakerOpenedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.CircuitBreaker.Opened event.", "properties": { "backendName": { "type": "string", "description": "Name of the backend for which the circuit has opened." }, "circuitBreaker": { "$ref": "#/definitions/ApiManagementCircuitBreakerProperties", "description": "Information related to the circuit breaker configured on the backend." } }, "required": [ "backendName", "circuitBreaker" ] }, "ApiManagementCircuitBreakerProperties": { "type": "object", "description": "Information related to the circuit breaker configured on the backend.", "properties": { "rules": { "type": "object", "description": "Overview of all configured rules and respective details.", "additionalProperties": { "additionalProperties": {}, "type": "object" } } }, "required": [ "rules" ] }, "ApiManagementExpiredGatewayTokenProperties": { "type": "object", "description": "Information related to a gateway token that has expired for a self-hosted gateway deployment.", "properties": { "expiredAtUtc": { "type": "string", "format": "date-time", "description": "Timestamp when the gateway token has expired.", "x-ms-client-name": "expiresOn" } } }, "ApiManagementGatewayApiAddedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayApiRemovedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIRemoved event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//apis/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayCertificateAuthorityCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayCertificateAuthorityDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayCertificateAuthorityUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//certificateAuthorities/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayHostnameConfigurationCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayHostnameConfigurationDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayHostnameConfigurationUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways//hostnameConfigurations/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementGatewayProperties": { "type": "object", "description": "Information related to a given self-hosted gateway deployment.", "properties": { "gatewayId": { "type": "string", "description": "Id of Gateway that is used to deploy the gateway to get the configuration for. This is the ARM resource ID referenced in the Azure API Management instance. Uses the format, `/subscriptions//resourceGroups//Microsoft.ApiManagement/service//gateway/`" }, "instanceId": { "type": "string", "description": "Unique instance ID of the deployed gateway" } }, "required": [ "gatewayId", "instanceId" ] }, "ApiManagementGatewayTokenExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayTokenExpired event.", "properties": { "gatewayInfo": { "$ref": "#/definitions/ApiManagementGatewayProperties", "description": "Information related to a given self-hosted gateway deployment.", "x-ms-client-name": "gateway" }, "tokenInfo": { "$ref": "#/definitions/ApiManagementExpiredGatewayTokenProperties", "description": "Information related to a an expired gateway token for a self-hosted gateway deployment.", "x-ms-client-name": "token" } }, "required": [ "gatewayInfo", "tokenInfo" ] }, "ApiManagementGatewayTokenNearExpiryEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayTokenNearExpiry event.", "properties": { "gatewayInfo": { "$ref": "#/definitions/ApiManagementGatewayProperties", "description": "Information related to a given self-hosted gateway deployment.", "x-ms-client-name": "gateway" }, "tokenInfo": { "$ref": "#/definitions/ApiManagementNearExpiryGatewayTokenProperties", "description": "Information related to a an expired gateway token for a self-hosted gateway deployment.", "x-ms-client-name": "token" } }, "required": [ "gatewayInfo", "tokenInfo" ] }, "ApiManagementGatewayUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service//gateways/`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementNearExpiryGatewayTokenProperties": { "type": "object", "description": "Information related to a gateway token that is near expiry for a self-hosted gateway deployment.", "properties": { "expiredAtUtc": { "type": "string", "format": "date-time", "description": "Timestamp when the gateway token will expire.", "x-ms-client-name": "expiresOn" } } }, "ApiManagementProductCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementProductDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementProductUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementSubscriptionCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementSubscriptionDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementSubscriptionUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementUserCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementUserDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "ApiManagementUserUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.", "properties": { "resourceUri": { "type": "string", "description": "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//resourceGroups//Microsoft.ApiManagement/service///`", "x-ms-client-name": "resourceUrl" } } }, "AppAction": { "type": "string", "description": "Type of action of the operation", "enum": [ "Restarted", "Stopped", "ChangedAppSettings", "Started", "Completed", "Failed" ], "x-ms-enum": { "name": "AppAction", "modelAsString": true, "values": [ { "name": "Restarted", "value": "Restarted", "description": "Web app was restarted." }, { "name": "Stopped", "value": "Stopped", "description": "Web app was stopped." }, { "name": "ChangedAppSettings", "value": "ChangedAppSettings", "description": "There was an operation to change app setting on the web app." }, { "name": "Started", "value": "Started", "description": "The job has started." }, { "name": "Completed", "value": "Completed", "description": "The job has completed." }, { "name": "Failed", "value": "Failed", "description": "The job has failed to complete." } ] } }, "AppConfigurationKeyValueDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueDeleted event.", "properties": { "key": { "type": "string", "description": "The key used to identify the key-value that was deleted." }, "label": { "type": "string", "description": "The label, if any, used to identify the key-value that was deleted." }, "etag": { "type": "string", "description": "The etag representing the key-value that was deleted." }, "syncToken": { "type": "string", "description": "The sync token representing the server state after the event." } }, "required": [ "key", "label", "etag", "syncToken" ] }, "AppConfigurationKeyValueModifiedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.KeyValueModified event.", "properties": { "key": { "type": "string", "description": "The key used to identify the key-value that was modified." }, "label": { "type": "string", "description": "The label, if any, used to identify the key-value that was modified.", "x-nullable": true }, "etag": { "type": "string", "description": "The etag representing the new state of the key-value." }, "syncToken": { "type": "string", "description": "The sync token representing the server state after the event." } }, "required": [ "key", "label", "etag", "syncToken" ] }, "AppConfigurationSnapshotCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotCreated event.", "allOf": [ { "$ref": "#/definitions/AppConfigurationSnapshotEventData" } ] }, "AppConfigurationSnapshotEventData": { "type": "object", "description": "Schema of common properties of snapshot events", "properties": { "name": { "type": "string", "description": "The name of the snapshot." }, "etag": { "type": "string", "description": "The etag representing the new state of the snapshot." }, "syncToken": { "type": "string", "description": "The sync token representing the server state after the event." } }, "required": [ "name", "etag", "syncToken" ] }, "AppConfigurationSnapshotModifiedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AppConfiguration.SnapshotModified event.", "allOf": [ { "$ref": "#/definitions/AppConfigurationSnapshotEventData" } ] }, "AppEventTypeDetail": { "type": "object", "description": "Detail of action on the app.", "properties": { "action": { "$ref": "#/definitions/AppAction", "description": "Type of action of the operation." } } }, "AppServicePlanAction": { "type": "string", "description": "Type of action on the app service plan.", "enum": [ "Updated" ], "x-ms-enum": { "name": "AppServicePlanAction", "modelAsString": true, "values": [ { "name": "Updated", "value": "Updated", "description": "App Service plan is being updated." } ] } }, "AppServicePlanEventTypeDetail": { "type": "object", "description": "Detail of action on the app service plan.", "properties": { "stampKind": { "$ref": "#/definitions/StampKind", "description": "Kind of environment where app service plan is." }, "action": { "$ref": "#/definitions/AppServicePlanAction", "description": "Type of action on the app service plan." }, "status": { "$ref": "#/definitions/AsyncStatus", "description": "Asynchronous operation status of the operation on the app service plan." } } }, "AsyncStatus": { "type": "string", "description": "Asynchronous operation status of the operation on the app service plan.", "enum": [ "Started", "Completed", "Failed" ], "x-ms-enum": { "name": "AsyncStatus", "modelAsString": true, "values": [ { "name": "Started", "value": "Started", "description": "Async operation has started." }, { "name": "Completed", "value": "Completed", "description": "Async operation has completed." }, { "name": "Failed", "value": "Failed", "description": "Async operation failed to complete." } ] } }, "AvsClusterCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event.", "allOf": [ { "$ref": "#/definitions/AvsClusterEventData" } ] }, "AvsClusterDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event.", "allOf": [ { "$ref": "#/definitions/AvsClusterEventData" } ] }, "AvsClusterEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events.", "properties": { "operationId": { "type": "string", "description": "Id of the operation that caused this event." }, "addedHostNames": { "type": "array", "description": "Hosts added to the cluster in this event, if any.", "items": { "type": "string" }, "readOnly": true }, "removedHostNames": { "type": "array", "description": "Hosts removed from the cluster in this event, if any.", "items": { "type": "string" }, "readOnly": true }, "inMaintenanceHostNames": { "type": "array", "description": "Hosts in Maintenance mode in the cluster, if any.", "items": { "type": "string" }, "readOnly": true } }, "required": [ "operationId" ] }, "AvsClusterFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event.", "properties": { "failureMessage": { "type": "string", "description": "Failure reason of an event." } }, "allOf": [ { "$ref": "#/definitions/AvsClusterEventData" } ] }, "AvsClusterUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event.", "allOf": [ { "$ref": "#/definitions/AvsClusterEventData" } ] }, "AvsClusterUpdatingEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event.", "allOf": [ { "$ref": "#/definitions/AvsClusterEventData" } ] }, "AvsPrivateCloudEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events.", "properties": { "operationId": { "type": "string", "description": "Id of the operation that caused this event." } }, "required": [ "operationId" ] }, "AvsPrivateCloudFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event.", "properties": { "failureMessage": { "type": "string", "description": "Failure reason of an event." } }, "allOf": [ { "$ref": "#/definitions/AvsPrivateCloudEventData" } ] }, "AvsPrivateCloudUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event.", "allOf": [ { "$ref": "#/definitions/AvsPrivateCloudEventData" } ] }, "AvsPrivateCloudUpdatingEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating event.", "allOf": [ { "$ref": "#/definitions/AvsPrivateCloudEventData" } ] }, "AvsScriptExecutionCancelledEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled event.", "allOf": [ { "$ref": "#/definitions/AvsScriptExecutionEventData" } ] }, "AvsScriptExecutionEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events.", "properties": { "operationId": { "type": "string", "description": "Id of the operation that caused this event." }, "cmdletId": { "type": "string", "description": "Cmdlet referenced in the execution that caused this event." }, "output": { "type": "array", "description": "Stdout outputs from the execution, if any.", "items": { "type": "string" }, "readOnly": true } }, "required": [ "operationId", "cmdletId" ] }, "AvsScriptExecutionFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed event.", "properties": { "failureMessage": { "type": "string", "description": "Failure reason of an event." } }, "allOf": [ { "$ref": "#/definitions/AvsScriptExecutionEventData" } ] }, "AvsScriptExecutionFinishedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished event.", "properties": { "namedOutputs": { "type": "object", "description": "Named outputs of completed execution, if any.", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "namedOutputs" ], "allOf": [ { "$ref": "#/definitions/AvsScriptExecutionEventData" } ] }, "AvsScriptExecutionStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted event.", "allOf": [ { "$ref": "#/definitions/AvsScriptExecutionEventData" } ] }, "CommunicationCloudEnvironmentModel": { "type": "string", "description": "Communication cloud environment model.", "enum": [ "public", "dod", "gcch" ], "x-ms-enum": { "name": "CommunicationCloudEnvironmentModel", "modelAsString": true, "values": [ { "name": "public", "value": "public", "description": "Public" }, { "name": "dod", "value": "dod", "description": "Dod" }, { "name": "gcch", "value": "gcch", "description": "Gcch" } ] } }, "CommunicationIdentifierModel": { "type": "object", "description": "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.", "properties": { "kind": { "$ref": "#/definitions/CommunicationIdentifierModelKind", "description": "The identifier kind. Only required in responses." }, "rawId": { "type": "string", "description": "Raw Id of the identifier. Optional in requests, required in responses." }, "communicationUser": { "$ref": "#/definitions/CommunicationUserIdentifierModel", "description": "The communication user." }, "phoneNumber": { "$ref": "#/definitions/PhoneNumberIdentifierModel", "description": "The phone number." }, "microsoftTeamsUser": { "$ref": "#/definitions/MicrosoftTeamsUserIdentifierModel", "description": "The Microsoft Teams user." }, "microsoftTeamsApp": { "$ref": "#/definitions/MicrosoftTeamsAppIdentifierModel", "description": "The Microsoft Teams application." } }, "required": [ "rawId", "communicationUser" ] }, "CommunicationIdentifierModelKind": { "type": "string", "description": "Communication model identifier kind", "enum": [ "unknown", "communicationUser", "phoneNumber", "microsoftTeamsUser", "microsoftTeamsApp" ], "x-ms-enum": { "name": "CommunicationIdentifierModelKind", "modelAsString": true, "values": [ { "name": "unknown", "value": "unknown", "description": "Unknown" }, { "name": "communicationUser", "value": "communicationUser", "description": "Communication User" }, { "name": "phoneNumber", "value": "phoneNumber", "description": "Phone Number" }, { "name": "microsoftTeamsUser", "value": "microsoftTeamsUser", "description": "Microsoft Teams User" }, { "name": "microsoftTeamsApp", "value": "microsoftTeamsApp", "description": "Microsoft Teams App" } ] } }, "CommunicationUserIdentifierModel": { "type": "object", "description": "A user that got created with an Azure Communication Services resource.", "properties": { "id": { "type": "string", "description": "The Id of the communication user." } }, "required": [ "id" ] }, "ContainerRegistryArtifactEventData": { "type": "object", "description": "The content of the event request message.", "properties": { "id": { "type": "string", "description": "The event ID." }, "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "action": { "type": "string", "description": "The action that encompasses the provided event." }, "location": { "type": "string", "description": "The location of the event." }, "target": { "$ref": "#/definitions/ContainerRegistryArtifactEventTarget", "description": "The target of the event." }, "connectedRegistry": { "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", "description": "The connected registry information if the event is generated by a connected registry." } }, "required": [ "id", "action", "location", "target" ] }, "ContainerRegistryArtifactEventTarget": { "type": "object", "description": "The target of the event.", "properties": { "mediaType": { "type": "string", "description": "The MIME type of the artifact." }, "size": { "type": "integer", "format": "int64", "description": "The size in bytes of the artifact." }, "digest": { "type": "string", "description": "The digest of the artifact." }, "repository": { "type": "string", "description": "The repository name of the artifact." }, "tag": { "type": "string", "description": "The tag of the artifact." }, "name": { "type": "string", "description": "The name of the artifact." }, "version": { "type": "string", "description": "The version of the artifact." } }, "required": [ "mediaType", "repository" ] }, "ContainerRegistryChartDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.", "allOf": [ { "$ref": "#/definitions/ContainerRegistryArtifactEventData" } ] }, "ContainerRegistryChartPushedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.", "allOf": [ { "$ref": "#/definitions/ContainerRegistryArtifactEventData" } ] }, "ContainerRegistryEventActor": { "type": "object", "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request.", "properties": { "name": { "type": "string", "description": "The subject or username associated with the request context that generated the event." } } }, "ContainerRegistryEventConnectedRegistry": { "type": "object", "description": "The connected registry information if the event is generated by a connected registry.", "properties": { "name": { "type": "string", "description": "The name of the connected registry that generated this event." } }, "required": [ "name" ] }, "ContainerRegistryEventData": { "type": "object", "description": "The content of the event request message.", "properties": { "id": { "type": "string", "description": "The event ID." }, "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "action": { "type": "string", "description": "The action that encompasses the provided event." }, "location": { "type": "string", "description": "The location of the event." }, "target": { "$ref": "#/definitions/ContainerRegistryEventTarget", "description": "The target of the event." }, "request": { "$ref": "#/definitions/ContainerRegistryEventRequest", "description": "The request that generated the event." }, "actor": { "$ref": "#/definitions/ContainerRegistryEventActor", "description": "The agent that initiated the event. For most situations, this could be from the authorization context of the request." }, "source": { "$ref": "#/definitions/ContainerRegistryEventSource", "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it." }, "connectedRegistry": { "$ref": "#/definitions/ContainerRegistryEventConnectedRegistry", "description": "The connected registry information if the event is generated by a connected registry." } }, "required": [ "id", "action", "location", "target" ] }, "ContainerRegistryEventRequest": { "type": "object", "description": "The request that generated the event.", "properties": { "id": { "type": "string", "description": "The ID of the request that initiated the event." }, "addr": { "type": "string", "description": "The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request." }, "host": { "type": "string", "description": "The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests." }, "method": { "type": "string", "description": "The request method that generated the event." }, "useragent": { "type": "string", "description": "The user agent header of the request." } }, "required": [ "id", "host", "method" ] }, "ContainerRegistryEventSource": { "type": "object", "description": "The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.", "properties": { "addr": { "type": "string", "description": "The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port." }, "instanceID": { "type": "string", "description": "The running instance of an application. Changes after each restart.", "x-ms-client-name": "instanceId" } } }, "ContainerRegistryEventTarget": { "type": "object", "description": "The target of the event.", "properties": { "mediaType": { "type": "string", "description": "The MIME type of the referenced object." }, "size": { "type": "integer", "format": "int64", "description": "The number of bytes of the content. Same as Length field." }, "digest": { "type": "string", "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification." }, "length": { "type": "integer", "format": "int64", "description": "The number of bytes of the content. Same as Size field." }, "repository": { "type": "string", "description": "The repository name." }, "url": { "type": "string", "description": "The direct URL to the content." }, "tag": { "type": "string", "description": "The tag name." } }, "required": [ "mediaType", "repository" ] }, "ContainerRegistryImageDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.", "allOf": [ { "$ref": "#/definitions/ContainerRegistryEventData" } ] }, "ContainerRegistryImagePushedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.", "allOf": [ { "$ref": "#/definitions/ContainerRegistryEventData" } ] }, "ContainerServiceClusterSupportEndedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnded event", "allOf": [ { "$ref": "#/definitions/ContainerServiceClusterSupportEventData" } ] }, "ContainerServiceClusterSupportEndingEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.ClusterSupportEnding event", "allOf": [ { "$ref": "#/definitions/ContainerServiceClusterSupportEventData" } ] }, "ContainerServiceClusterSupportEventData": { "type": "object", "description": "Schema of common properties of cluster support events", "properties": { "kubernetesVersion": { "type": "string", "description": "The Kubernetes version of the ManagedCluster resource" } }, "required": [ "kubernetesVersion" ] }, "ContainerServiceNewKubernetesVersionAvailableEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NewKubernetesVersionAvailable event", "properties": { "latestSupportedKubernetesVersion": { "type": "string", "description": "The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster resource" }, "latestStableKubernetesVersion": { "type": "string", "description": "The highest PATCH Kubernetes version for the MINOR version considered stable for the ManagedCluster resource" }, "lowestMinorKubernetesVersion": { "type": "string", "description": "The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the ManagedCluster resource" }, "latestPreviewKubernetesVersion": { "type": "string", "description": "The highest PATCH Kubernetes version considered preview for the ManagedCluster resource. There might not be any version in preview at the time of publishing the event" } }, "required": [ "latestSupportedKubernetesVersion", "latestStableKubernetesVersion", "lowestMinorKubernetesVersion" ] }, "ContainerServiceNodePoolRollingEventData": { "type": "object", "description": "Schema of common properties of node pool rolling events", "properties": { "nodePoolName": { "type": "string", "description": "The name of the node pool in the ManagedCluster resource" } }, "required": [ "nodePoolName" ] }, "ContainerServiceNodePoolRollingFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingFailed event", "allOf": [ { "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" } ] }, "ContainerServiceNodePoolRollingStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingStarted event", "allOf": [ { "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" } ] }, "ContainerServiceNodePoolRollingSucceededEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerService.NodePoolRollingSucceeded event", "allOf": [ { "$ref": "#/definitions/ContainerServiceNodePoolRollingEventData" } ] }, "DataBoxCopyCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event.", "properties": { "serialNumber": { "type": "string", "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." }, "stageName": { "$ref": "#/definitions/DataBoxStageName", "description": "Name of the current Stage" }, "stageTime": { "type": "string", "format": "date-time", "description": "The time at which the stage happened." } }, "required": [ "serialNumber" ] }, "DataBoxCopyStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event.", "properties": { "serialNumber": { "type": "string", "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." }, "stageName": { "$ref": "#/definitions/DataBoxStageName", "description": "Name of the current Stage" }, "stageTime": { "type": "string", "format": "date-time", "description": "The time at which the stage happened." } }, "required": [ "serialNumber" ] }, "DataBoxOrderCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event.", "properties": { "serialNumber": { "type": "string", "description": "Serial Number of the device associated with the event. The list is comma separated if more than one serial number is associated." }, "stageName": { "$ref": "#/definitions/DataBoxStageName", "description": "Name of the current Stage" }, "stageTime": { "type": "string", "format": "date-time", "description": "The time at which the stage happened." } }, "required": [ "serialNumber" ] }, "DataBoxStageName": { "type": "string", "description": "Schema of DataBox Stage Name enumeration.", "enum": [ "CopyStarted", "CopyCompleted", "OrderCompleted" ], "x-ms-enum": { "name": "DataBoxStageName", "modelAsString": true, "values": [ { "name": "CopyStarted", "value": "CopyStarted", "description": "Copy has started" }, { "name": "CopyCompleted", "value": "CopyCompleted", "description": "Copy has completed" }, { "name": "OrderCompleted", "value": "OrderCompleted", "description": "Order has been completed" } ] } }, "DeviceConnectionStateEventInfo": { "type": "object", "description": "Information about the device connection state event.", "properties": { "sequenceNumber": { "type": "string", "description": "Sequence number is string representation of a hexadecimal number. string compare can be used to identify the larger number because both in ASCII and HEX numbers come after alphabets. If you are converting the string to hex, then the number is a 256 bit number." } }, "required": [ "sequenceNumber" ] }, "DeviceConnectionStateEventProperties": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).", "properties": { "deviceId": { "type": "string", "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." }, "moduleId": { "type": "string", "description": "The unique identifier of the module. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." }, "hubName": { "type": "string", "description": "Name of the IoT Hub where the device was created or deleted." }, "deviceConnectionStateEventInfo": { "$ref": "#/definitions/DeviceConnectionStateEventInfo", "description": "Information about the device connection state event." } }, "required": [ "deviceId", "hubName", "deviceConnectionStateEventInfo" ] }, "DeviceLifeCycleEventProperties": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).", "properties": { "deviceId": { "type": "string", "description": "The unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ # * ? ! ( ) , = `@` ; $ '." }, "hubName": { "type": "string", "description": "Name of the IoT Hub where the device was created or deleted." }, "twin": { "$ref": "#/definitions/DeviceTwinInfo", "description": "Information about the device twin, which is the cloud representation of application device metadata." } }, "required": [ "deviceId", "hubName", "twin" ] }, "DeviceTelemetryEventProperties": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).", "properties": { "body": { "type": "object", "description": "The content of the message from the device.", "additionalProperties": {} }, "properties": { "type": "object", "description": "Application properties are user-defined strings that can be added to the message. These fields are optional.", "additionalProperties": { "type": "string" }, "readOnly": true }, "systemProperties": { "type": "object", "description": "System properties help identify contents and source of the messages.", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "body", "properties", "systemProperties" ] }, "DeviceTwinInfo": { "type": "object", "description": "Information about the device twin, which is the cloud representation of application device metadata.", "properties": { "authenticationType": { "type": "string", "description": "Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority." }, "cloudToDeviceMessageCount": { "type": "number", "format": "float", "description": "Count of cloud to device messages sent to this device." }, "connectionState": { "type": "string", "description": "Whether the device is connected or disconnected." }, "deviceId": { "type": "string", "description": "The unique identifier of the device twin." }, "etag": { "type": "string", "description": "A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin." }, "lastActivityTime": { "type": "string", "description": "The ISO8601 timestamp of the last activity." }, "properties": { "$ref": "#/definitions/DeviceTwinInfoProperties", "description": "Properties JSON element." }, "status": { "type": "string", "description": "Whether the device twin is enabled or disabled." }, "statusUpdateTime": { "type": "string", "description": "The ISO8601 timestamp of the last device twin status update." }, "version": { "type": "number", "format": "float", "description": "An integer that is incremented by one each time the device twin is updated." }, "x509Thumbprint": { "$ref": "#/definitions/DeviceTwinInfoX509Thumbprint", "description": "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." } }, "required": [ "authenticationType", "connectionState", "deviceId", "etag", "lastActivityTime", "properties", "status", "statusUpdateTime", "x509Thumbprint" ] }, "DeviceTwinInfoProperties": { "type": "object", "description": "Properties JSON element.", "properties": { "desired": { "$ref": "#/definitions/DeviceTwinProperties", "description": "A portion of the properties that can be written only by the application back-end, and read by the device." }, "reported": { "$ref": "#/definitions/DeviceTwinProperties", "description": "A portion of the properties that can be written only by the device, and read by the application back-end." } }, "required": [ "desired", "reported" ] }, "DeviceTwinInfoX509Thumbprint": { "type": "object", "description": "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.", "properties": { "primaryThumbprint": { "type": "string", "description": "Primary thumbprint for the x509 certificate." }, "secondaryThumbprint": { "type": "string", "description": "Secondary thumbprint for the x509 certificate." } }, "required": [ "primaryThumbprint", "secondaryThumbprint" ] }, "DeviceTwinMetadata": { "type": "object", "description": "Metadata information for the properties JSON document.", "properties": { "lastUpdated": { "type": "string", "description": "The ISO8601 timestamp of the last time the properties were updated.", "x-ms-client-name": "$lastUpdated" } }, "required": [ "lastUpdated" ] }, "DeviceTwinProperties": { "type": "object", "description": "A portion of the properties that can be written only by the application back-end, and read by the device.", "properties": { "metadata": { "$ref": "#/definitions/DeviceTwinMetadata", "description": "Metadata information for the properties JSON document.", "x-ms-client-name": "$metadata" }, "version": { "type": "number", "format": "float", "description": "Version of device twin properties.", "x-ms-client-name": "$version" } }, "required": [ "metadata" ] }, "EdgeSolutionVersionPublishedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Edge.SolutionVersionPublished event.", "properties": { "externalValidationId": { "type": "string", "description": "A GUID to uniquely track External Solution Validation" }, "targetId": { "type": "string", "description": "ARM ID of the Target resource" }, "solutionTemplateId": { "type": "string", "description": "ARM ID of the Solution Template resource" }, "solutionTemplateVersionId": { "type": "string", "description": "ARM ID of the Solution Template Version resource" }, "solutionVersionId": { "type": "string", "description": "ARM ID of the Solution Version resource" }, "apiVersion": { "type": "string", "description": "API Version supported for the resources" }, "callbackUrl": { "type": "string", "format": "uri", "description": "Direct URL to callback for updating validation status" } }, "required": [ "externalValidationId", "targetId", "solutionTemplateId", "solutionTemplateVersionId", "solutionVersionId", "apiVersion", "callbackUrl" ] }, "EventGridMQTTClientCreatedOrUpdatedEventData": { "type": "object", "description": "Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event.", "properties": { "state": { "$ref": "#/definitions/EventGridMQTTClientState", "description": "Configured state of the client. The value could be Enabled or Disabled" }, "createdOn": { "type": "string", "format": "date-time", "description": "Time the client resource is created based on the provider's UTC time." }, "updatedOn": { "type": "string", "format": "date-time", "description": "Time the client resource is last updated based on the provider's UTC time. If\n the client resource was never updated, this value is identical to the value of\n the 'createdOn' property." }, "attributes": { "type": "object", "description": "The key-value attributes that are assigned to the client resource.", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "attributes" ], "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" } ] }, "EventGridMQTTClientDeletedEventData": { "type": "object", "description": "Event data for Microsoft.EventGrid.MQTTClientDeleted event.", "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" } ] }, "EventGridMQTTClientDisconnectionReason": { "type": "string", "description": "EventGrid MQTT Client Disconnection Reason", "enum": [ "ClientAuthenticationError", "ClientAuthorizationError", "ClientError", "ClientInitiatedDisconnect", "ConnectionLost", "IpForbidden", "QuotaExceeded", "ServerError", "ServerInitiatedDisconnect", "SessionOverflow", "SessionTakenOver" ], "x-ms-enum": { "name": "EventGridMQTTClientDisconnectionReason", "modelAsString": true, "values": [ { "name": "ClientAuthenticationError", "value": "ClientAuthenticationError", "description": "The client got disconnected for any authentication reasons (for example, certificate expired, client got disabled, or client configuration changed)." }, { "name": "ClientAuthorizationError", "value": "ClientAuthorizationError", "description": "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)." }, { "name": "ClientError", "value": "ClientError", "description": "The client sent a bad request or used one of the unsupported features that resulted in a connection termination by the service." }, { "name": "ClientInitiatedDisconnect", "value": "ClientInitiatedDisconnect", "description": "The client initiated a graceful disconnect through a DISCONNECT packet for MQTT or a close frame for MQTT over WebSocket." }, { "name": "ConnectionLost", "value": "ConnectionLost", "description": "The client-server connection is lost. (EXCHANGE ONLINE PROTECTION)." }, { "name": "IpForbidden", "value": "IpForbidden", "description": "The client's IP address is blocked by IP filter or Private links configuration." }, { "name": "QuotaExceeded", "value": "QuotaExceeded", "description": "The client exceeded one or more of the throttling limits that resulted in a connection termination by the service." }, { "name": "ServerError", "value": "ServerError", "description": "The connection got terminated due to an unexpected server error." }, { "name": "ServerInitiatedDisconnect", "value": "ServerInitiatedDisconnect", "description": "The server initiates a graceful disconnect for any operational reason." }, { "name": "SessionOverflow", "value": "SessionOverflow", "description": "The client's queue for unacknowledged QoS1 messages reached its limit, which resulted in a connection termination by the server." }, { "name": "SessionTakenOver", "value": "SessionTakenOver", "description": "The client reconnected with the same authentication name, which resulted in the termination of the previous connection." } ] } }, "EventGridMQTTClientEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for MQTT Client state changes.", "properties": { "clientAuthenticationName": { "type": "string", "description": "Unique identifier for the MQTT client that the client presents to the service\nfor authentication. This case-sensitive string can be up to 128 characters\nlong, and supports UTF-8 characters." }, "clientName": { "type": "string", "description": "Name of the client resource in the Event Grid namespace." }, "namespaceName": { "type": "string", "description": "Name of the Event Grid namespace where the MQTT client was created or updated." } }, "required": [ "clientAuthenticationName", "namespaceName" ] }, "EventGridMQTTClientSessionConnectedEventData": { "type": "object", "description": "Event data for Microsoft.EventGrid.MQTTClientSessionConnected event.", "properties": { "clientSessionName": { "type": "string", "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." } }, "required": [ "clientSessionName" ], "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" } ] }, "EventGridMQTTClientSessionDisconnectedEventData": { "type": "object", "description": "Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event.", "properties": { "clientSessionName": { "type": "string", "description": "Unique identifier for the MQTT client's session. This case-sensitive string can\nbe up to 128 characters long, and supports UTF-8 characters." }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "A number that helps indicate order of MQTT client session connected or\ndisconnected events. Latest event will have a sequence number that is higher\nthan the previous event." }, "disconnectionReason": { "$ref": "#/definitions/EventGridMQTTClientDisconnectionReason", "description": "Reason for the disconnection of the MQTT client's session. The value could be\none of the values in the disconnection reasons table." } }, "required": [ "clientSessionName" ], "allOf": [ { "$ref": "#/definitions/EventGridMQTTClientEventData" } ] }, "EventGridMQTTClientState": { "type": "string", "description": "EventGrid MQTT Client State", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "EventGridMQTTClientState", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" } ] } }, "EventHubCaptureFileCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated event.", "properties": { "fileUrl": { "type": "string", "description": "The path to the capture file." }, "fileType": { "type": "string", "description": "The file type of the capture file." }, "partitionId": { "type": "string", "description": "The shard ID." }, "sizeInBytes": { "type": "integer", "format": "int32", "description": "The file size." }, "eventCount": { "type": "integer", "format": "int32", "description": "The number of events in the file." }, "firstSequenceNumber": { "type": "integer", "format": "int32", "description": "The smallest sequence number from the queue." }, "lastSequenceNumber": { "type": "integer", "format": "int32", "description": "The last sequence number from the queue." }, "firstEnqueueTime": { "type": "string", "format": "date-time", "description": "The first time from the queue." }, "lastEnqueueTime": { "type": "string", "format": "date-time", "description": "The last time from the queue." } }, "required": [ "fileUrl", "fileType", "partitionId" ] }, "HealthcareDicomImageCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.", "properties": { "partitionName": { "type": "string", "description": "Data partition name" }, "imageStudyInstanceUid": { "type": "string", "description": "Unique identifier for the Study" }, "imageSeriesInstanceUid": { "type": "string", "description": "Unique identifier for the Series" }, "imageSopInstanceUid": { "type": "string", "description": "Unique identifier for the DICOM Image" }, "serviceHostName": { "type": "string", "description": "Domain name of the DICOM account for this image." }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." } }, "required": [ "partitionName", "imageStudyInstanceUid", "imageSeriesInstanceUid", "imageSopInstanceUid", "serviceHostName" ] }, "HealthcareDicomImageDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.", "properties": { "partitionName": { "type": "string", "description": "Data partition name" }, "imageStudyInstanceUid": { "type": "string", "description": "Unique identifier for the Study" }, "imageSeriesInstanceUid": { "type": "string", "description": "Unique identifier for the Series" }, "imageSopInstanceUid": { "type": "string", "description": "Unique identifier for the DICOM Image" }, "serviceHostName": { "type": "string", "description": "Host name of the DICOM account for this image." }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation and deletion within the service." } }, "required": [ "partitionName", "imageStudyInstanceUid", "imageSeriesInstanceUid", "imageSopInstanceUid", "serviceHostName" ] }, "HealthcareDicomImageUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.", "properties": { "partitionName": { "type": "string", "description": "Data partition name" }, "imageStudyInstanceUid": { "type": "string", "description": "Unique identifier for the Study" }, "imageSeriesInstanceUid": { "type": "string", "description": "Unique identifier for the Series" }, "imageSopInstanceUid": { "type": "string", "description": "Unique identifier for the DICOM Image" }, "serviceHostName": { "type": "string", "description": "Domain name of the DICOM account for this image." }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation, updation and deletion within the service." } }, "required": [ "partitionName", "imageStudyInstanceUid", "imageSeriesInstanceUid", "imageSopInstanceUid", "serviceHostName" ] }, "HealthcareFhirResourceCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceCreated event.", "properties": { "resourceType": { "$ref": "#/definitions/HealthcareFhirResourceType", "description": "Type of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceType" }, "resourceFhirAccount": { "type": "string", "description": "Domain name of FHIR account for this resource.", "x-ms-client-name": "FhirServiceHostName" }, "resourceFhirId": { "type": "string", "description": "Id of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceId" }, "resourceVersionId": { "type": "integer", "format": "int64", "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } }, "required": [ "resourceFhirAccount", "resourceFhirId" ] }, "HealthcareFhirResourceDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceDeleted event.", "properties": { "resourceType": { "$ref": "#/definitions/HealthcareFhirResourceType", "description": "Type of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceType" }, "resourceFhirAccount": { "type": "string", "description": "Domain name of FHIR account for this resource.", "x-ms-client-name": "FhirServiceHostName" }, "resourceFhirId": { "type": "string", "description": "Id of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceId" }, "resourceVersionId": { "type": "integer", "format": "int64", "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } }, "required": [ "resourceFhirAccount", "resourceFhirId" ] }, "HealthcareFhirResourceType": { "type": "string", "description": "Schema of FHIR resource type enumeration.", "enum": [ "Account", "ActivityDefinition", "AdverseEvent", "AllergyIntolerance", "Appointment", "AppointmentResponse", "AuditEvent", "Basic", "Binary", "BiologicallyDerivedProduct", "BodySite", "BodyStructure", "Bundle", "CapabilityStatement", "CarePlan", "CareTeam", "CatalogEntry", "ChargeItem", "ChargeItemDefinition", "Claim", "ClaimResponse", "ClinicalImpression", "CodeSystem", "Communication", "CommunicationRequest", "CompartmentDefinition", "Composition", "ConceptMap", "Condition", "Consent", "Contract", "Coverage", "CoverageEligibilityRequest", "CoverageEligibilityResponse", "DataElement", "DetectedIssue", "Device", "DeviceComponent", "DeviceDefinition", "DeviceMetric", "DeviceRequest", "DeviceUseStatement", "DiagnosticReport", "DocumentManifest", "DocumentReference", "DomainResource", "EffectEvidenceSynthesis", "EligibilityRequest", "EligibilityResponse", "Encounter", "Endpoint", "EnrollmentRequest", "EnrollmentResponse", "EpisodeOfCare", "EventDefinition", "Evidence", "EvidenceVariable", "ExampleScenario", "ExpansionProfile", "ExplanationOfBenefit", "FamilyMemberHistory", "Flag", "Goal", "GraphDefinition", "Group", "GuidanceResponse", "HealthcareService", "ImagingManifest", "ImagingStudy", "Immunization", "ImmunizationEvaluation", "ImmunizationRecommendation", "ImplementationGuide", "InsurancePlan", "Invoice", "Library", "Linkage", "List", "Location", "Measure", "MeasureReport", "Media", "Medication", "MedicationAdministration", "MedicationDispense", "MedicationKnowledge", "MedicationRequest", "MedicationStatement", "MedicinalProduct", "MedicinalProductAuthorization", "MedicinalProductContraindication", "MedicinalProductIndication", "MedicinalProductIngredient", "MedicinalProductInteraction", "MedicinalProductManufactured", "MedicinalProductPackaged", "MedicinalProductPharmaceutical", "MedicinalProductUndesirableEffect", "MessageDefinition", "MessageHeader", "MolecularSequence", "NamingSystem", "NutritionOrder", "Observation", "ObservationDefinition", "OperationDefinition", "OperationOutcome", "Organization", "OrganizationAffiliation", "Parameters", "Patient", "PaymentNotice", "PaymentReconciliation", "Person", "PlanDefinition", "Practitioner", "PractitionerRole", "Procedure", "ProcedureRequest", "ProcessRequest", "ProcessResponse", "Provenance", "Questionnaire", "QuestionnaireResponse", "ReferralRequest", "RelatedPerson", "RequestGroup", "ResearchDefinition", "ResearchElementDefinition", "ResearchStudy", "ResearchSubject", "Resource", "RiskAssessment", "RiskEvidenceSynthesis", "Schedule", "SearchParameter", "Sequence", "ServiceDefinition", "ServiceRequest", "Slot", "Specimen", "SpecimenDefinition", "StructureDefinition", "StructureMap", "Subscription", "Substance", "SubstanceNucleicAcid", "SubstancePolymer", "SubstanceProtein", "SubstanceReferenceInformation", "SubstanceSourceMaterial", "SubstanceSpecification", "SupplyDelivery", "SupplyRequest", "Task", "TerminologyCapabilities", "TestReport", "TestScript", "ValueSet", "VerificationResult", "VisionPrescription" ], "x-ms-enum": { "name": "HealthcareFhirResourceType", "modelAsString": true, "values": [ { "name": "Account", "value": "Account", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ActivityDefinition", "value": "ActivityDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "AdverseEvent", "value": "AdverseEvent", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "AllergyIntolerance", "value": "AllergyIntolerance", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Appointment", "value": "Appointment", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "AppointmentResponse", "value": "AppointmentResponse", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "AuditEvent", "value": "AuditEvent", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Basic", "value": "Basic", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Binary", "value": "Binary", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "BiologicallyDerivedProduct", "value": "BiologicallyDerivedProduct", "description": "The FHIR resource type defined in R4." }, { "name": "BodySite", "value": "BodySite", "description": "The FHIR resource type defined in STU3." }, { "name": "BodyStructure", "value": "BodyStructure", "description": "The FHIR resource type defined in R4." }, { "name": "Bundle", "value": "Bundle", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CapabilityStatement", "value": "CapabilityStatement", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CarePlan", "value": "CarePlan", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CareTeam", "value": "CareTeam", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CatalogEntry", "value": "CatalogEntry", "description": "The FHIR resource type defined in R4." }, { "name": "ChargeItem", "value": "ChargeItem", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ChargeItemDefinition", "value": "ChargeItemDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "Claim", "value": "Claim", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ClaimResponse", "value": "ClaimResponse", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ClinicalImpression", "value": "ClinicalImpression", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CodeSystem", "value": "CodeSystem", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Communication", "value": "Communication", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CommunicationRequest", "value": "CommunicationRequest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CompartmentDefinition", "value": "CompartmentDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Composition", "value": "Composition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ConceptMap", "value": "ConceptMap", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Condition", "value": "Condition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Consent", "value": "Consent", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Contract", "value": "Contract", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Coverage", "value": "Coverage", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "CoverageEligibilityRequest", "value": "CoverageEligibilityRequest", "description": "The FHIR resource type defined in R4." }, { "name": "CoverageEligibilityResponse", "value": "CoverageEligibilityResponse", "description": "The FHIR resource type defined in R4." }, { "name": "DataElement", "value": "DataElement", "description": "The FHIR resource type defined in STU3." }, { "name": "DetectedIssue", "value": "DetectedIssue", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Device", "value": "Device", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DeviceComponent", "value": "DeviceComponent", "description": "The FHIR resource type defined in STU3." }, { "name": "DeviceDefinition", "value": "DeviceDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "DeviceMetric", "value": "DeviceMetric", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DeviceRequest", "value": "DeviceRequest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DeviceUseStatement", "value": "DeviceUseStatement", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DiagnosticReport", "value": "DiagnosticReport", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DocumentManifest", "value": "DocumentManifest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DocumentReference", "value": "DocumentReference", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "DomainResource", "value": "DomainResource", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "EffectEvidenceSynthesis", "value": "EffectEvidenceSynthesis", "description": "The FHIR resource type defined in R4." }, { "name": "EligibilityRequest", "value": "EligibilityRequest", "description": "The FHIR resource type defined in STU3." }, { "name": "EligibilityResponse", "value": "EligibilityResponse", "description": "The FHIR resource type defined in STU3." }, { "name": "Encounter", "value": "Encounter", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Endpoint", "value": "Endpoint", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "EnrollmentRequest", "value": "EnrollmentRequest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "EnrollmentResponse", "value": "EnrollmentResponse", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "EpisodeOfCare", "value": "EpisodeOfCare", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "EventDefinition", "value": "EventDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "Evidence", "value": "Evidence", "description": "The FHIR resource type defined in R4." }, { "name": "EvidenceVariable", "value": "EvidenceVariable", "description": "The FHIR resource type defined in R4." }, { "name": "ExampleScenario", "value": "ExampleScenario", "description": "The FHIR resource type defined in R4." }, { "name": "ExpansionProfile", "value": "ExpansionProfile", "description": "The FHIR resource type defined in STU3." }, { "name": "ExplanationOfBenefit", "value": "ExplanationOfBenefit", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "FamilyMemberHistory", "value": "FamilyMemberHistory", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Flag", "value": "Flag", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Goal", "value": "Goal", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "GraphDefinition", "value": "GraphDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Group", "value": "Group", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "GuidanceResponse", "value": "GuidanceResponse", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "HealthcareService", "value": "HealthcareService", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ImagingManifest", "value": "ImagingManifest", "description": "The FHIR resource type defined in STU3." }, { "name": "ImagingStudy", "value": "ImagingStudy", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Immunization", "value": "Immunization", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ImmunizationEvaluation", "value": "ImmunizationEvaluation", "description": "The FHIR resource type defined in R4." }, { "name": "ImmunizationRecommendation", "value": "ImmunizationRecommendation", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ImplementationGuide", "value": "ImplementationGuide", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "InsurancePlan", "value": "InsurancePlan", "description": "The FHIR resource type defined in R4." }, { "name": "Invoice", "value": "Invoice", "description": "The FHIR resource type defined in R4." }, { "name": "Library", "value": "Library", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Linkage", "value": "Linkage", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "List", "value": "List", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Location", "value": "Location", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Measure", "value": "Measure", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MeasureReport", "value": "MeasureReport", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Media", "value": "Media", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Medication", "value": "Medication", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MedicationAdministration", "value": "MedicationAdministration", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MedicationDispense", "value": "MedicationDispense", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MedicationKnowledge", "value": "MedicationKnowledge", "description": "The FHIR resource type defined in R4." }, { "name": "MedicationRequest", "value": "MedicationRequest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MedicationStatement", "value": "MedicationStatement", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MedicinalProduct", "value": "MedicinalProduct", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductAuthorization", "value": "MedicinalProductAuthorization", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductContraindication", "value": "MedicinalProductContraindication", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductIndication", "value": "MedicinalProductIndication", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductIngredient", "value": "MedicinalProductIngredient", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductInteraction", "value": "MedicinalProductInteraction", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductManufactured", "value": "MedicinalProductManufactured", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductPackaged", "value": "MedicinalProductPackaged", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductPharmaceutical", "value": "MedicinalProductPharmaceutical", "description": "The FHIR resource type defined in R4." }, { "name": "MedicinalProductUndesirableEffect", "value": "MedicinalProductUndesirableEffect", "description": "The FHIR resource type defined in R4." }, { "name": "MessageDefinition", "value": "MessageDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MessageHeader", "value": "MessageHeader", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "MolecularSequence", "value": "MolecularSequence", "description": "The FHIR resource type defined in R4." }, { "name": "NamingSystem", "value": "NamingSystem", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "NutritionOrder", "value": "NutritionOrder", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Observation", "value": "Observation", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ObservationDefinition", "value": "ObservationDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "OperationDefinition", "value": "OperationDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "OperationOutcome", "value": "OperationOutcome", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Organization", "value": "Organization", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "OrganizationAffiliation", "value": "OrganizationAffiliation", "description": "The FHIR resource type defined in R4." }, { "name": "Parameters", "value": "Parameters", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Patient", "value": "Patient", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "PaymentNotice", "value": "PaymentNotice", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "PaymentReconciliation", "value": "PaymentReconciliation", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Person", "value": "Person", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "PlanDefinition", "value": "PlanDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Practitioner", "value": "Practitioner", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "PractitionerRole", "value": "PractitionerRole", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Procedure", "value": "Procedure", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ProcedureRequest", "value": "ProcedureRequest", "description": "The FHIR resource type defined in STU3." }, { "name": "ProcessRequest", "value": "ProcessRequest", "description": "The FHIR resource type defined in STU3." }, { "name": "ProcessResponse", "value": "ProcessResponse", "description": "The FHIR resource type defined in STU3." }, { "name": "Provenance", "value": "Provenance", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Questionnaire", "value": "Questionnaire", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "QuestionnaireResponse", "value": "QuestionnaireResponse", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ReferralRequest", "value": "ReferralRequest", "description": "The FHIR resource type defined in STU3." }, { "name": "RelatedPerson", "value": "RelatedPerson", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "RequestGroup", "value": "RequestGroup", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ResearchDefinition", "value": "ResearchDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "ResearchElementDefinition", "value": "ResearchElementDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "ResearchStudy", "value": "ResearchStudy", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ResearchSubject", "value": "ResearchSubject", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Resource", "value": "Resource", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "RiskAssessment", "value": "RiskAssessment", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "RiskEvidenceSynthesis", "value": "RiskEvidenceSynthesis", "description": "The FHIR resource type defined in R4." }, { "name": "Schedule", "value": "Schedule", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "SearchParameter", "value": "SearchParameter", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Sequence", "value": "Sequence", "description": "The FHIR resource type defined in STU3." }, { "name": "ServiceDefinition", "value": "ServiceDefinition", "description": "The FHIR resource type defined in STU3." }, { "name": "ServiceRequest", "value": "ServiceRequest", "description": "The FHIR resource type defined in R4." }, { "name": "Slot", "value": "Slot", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Specimen", "value": "Specimen", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "SpecimenDefinition", "value": "SpecimenDefinition", "description": "The FHIR resource type defined in R4." }, { "name": "StructureDefinition", "value": "StructureDefinition", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "StructureMap", "value": "StructureMap", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Subscription", "value": "Subscription", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Substance", "value": "Substance", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "SubstanceNucleicAcid", "value": "SubstanceNucleicAcid", "description": "The FHIR resource type defined in R4." }, { "name": "SubstancePolymer", "value": "SubstancePolymer", "description": "The FHIR resource type defined in R4." }, { "name": "SubstanceProtein", "value": "SubstanceProtein", "description": "The FHIR resource type defined in R4." }, { "name": "SubstanceReferenceInformation", "value": "SubstanceReferenceInformation", "description": "The FHIR resource type defined in R4." }, { "name": "SubstanceSourceMaterial", "value": "SubstanceSourceMaterial", "description": "The FHIR resource type defined in R4." }, { "name": "SubstanceSpecification", "value": "SubstanceSpecification", "description": "The FHIR resource type defined in R4." }, { "name": "SupplyDelivery", "value": "SupplyDelivery", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "SupplyRequest", "value": "SupplyRequest", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "Task", "value": "Task", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "TerminologyCapabilities", "value": "TerminologyCapabilities", "description": "The FHIR resource type defined in R4." }, { "name": "TestReport", "value": "TestReport", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "TestScript", "value": "TestScript", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "ValueSet", "value": "ValueSet", "description": "The FHIR resource type defined in STU3 and R4." }, { "name": "VerificationResult", "value": "VerificationResult", "description": "The FHIR resource type defined in R4." }, { "name": "VisionPrescription", "value": "VisionPrescription", "description": "The FHIR resource type defined in STU3 and R4." } ] } }, "HealthcareFhirResourceUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.FhirResourceUpdated event.", "properties": { "resourceType": { "$ref": "#/definitions/HealthcareFhirResourceType", "description": "Type of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceType" }, "resourceFhirAccount": { "type": "string", "description": "Domain name of FHIR account for this resource.", "x-ms-client-name": "FhirServiceHostName" }, "resourceFhirId": { "type": "string", "description": "Id of HL7 FHIR resource.", "x-ms-client-name": "FhirResourceId" }, "resourceVersionId": { "type": "integer", "format": "int64", "description": "VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or deleted(soft-deletion).", "x-ms-client-name": "FhirResourceVersionId" } }, "required": [ "resourceFhirAccount", "resourceFhirId" ] }, "IotHubDeviceConnectedEventData": { "type": "object", "description": "Event data for Microsoft.Devices.DeviceConnected event.", "allOf": [ { "$ref": "#/definitions/DeviceConnectionStateEventProperties" } ] }, "IotHubDeviceCreatedEventData": { "type": "object", "description": "Event data for Microsoft.Devices.DeviceCreated event.", "allOf": [ { "$ref": "#/definitions/DeviceLifeCycleEventProperties" } ] }, "IotHubDeviceDeletedEventData": { "type": "object", "description": "Event data for Microsoft.Devices.DeviceDeleted event.", "allOf": [ { "$ref": "#/definitions/DeviceLifeCycleEventProperties" } ] }, "IotHubDeviceDisconnectedEventData": { "type": "object", "description": "Event data for Microsoft.Devices.DeviceDisconnected event.", "allOf": [ { "$ref": "#/definitions/DeviceConnectionStateEventProperties" } ] }, "IotHubDeviceTelemetryEventData": { "type": "object", "description": "Event data for Microsoft.Devices.DeviceTelemetry event.", "allOf": [ { "$ref": "#/definitions/DeviceTelemetryEventProperties" } ] }, "KeyVaultAccessPolicyChangedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.VaultAccessPolicyChanged event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultCertificateExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultCertificateNearExpiryEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultCertificateNewVersionCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNewVersionCreated event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultKeyExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultKeyNearExpiryEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultKeyNewVersionCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultSecretExpiredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultSecretNearExpiryEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "KeyVaultSecretNewVersionCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNewVersionCreated event.", "properties": { "Id": { "type": "string", "description": "The id of the object that triggered this event." }, "VaultName": { "type": "string", "description": "Key vault name of the object that triggered this event." }, "ObjectType": { "type": "string", "description": "The type of the object that triggered this event" }, "ObjectName": { "type": "string", "description": "The name of the object that triggered this event" }, "Version": { "type": "string", "description": "The version of the object that triggered this event" }, "NBF": { "type": "number", "format": "float", "description": "Not before date of the object that triggered this event", "x-ms-client-name": "Nbf" }, "EXP": { "type": "number", "format": "float", "description": "The expiration date of the object that triggered this event", "x-ms-client-name": "Exp" } }, "required": [ "Id", "VaultName", "ObjectType", "ObjectName", "Version" ] }, "LifecycleHookAction": { "type": "string", "description": "The action that will be applied to a target resource in the Virtual Machine Scale Set Lifecycle Hook event if the platform does not receive a response from the customer for the target resource before waitUntil.", "enum": [ "Approve", "Reject" ], "x-ms-enum": { "name": "LifecycleHookAction", "modelAsString": true, "values": [ { "name": "Approve", "value": "Approve", "description": "The Lifecycle Hook of a target resource in a Lifecycle Hook event will be approved." }, { "name": "Reject", "value": "Reject", "description": "The Lifecycle Hook of a target resource in a Lifecycle Hook event will be rejected." } ] } }, "LifecycleHookActionState": { "type": "string", "description": "Approval status of a target resource in a Virtual Machine Scale Set Lifecycle Hook event.", "enum": [ "Waiting", "Approved", "Rejected" ], "x-ms-enum": { "name": "LifecycleHookActionState", "modelAsString": true, "values": [ { "name": "Waiting", "value": "Waiting", "description": "The Lifecycle Hook for the target resource is waiting for approval." }, { "name": "Approved", "value": "Approved", "description": "The Lifecycle Hook for the target resource is approved." }, { "name": "Rejected", "value": "Rejected", "description": "The Lifecycle Hook for the target resource is rejected." } ] } }, "LifecycleHookEventsEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Compute.VirtualMachineScaleSets.LifecycleHookEvents preview event.", "properties": { "name": { "type": "string", "description": "The name of the Lifecycle Hook event. This is a unique identifier for the Lifecycle Hook event." }, "id": { "type": "string", "description": "The ARM resource ID of the Lifecycle Hook event entity created by the platform for this event. Customers can use this ARM resource ID to query more details about the event through Azure Resource Manager APIs." }, "properties": { "$ref": "#/definitions/VirtualMachineScaleSetLifecycleHookEventProperties", "description": "The properties of the Virtual Machine Scale Set Lifecycle Hook event." }, "operationalInfo": { "$ref": "#/definitions/OperationalInfo", "description": "Operational information related to the Lifecycle Hook event." } }, "required": [ "name", "id", "properties", "operationalInfo" ] }, "MachineLearningServicesDatasetDriftDetectedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.DatasetDriftDetected event.", "properties": { "dataDriftId": { "type": "string", "description": "The ID of the data drift monitor that triggered the event." }, "dataDriftName": { "type": "string", "description": "The name of the data drift monitor that triggered the event." }, "runId": { "type": "string", "description": "The ID of the Run that detected data drift." }, "baseDatasetId": { "type": "string", "description": "The ID of the base Dataset used to detect drift." }, "targetDatasetId": { "type": "string", "description": "The ID of the target Dataset used to detect drift." }, "driftCoefficient": { "type": "number", "format": "double", "description": "The coefficient result that triggered the event." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the target dataset time series that resulted in drift detection.", "x-nullable": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the target dataset time series that resulted in drift detection.", "x-nullable": true } }, "required": [ "dataDriftId", "dataDriftName", "runId", "baseDatasetId", "targetDatasetId" ] }, "MachineLearningServicesModelDeployedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelDeployed event.", "properties": { "serviceName": { "type": "string", "description": "The name of the deployed service." }, "serviceComputeType": { "type": "string", "description": "The compute type (e.g. ACI, AKS) of the deployed service." }, "modelIds": { "type": "string", "description": "A common separated list of model IDs. The IDs of the models deployed in the service." }, "serviceTags": { "type": "object", "description": "The tags of the deployed service.", "additionalProperties": {} }, "serviceProperties": { "type": "object", "description": "The properties of the deployed service.", "additionalProperties": {} } }, "required": [ "serviceName", "serviceComputeType", "modelIds" ] }, "MachineLearningServicesModelRegisteredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.ModelRegistered event.", "properties": { "modelName": { "type": "string", "description": "The name of the model that was registered." }, "modelVersion": { "type": "string", "description": "The version of the model that was registered." }, "modelTags": { "type": "object", "description": "The tags of the model that was registered.", "additionalProperties": {} }, "modelProperties": { "type": "object", "description": "The properties of the model that was registered.", "additionalProperties": {} } }, "required": [ "modelName", "modelVersion" ] }, "MachineLearningServicesRunCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunCompleted event.", "properties": { "experimentId": { "type": "string", "description": "The ID of the experiment that the run belongs to." }, "experimentName": { "type": "string", "description": "The name of the experiment that the run belongs to." }, "runId": { "type": "string", "description": "The ID of the Run that was completed." }, "runType": { "type": "string", "description": "The Run Type of the completed Run." }, "runTags": { "type": "object", "description": "The tags of the completed Run.", "additionalProperties": {} }, "runProperties": { "type": "object", "description": "The properties of the completed Run.", "additionalProperties": {} } }, "required": [ "experimentId", "experimentName", "runId", "runType" ] }, "MachineLearningServicesRunStatusChangedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.MachineLearningServices.RunStatusChanged event.", "properties": { "experimentId": { "type": "string", "description": "The ID of the experiment that the Machine Learning Run belongs to." }, "experimentName": { "type": "string", "description": "The name of the experiment that the Machine Learning Run belongs to." }, "runId": { "type": "string", "description": "The ID of the Machine Learning Run." }, "runType": { "type": "string", "description": "The Run Type of the Machine Learning Run." }, "runTags": { "type": "object", "description": "The tags of the Machine Learning Run.", "additionalProperties": {} }, "runProperties": { "type": "object", "description": "The properties of the Machine Learning Run.", "additionalProperties": {} }, "runStatus": { "type": "string", "description": "The status of the Machine Learning Run." } }, "required": [ "experimentId", "experimentName", "runId", "runType", "runStatus" ] }, "MapsGeofenceEnteredEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.", "allOf": [ { "$ref": "#/definitions/MapsGeofenceEventProperties" } ] }, "MapsGeofenceEventProperties": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", "properties": { "expiredGeofenceGeometryId": { "type": "array", "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", "items": { "type": "string" }, "readOnly": true }, "geometries": { "type": "array", "description": "Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.", "items": { "$ref": "#/definitions/MapsGeofenceGeometry" }, "readOnly": true }, "invalidPeriodGeofenceGeometryId": { "type": "array", "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", "items": { "type": "string" }, "readOnly": true }, "isEventPublished": { "type": "boolean", "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber." } }, "required": [ "expiredGeofenceGeometryId", "geometries", "invalidPeriodGeofenceGeometryId" ] }, "MapsGeofenceExitedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.", "allOf": [ { "$ref": "#/definitions/MapsGeofenceEventProperties" } ] }, "MapsGeofenceGeometry": { "type": "object", "description": "The geofence geometry.", "properties": { "deviceId": { "type": "string", "description": "ID of the device." }, "distance": { "type": "number", "format": "float", "description": "Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence." }, "geometryId": { "type": "string", "description": "The unique ID for the geofence geometry." }, "nearestLat": { "type": "number", "format": "float", "description": "Latitude of the nearest point of the geometry." }, "nearestLon": { "type": "number", "format": "float", "description": "Longitude of the nearest point of the geometry." }, "udId": { "type": "string", "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." } }, "required": [ "deviceId", "geometryId" ] }, "MapsGeofenceResultEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.", "allOf": [ { "$ref": "#/definitions/MapsGeofenceEventProperties" } ] }, "MicrosoftTeamsAppIdentifierModel": { "type": "object", "description": "A Microsoft Teams application.", "properties": { "appId": { "type": "string", "description": "The Id of the Microsoft Teams application" }, "cloud": { "$ref": "#/definitions/CommunicationCloudEnvironmentModel", "description": "The cloud that the Microsoft Teams application belongs to. By default 'public' if missing." } }, "required": [ "appId" ] }, "MicrosoftTeamsUserIdentifierModel": { "type": "object", "description": "A Microsoft Teams user.", "properties": { "userId": { "type": "string", "description": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user." }, "isAnonymous": { "type": "boolean", "description": "True if the Microsoft Teams user is anonymous. By default false if missing." }, "cloud": { "$ref": "#/definitions/CommunicationCloudEnvironmentModel", "description": "The cloud that the Microsoft Teams user belongs to. By default 'public' if missing." } }, "required": [ "userId" ] }, "OperationalInfo": { "type": "object", "description": "Operational information for a Virtual Machine Scale Set Lifecycle Hook event.", "properties": { "activityId": { "type": "string", "description": "The activity ID associated with the operation generating the Lifecycle Hook event." } }, "required": [ "activityId" ] }, "PhoneNumberIdentifierModel": { "type": "object", "description": "A phone number.", "properties": { "value": { "type": "string", "description": "The phone number in E.164 format." } }, "required": [ "value" ] }, "PolicyInsightsPolicyStateChangedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateChanged event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." }, "policyAssignmentId": { "type": "string", "description": "The resource ID of the policy assignment." }, "policyDefinitionId": { "type": "string", "description": "The resource ID of the policy definition." }, "policyDefinitionReferenceId": { "type": "string", "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." }, "complianceState": { "type": "string", "description": "The compliance state of the resource with respect to the policy assignment." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "complianceReasonCode": { "type": "string", "description": "The compliance reason code. May be empty." } }, "required": [ "policyAssignmentId", "policyDefinitionId", "policyDefinitionReferenceId", "complianceState", "subscriptionId", "complianceReasonCode" ] }, "PolicyInsightsPolicyStateCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateCreated event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." }, "policyAssignmentId": { "type": "string", "description": "The resource ID of the policy assignment." }, "policyDefinitionId": { "type": "string", "description": "The resource ID of the policy definition." }, "policyDefinitionReferenceId": { "type": "string", "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." }, "complianceState": { "type": "string", "description": "The compliance state of the resource with respect to the policy assignment." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "complianceReasonCode": { "type": "string", "description": "The compliance reason code. May be empty." } }, "required": [ "policyAssignmentId", "policyDefinitionId", "policyDefinitionReferenceId", "complianceState", "subscriptionId", "complianceReasonCode" ] }, "PolicyInsightsPolicyStateDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.PolicyInsights.PolicyStateDeleted event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ." }, "policyAssignmentId": { "type": "string", "description": "The resource ID of the policy assignment." }, "policyDefinitionId": { "type": "string", "description": "The resource ID of the policy definition." }, "policyDefinitionReferenceId": { "type": "string", "description": "The reference ID for the policy definition inside the initiative definition, if the policy assignment is for an initiative. May be empty." }, "complianceState": { "type": "string", "description": "The compliance state of the resource with respect to the policy assignment." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "complianceReasonCode": { "type": "string", "description": "The compliance reason code. May be empty." } }, "required": [ "policyAssignmentId", "policyDefinitionId", "policyDefinitionReferenceId", "complianceState", "subscriptionId", "complianceReasonCode" ] }, "RedisExportRDBCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "name": { "type": "string", "description": "The name of this event." }, "status": { "type": "string", "description": "The status of this event. Failed or succeeded" } } }, "RedisImportRDBCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "name": { "type": "string", "description": "The name of this event." }, "status": { "type": "string", "description": "The status of this event. Failed or succeeded" } } }, "RedisPatchingCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "name": { "type": "string", "description": "The name of this event." }, "status": { "type": "string", "description": "The status of this event. Failed or succeeded" } } }, "RedisScalingCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "name": { "type": "string", "description": "The name of this event." }, "status": { "type": "string", "description": "The status of this event. Failed or succeeded" } } }, "ResourceActionCancelEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceActionFailureEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceActionSuccessEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceAuthorization": { "type": "object", "description": "The details of the authorization for the resource.", "properties": { "scope": { "type": "string", "description": "The scope of the authorization." }, "action": { "type": "string", "description": "The action being requested." }, "evidence": { "type": "object", "description": "The evidence for the authorization.", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "evidence" ] }, "ResourceDeleteCancelEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceDeleteFailureEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceDeleteSuccessEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceHttpRequest": { "type": "object", "description": "The details of the HTTP request.", "properties": { "clientRequestId": { "type": "string", "description": "The client request ID." }, "clientIpAddress": { "type": "string", "description": "The client IP address." }, "method": { "type": "string", "description": "The request method." }, "url": { "type": "string", "description": "The url used in the request." } } }, "ResourceNotificationsContainerServiceEventResourcesScheduledEventData": { "type": "object", "description": "Schema of the Data property of an event grid event for a Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted preview event.Schema of the Data property of an event grid event for a Microsoft.ResourceNotifications.ContainerServiceEventResources.ScheduledEventEmitted preview event.", "allOf": [ { "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" } ] }, "ResourceNotificationsHealthResourcesAnnotatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.ResourceAnnotated event.", "allOf": [ { "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" } ] }, "ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged\nevent.", "allOf": [ { "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" } ] }, "ResourceNotificationsOperationalDetails": { "type": "object", "description": "details of operational info", "properties": { "resourceEventTime": { "type": "string", "format": "date-time", "description": "Date and Time when resource was updated" } } }, "ResourceNotificationsResourceDeletedDetails": { "type": "object", "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic delete events", "properties": { "id": { "type": "string", "description": "id of the resource for which the event is being emitted" }, "name": { "type": "string", "description": "name of the resource for which the event is being emitted" }, "type": { "type": "string", "description": "the type of the resource for which the event is being emitted" } }, "required": [ "id", "name", "type" ] }, "ResourceNotificationsResourceDeletedEventData": { "type": "object", "description": "Describes the schema of the common properties across all ARN system topic\ndelete events", "properties": { "resourceInfo": { "$ref": "#/definitions/ResourceNotificationsResourceDeletedDetails", "description": "resourceInfo details for delete event", "x-ms-client-name": "resourceDetails" }, "operationalInfo": { "$ref": "#/definitions/ResourceNotificationsOperationalDetails", "description": "details about operational info", "x-ms-client-name": "operationalDetails" } }, "required": [ "resourceInfo", "operationalInfo" ] }, "ResourceNotificationsResourceManagementCreatedOrUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.CreatedOrUpdated event.", "allOf": [ { "$ref": "#/definitions/ResourceNotificationsResourceUpdatedEventData" } ] }, "ResourceNotificationsResourceManagementDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.ResourceNotifications.Resources.Deleted event.", "allOf": [ { "$ref": "#/definitions/ResourceNotificationsResourceDeletedEventData" } ] }, "ResourceNotificationsResourceUpdatedDetails": { "type": "object", "description": "Describes the schema of the properties under resource info which are common\nacross all ARN system topic events", "properties": { "id": { "type": "string", "description": "id of the resource for which the event is being emitted" }, "name": { "type": "string", "description": "name of the resource for which the event is being emitted" }, "type": { "type": "string", "description": "the type of the resource for which the event is being emitted" }, "location": { "type": "string", "description": "the location of the resource for which the event is being emitted" }, "tags": { "type": "object", "description": "the tags on the resource for which the event is being emitted", "additionalProperties": { "type": "string" }, "readOnly": true }, "properties": { "type": "object", "description": "properties in the payload of the resource for which the event is being emitted", "additionalProperties": {}, "readOnly": true } }, "required": [ "id", "name", "type" ] }, "ResourceNotificationsResourceUpdatedEventData": { "type": "object", "description": "Describes the schema of the common properties across all ARN system topic events", "properties": { "resourceInfo": { "$ref": "#/definitions/ResourceNotificationsResourceUpdatedDetails", "description": "resourceInfo details for update event", "x-ms-client-name": "resourceDetails" }, "operationalInfo": { "$ref": "#/definitions/ResourceNotificationsOperationalDetails", "description": "details about operational info", "x-ms-client-name": "operationalDetails" }, "apiVersion": { "type": "string", "description": "api version of the resource properties bag" } }, "required": [ "resourceInfo", "operationalInfo", "apiVersion" ] }, "ResourceWriteCancelEventData": { "type": "object", "description": "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.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceWriteFailureEventData": { "type": "object", "description": "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.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ResourceWriteSuccessEventData": { "type": "object", "description": "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.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the resource." }, "subscriptionId": { "type": "string", "description": "The subscription ID of the resource." }, "resourceGroup": { "type": "string", "description": "The resource group of the resource." }, "resourceProvider": { "type": "string", "description": "The resource provider performing the operation." }, "resourceUri": { "type": "string", "description": "The URI of the resource in the operation.", "x-ms-client-name": "resourceUrl" }, "operationName": { "type": "string", "description": "The operation that was performed." }, "status": { "type": "string", "description": "The status of the operation." }, "authorization": { "$ref": "#/definitions/ResourceAuthorization", "description": "The requested authorization for the operation." }, "claims": { "type": "object", "description": "The properties of the claims.", "additionalProperties": { "type": "string" }, "readOnly": true }, "correlationId": { "type": "string", "description": "An operation ID used for troubleshooting." }, "httpRequest": { "$ref": "#/definitions/ResourceHttpRequest", "description": "The details of the operation." } }, "required": [ "authorization", "claims", "httpRequest" ] }, "ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event.", "properties": { "namespaceName": { "type": "string", "description": "The namespace name of the Microsoft.ServiceBus resource." }, "requestUri": { "type": "string", "description": "The endpoint of the Microsoft.ServiceBus resource." }, "entityType": { "type": "string", "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." }, "queueName": { "type": "string", "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", "x-nullable": true }, "topicName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true }, "subscriptionName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true } }, "required": [ "namespaceName", "requestUri", "entityType", "queueName", "topicName", "subscriptionName" ] }, "ServiceBusActiveMessagesAvailableWithNoListenersEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.", "properties": { "namespaceName": { "type": "string", "description": "The namespace name of the Microsoft.ServiceBus resource." }, "requestUri": { "type": "string", "description": "The endpoint of the Microsoft.ServiceBus resource." }, "entityType": { "type": "string", "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." }, "queueName": { "type": "string", "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", "x-nullable": true }, "topicName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true }, "subscriptionName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true } }, "required": [ "namespaceName", "requestUri", "entityType", "queueName", "topicName", "subscriptionName" ] }, "ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event.", "properties": { "namespaceName": { "type": "string", "description": "The namespace name of the Microsoft.ServiceBus resource." }, "requestUri": { "type": "string", "description": "The endpoint of the Microsoft.ServiceBus resource." }, "entityType": { "type": "string", "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." }, "queueName": { "type": "string", "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", "x-nullable": true }, "topicName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true }, "subscriptionName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true } }, "required": [ "namespaceName", "requestUri", "entityType", "queueName", "topicName", "subscriptionName" ] }, "ServiceBusDeadletterMessagesAvailableWithNoListenersEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event.", "properties": { "namespaceName": { "type": "string", "description": "The namespace name of the Microsoft.ServiceBus resource." }, "requestUri": { "type": "string", "description": "The endpoint of the Microsoft.ServiceBus resource." }, "entityType": { "type": "string", "description": "The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'." }, "queueName": { "type": "string", "description": "The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then this value will be null.", "x-nullable": true }, "topicName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true }, "subscriptionName": { "type": "string", "description": "The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type 'queue', then this value will be null.", "x-nullable": true } }, "required": [ "namespaceName", "requestUri", "entityType", "queueName", "topicName", "subscriptionName" ] }, "SignalRServiceClientConnectionConnectedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "hubName": { "type": "string", "description": "The hub of connected client connection." }, "connectionId": { "type": "string", "description": "The connection Id of connected client connection." }, "userId": { "type": "string", "description": "The user Id of connected client connection." } }, "required": [ "hubName", "connectionId" ] }, "SignalRServiceClientConnectionDisconnectedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The time at which the event occurred." }, "hubName": { "type": "string", "description": "The hub of connected client connection." }, "connectionId": { "type": "string", "description": "The connection Id of connected client connection." }, "userId": { "type": "string", "description": "The user Id of connected client connection." }, "errorMessage": { "type": "string", "description": "The message of error that cause the client connection disconnected." } }, "required": [ "hubName", "connectionId" ] }, "StampKind": { "type": "string", "description": "Kind of environment where app service plan is.", "enum": [ "Public", "AseV1", "AseV2" ], "x-ms-enum": { "name": "StampKind", "modelAsString": true, "values": [ { "name": "Public", "value": "Public", "description": "App Service Plan is running on a public stamp." }, { "name": "AseV1", "value": "AseV1", "description": "App Service Plan is running on an App Service Environment V1." }, { "name": "AseV2", "value": "AseV2", "description": "App Service Plan is running on an App Service Environment V2." } ] } }, "StorageAsyncOperationInitiatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.AsyncOperationInitiated event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "contentType": { "type": "string", "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." }, "contentLength": { "type": "integer", "format": "int64", "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." }, "blobType": { "type": "string", "description": "The type of blob." }, "url": { "type": "string", "description": "The path to the blob." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageBlobAccessTier": { "type": "string", "description": "The access tier of the blob.", "enum": [ "Hot", "Cool", "Cold", "Archive", "Default" ], "x-ms-enum": { "name": "StorageBlobAccessTier", "modelAsString": true, "values": [ { "name": "Hot", "value": "Hot", "description": "The blob is in access tier Hot" }, { "name": "Cool", "value": "Cool", "description": "The blob is in access tier Cool" }, { "name": "Cold", "value": "Cold", "description": "The blob is in access tier Cold" }, { "name": "Archive", "value": "Archive", "description": "The blob is in access tier Archive" }, { "name": "Default", "value": "Default", "description": "The blob is in access tier Default(Inferred)" } ] } }, "StorageBlobCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "eTag": { "type": "string", "description": "The etag of the blob at the time this event was triggered." }, "contentType": { "type": "string", "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." }, "contentLength": { "type": "integer", "format": "int64", "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." }, "contentOffset": { "type": "integer", "format": "int64", "description": "The offset of the blob in bytes." }, "blobType": { "type": "string", "description": "The type of blob." }, "accessTier": { "$ref": "#/definitions/StorageBlobAccessTier", "description": "The current tier of the blob." }, "url": { "type": "string", "description": "The path to the blob." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "accessTier", "storageDiagnostics" ] }, "StorageBlobDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "contentType": { "type": "string", "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." }, "blobType": { "type": "string", "description": "The type of blob." }, "url": { "type": "string", "description": "The path to the blob." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageBlobInventoryPolicyCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobInventoryPolicyCompleted event.", "properties": { "scheduleDateTime": { "type": "string", "format": "date-time", "description": "The time at which inventory policy was scheduled." }, "accountName": { "type": "string", "description": "The account name for which inventory policy is registered." }, "ruleName": { "type": "string", "description": "The rule name for inventory policy." }, "policyRunStatus": { "type": "string", "description": "The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed." }, "policyRunStatusMessage": { "type": "string", "description": "The status message for inventory run." }, "policyRunId": { "type": "string", "description": "The policy run id for inventory run." }, "manifestBlobUrl": { "type": "string", "description": "The blob URL for manifest file for inventory run." } } }, "StorageBlobRenamedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "sourceUrl": { "type": "string", "description": "The path to the blob that was renamed." }, "destinationUrl": { "type": "string", "description": "The new path to the blob after the rename operation." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageBlobTierChangedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "contentType": { "type": "string", "description": "The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob." }, "contentLength": { "type": "integer", "format": "int64", "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob." }, "blobType": { "type": "string", "description": "The type of blob." }, "accessTier": { "$ref": "#/definitions/StorageBlobAccessTier", "description": "The current tier of the blob." }, "previousTier": { "$ref": "#/definitions/StorageBlobAccessTier", "description": "The previous tier of the blob." }, "url": { "type": "string", "description": "The path to the blob." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular blob name. Users can use standard string comparison to understand the relative sequence of two events on the same blob name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "accessTier", "previousTier", "storageDiagnostics" ] }, "StorageDirectoryCreatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "eTag": { "type": "string", "description": "The etag of the directory at the time this event was triggered." }, "url": { "type": "string", "description": "The path to the directory." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageDirectoryDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "url": { "type": "string", "description": "The path to the deleted directory." }, "recursive": { "type": "string", "description": "Is this event for a recursive delete operation." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageDirectoryRenamedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed event.", "properties": { "api": { "type": "string", "description": "The name of the API/operation that triggered this event." }, "clientRequestId": { "type": "string", "description": "A request id provided by the client of the storage API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the storage service for the storage API operation that triggered this event." }, "sourceUrl": { "type": "string", "description": "The path to the directory that was renamed." }, "destinationUrl": { "type": "string", "description": "The new path to the directory after the rename operation." }, "sequencer": { "type": "string", "description": "An opaque string value representing the logical sequence of events for any particular directory name. Users can use standard string comparison to understand the relative sequence of two events on the same directory name." }, "identity": { "type": "string", "description": "The identity of the requester that triggered this event." }, "storageDiagnostics": { "type": "object", "description": "For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.", "additionalProperties": {} } }, "required": [ "storageDiagnostics" ] }, "StorageLifecycleCompletionStatus": { "type": "string", "description": "The status for a LCM policy.", "enum": [ "Completed", "CompletedWithError", "Incomplete" ], "x-ms-enum": { "name": "StorageLifecycleCompletionStatus", "modelAsString": true, "values": [ { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "CompletedWithError", "value": "CompletedWithError", "description": "CompletedWithError" }, { "name": "Incomplete", "value": "Incomplete", "description": "Incomplete" } ] } }, "StorageLifecyclePolicyActionSummaryDetail": { "type": "object", "description": "Execution statistics of a specific policy action in a Blob Management cycle.", "properties": { "totalObjectsCount": { "type": "integer", "format": "int64", "description": "Total number of objects to be acted on by this action." }, "successCount": { "type": "integer", "format": "int64", "description": "Number of success operations of this action." }, "errorList": { "type": "string", "description": "Error messages of this action if any." } } }, "StorageLifecyclePolicyCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Storage.LifecyclePolicyCompleted event.", "properties": { "scheduleTime": { "type": "string", "description": "The time the policy task was scheduled." }, "policyRunSummary": { "$ref": "#/definitions/StorageLifecyclePolicyRunSummary", "description": "Policy execution summary which shows the completion status of a LCM run\"" }, "deleteSummary": { "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", "description": "Execution statistics of a specific policy action in a Blob Management cycle." }, "tierToCoolSummary": { "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", "description": "Execution statistics of a specific policy action in a Blob Management cycle." }, "tierToArchiveSummary": { "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", "description": "Execution statistics of a specific policy action in a Blob Management cycle." }, "tierToColdSummary": { "$ref": "#/definitions/StorageLifecyclePolicyActionSummaryDetail", "description": "Execution statistics of a specific policy action in a Blob Management cycle." } }, "required": [ "policyRunSummary", "deleteSummary", "tierToCoolSummary", "tierToArchiveSummary", "tierToColdSummary" ] }, "StorageLifecyclePolicyRunSummary": { "type": "object", "description": "Policy run status of an account in a Blob Management cycle.", "properties": { "completionStatus": { "$ref": "#/definitions/StorageLifecycleCompletionStatus", "description": "Policy status can be Completed/CompletedWithError/Incomplete." } }, "required": [ "completionStatus" ] }, "StorageTaskAssignmentCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentCompleted event.", "properties": { "status": { "$ref": "#/definitions/StorageTaskAssignmentCompletedStatus", "description": "The status for a storage task." }, "completedDateTime": { "type": "string", "format": "date-time", "description": "The time at which a storage task was completed.", "x-ms-client-name": "completedOn" }, "taskExecutionId": { "type": "string", "description": "The execution id for a storage task." }, "taskName": { "type": "string", "description": "The task name for a storage task." }, "summaryReportBlobUrl": { "type": "string", "format": "uri", "description": "The summary report blob url for a storage task" } }, "required": [ "summaryReportBlobUrl" ] }, "StorageTaskAssignmentCompletedStatus": { "type": "string", "description": "The status for a storage task.", "enum": [ "Succeeded", "Failed" ], "x-ms-enum": { "name": "StorageTaskAssignmentCompletedStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "StorageTaskAssignmentQueuedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskAssignmentQueued event.", "properties": { "queuedDateTime": { "type": "string", "format": "date-time", "description": "The time at which a storage task was queued.", "x-ms-client-name": "queuedOn" }, "taskExecutionId": { "type": "string", "description": "The execution id for a storage task." } } }, "StorageTaskCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted event.", "properties": { "status": { "$ref": "#/definitions/StorageTaskCompletedStatus", "description": "The status for a storage task." }, "completedDateTime": { "type": "string", "format": "date-time", "description": "The time at which a storage task was completed." }, "taskExecutionId": { "type": "string", "description": "The execution id for a storage task." }, "taskName": { "type": "string", "description": "The task name for a storage task." }, "summaryReportBlobUrl": { "type": "string", "format": "uri", "description": "The summary report blob url for a storage task" } }, "required": [ "summaryReportBlobUrl" ] }, "StorageTaskCompletedStatus": { "type": "string", "description": "The status for a storage task.", "enum": [ "Succeeded", "Failed" ], "x-ms-enum": { "name": "StorageTaskCompletedStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "StorageTaskQueuedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued event.", "properties": { "queuedDateTime": { "type": "string", "format": "date-time", "description": "The time at which a storage task was queued." }, "taskExecutionId": { "type": "string", "description": "The execution id for a storage task." } } }, "SubscriptionDeletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a\nMicrosoft.EventGrid.SubscriptionDeletedEvent event.", "properties": { "eventSubscriptionId": { "type": "string", "description": "The Azure resource ID of the deleted event subscription." } }, "required": [ "eventSubscriptionId" ] }, "SubscriptionValidationEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent event.", "properties": { "validationCode": { "type": "string", "description": "The validation code sent by Azure Event Grid to validate an event subscription.\nTo complete the validation handshake, the subscriber must either respond with this validation code as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." }, "validationUrl": { "type": "string", "description": "The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview).\nTo complete the validation handshake, the subscriber must either respond with the validationCode as part of the validation response,\nor perform a GET request on the validationUrl (available starting version 2018-05-01-preview)." } }, "required": [ "validationCode", "validationUrl" ] }, "SubscriptionValidationResponse": { "type": "object", "description": "To complete an event subscription validation handshake, a subscriber can use\neither the validationCode or the validationUrl received in a\nSubscriptionValidationEvent. When the validationCode is used, the\nSubscriptionValidationResponse can be used to build the response.", "properties": { "validationResponse": { "type": "string", "description": "The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription." } }, "required": [ "validationResponse" ] }, "VirtualMachineScaleSetLifecycleHookEventAdditionalContext": { "type": "object", "description": "Additional key-value pairs set on the Lifecycle Hook event that gives customer some useful context/data.\nThe keys in this dictionary are specific to the Lifecycle Hook type. Different Lifecycle Hook events can have different sets of keys in the additional context depending on the Lifecycle Hook type.\nFor example, for a Lifecycle Hook event with UpgradeAutoOSScheduling type,\nthe additional context can contain the key \"priority\" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the Virtual Machine Scale Set.", "properties": { "priority": { "type": "string", "description": "Can only be present for a Lifecycle Hook event of type \"UpgradeAutoOSScheduling\". Denotes the priority of the Virtual Machine Scale Set Lifecycle Hook event for the Auto OS Upgrade scheduled on the Virtual Machine Scale Set." } } }, "VirtualMachineScaleSetLifecycleHookEventProperties": { "type": "object", "description": "Defines the Virtual Machine Scale Set Lifecycle Hook event properties.", "properties": { "type": { "$ref": "#/definitions/VirtualMachineScaleSetLifecycleHookEventType", "description": "Defines the type or scenario for sending a Virtual Machine Scale Set Lifecycle Hook event to the customer." }, "waitUntil": { "type": "string", "description": "Specifies the exact UTC timestamp in ISO 8601 format till which the event would remain in the current lifecycle state waiting for an action from the customer. Beyond this timestamp, the platform will apply the defaultAction for the event." }, "maxWaitUntil": { "type": "string", "description": "Specifies the exact UTC timestamp in ISO 8601 format till when the customer can delay the Lifecycle Hook event. The customer will not be allowed to delay the event to a timestamp beyond this." }, "timeCreated": { "type": "string", "description": "The UTC timestamp in ISO 8601 format at which the platform creates the Virtual Machine Scale Set Lifecycle Hook event entity." }, "defaultAction": { "$ref": "#/definitions/LifecycleHookAction", "description": "Specify the action that will be applied on the a target resource in the Virtual Machine Scale Set Lifecycle Hook event if the platform does not get a response from the customer for the target resource before waitUntil." }, "targetResources": { "type": "array", "description": "List of target resources which are getting processed in the Virtual Machine Scale Set Lifecycle Hook event.", "items": { "$ref": "#/definitions/VirtualMachineScaleSetLifecycleHookEventTargetResource" }, "readOnly": true }, "additionalContext": { "$ref": "#/definitions/VirtualMachineScaleSetLifecycleHookEventAdditionalContext", "description": "Additional key-value pairs set on the Lifecycle Hook event that gives customer some useful context/data.\nThe keys in this dictionary are specific to the Lifecycle Hook type. Different Lifecycle Hook events can have different sets of keys in the additional context depending on the Lifecycle Hook type.\nFor example, for a Lifecycle Hook event with UpgradeAutoOSScheduling type,\nthe additional context can contain the key \"priority\" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the Virtual Machine Scale Set." }, "state": { "$ref": "#/definitions/VirtualMachineScaleSetLifecycleHookEventState", "description": "Specifies the state of the Virtual Machine Scale Set Lifecycle Hook event." } }, "required": [ "type", "waitUntil", "maxWaitUntil", "timeCreated", "defaultAction", "targetResources", "state" ] }, "VirtualMachineScaleSetLifecycleHookEventState": { "type": "string", "description": "The states that a Virtual Machine Scale Set Lifecycle Hook event can be in. This is not settable by the customer. It is set only by the platform.", "enum": [ "Active", "Completed" ], "x-ms-enum": { "name": "VirtualMachineScaleSetLifecycleHookEventState", "modelAsString": true, "values": [ { "name": "Active", "value": "Active", "description": "The Lifecycle Hook event is active. E.g., waiting on a response from the customer." }, { "name": "Completed", "value": "Completed", "description": "The Lifecycle Hook event is completed. i.e., all the target resources in the event have moved to a terminal state." } ] } }, "VirtualMachineScaleSetLifecycleHookEventTargetResource": { "type": "object", "description": "Define a single target ARM resource in a Virtual Machine Scale Set Lifecycle Hook event. Currently, this can be a Virtual Machine Scale Set resource or an individual virtual machine resource within a VirtualMachineScaleSet.", "properties": { "resource": { "$ref": "#/definitions/ApiEntityReference", "description": "Specifies the target ARM resource. Currently, this can be a Virtual Machine Scale Set resource or an individual virtual machine resource within a VirtualMachineScaleSet." }, "actionState": { "$ref": "#/definitions/LifecycleHookActionState", "description": "State of the Lifecycle Hook for the target resource. The customer can patch this property to move the Lifecycle Hook to a terminal state." } }, "required": [ "resource", "actionState" ] }, "VirtualMachineScaleSetLifecycleHookEventType": { "type": "string", "description": "Specifies the scenario for which the customer is interested in receiving Virtual Machine Scale Set Lifecycle Hook events.", "enum": [ "UpgradeAutoOSScheduling", "UpgradeAutoOSRollingBatchStarting" ], "x-ms-enum": { "name": "VirtualMachineScaleSetLifecycleHookEventType", "modelAsString": true, "values": [ { "name": "UpgradeAutoOSScheduling", "value": "UpgradeAutoOSScheduling", "description": "Lifecycle Hook event sent to the customer before an Auto OS Upgrade operation starts on the Virtual Machine Scale Set." }, { "name": "UpgradeAutoOSRollingBatchStarting", "value": "UpgradeAutoOSRollingBatchStarting", "description": "Lifecycle Hook event sent to the customer before upgrade starts on a batch of virtual machines belonging to a Virtual Machine Scale Set during an Auto OS Upgrade operation." } ] } }, "WebAppServicePlanUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated event.", "properties": { "appServicePlanEventTypeDetail": { "$ref": "#/definitions/AppServicePlanEventTypeDetail", "description": "Detail of action on the app service plan." }, "sku": { "$ref": "#/definitions/WebAppServicePlanUpdatedEventDataSku", "description": "sku of app service plan." }, "name": { "type": "string", "description": "name of the app service plan that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the app service plan API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the app service plan API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the app service plan API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebAppServicePlanUpdatedEventDataSku": { "type": "object", "description": "sku of app service plan.", "properties": { "name": { "type": "string", "description": "name of app service plan sku." }, "Tier": { "type": "string", "description": "tier of app service plan sku." }, "Size": { "type": "string", "description": "size of app service plan sku." }, "Family": { "type": "string", "description": "family of app service plan sku." }, "Capacity": { "type": "string", "description": "capacity of app service plan sku." } } }, "WebAppUpdatedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebBackupOperationCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebBackupOperationFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebBackupOperationStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebRestoreOperationCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebRestoreOperationFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebRestoreOperationStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebSlotSwapCompletedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebSlotSwapFailedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebSlotSwapStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebSlotSwapWithPreviewCancelledEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewCancelled event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } }, "WebSlotSwapWithPreviewStartedEventData": { "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted event.", "properties": { "appEventTypeDetail": { "$ref": "#/definitions/AppEventTypeDetail", "description": "Detail of action on the app." }, "name": { "type": "string", "description": "name of the web site that had this event." }, "clientRequestId": { "type": "string", "description": "The client request id generated by the app service for the site API operation that triggered this event." }, "correlationRequestId": { "type": "string", "description": "The correlation request id generated by the app service for the site API operation that triggered this event." }, "requestId": { "type": "string", "description": "The request id generated by the app service for the site API operation that triggered this event." }, "address": { "type": "string", "description": "HTTP request URL of this operation." }, "verb": { "type": "string", "description": "HTTP verb of this operation." } } } }, "parameters": {} }