diff --git a/sdk/eventgrid/azure-eventgrid/azure/eventgrid/models/__init__.py b/sdk/eventgrid/azure-eventgrid/azure/eventgrid/models/__init__.py index c737bb9612dd..e3b4c5295f07 100644 --- a/sdk/eventgrid/azure-eventgrid/azure/eventgrid/models/__init__.py +++ b/sdk/eventgrid/azure-eventgrid/azure/eventgrid/models/__init__.py @@ -12,29 +12,10 @@ if TYPE_CHECKING: from ._patch import * # pylint: disable=unused-wildcard-import - -from ._models import ( # type: ignore - AcknowledgeResult, - FailedLockToken, - RejectResult, - ReleaseResult, - RenewLocksResult, -) - -from ._enums import ( # type: ignore - ReleaseDelay, -) from ._patch import __all__ as _patch_all from ._patch import * from ._patch import patch_sdk as _patch_sdk -__all__ = [ - "AcknowledgeResult", - "FailedLockToken", - "RejectResult", - "ReleaseResult", - "RenewLocksResult", - "ReleaseDelay", -] +__all__ = [] __all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/eventgrid/azure-eventgrid/azure/eventgrid/types.py b/sdk/eventgrid/azure-eventgrid/azure/eventgrid/types.py new file mode 100644 index 000000000000..d3ae67f7eac3 --- /dev/null +++ b/sdk/eventgrid/azure-eventgrid/azure/eventgrid/types.py @@ -0,0 +1,8399 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Literal, Optional +from typing_extensions import Required, TypedDict + +AcsCallEndedByKind = Literal["Participant", "MicrosoftInternal"] +"""Call ended participant kind.""" + +AcsCallParticipantKind = Literal["Attendee", "Presenter", "Organizer", "Consumer", "Collaborator"] +"""Call participant kind.""" + +AcsChatRetentionPolicyKind = Literal["none", "threadCreationDate"] +"""Chat Retention Policy kind.""" + +AcsChatThreadDeletedReasonType = Literal["deletedByUser", "deletedByPolicy"] +"""Chat Thread Deletion Reason Type.""" + +AcsEmailDeliveryReportStatus = Literal["Bounced", "Delivered", "Failed", "FilteredSpam", "Quarantined", "Suppressed"] +"""The status of the email. Any value other than Delivered is considered failed.""" + +AcsInteractiveReplyKind = Literal["buttonReply", "listReply", "unknown"] +"""Interactive reply kind.""" + +AcsMessageChannelKind = Literal["whatsapp"] +"""Message channel kind.""" + +AcsMessageDeliveryStatus = Literal["read", "delivered", "failed", "sent", "warning", "unknown"] +"""Message delivery status.""" + +AcsRecordingChannelType = Literal["Mixed", "Unmixed"] +"""Recording channel type.""" + +AcsRecordingContentType = Literal["AudioVideo", "Audio"] +"""Recording content type.""" + +AcsRecordingFormatType = Literal["Wav", "Mp3", "Mp4"] +"""Recording format type.""" + +AcsRouterJobStatus = Literal[ + "PendingClassification", + "Queued", + "Assigned", + "Completed", + "Closed", + "Cancelled", + "ClassificationFailed", + "Created", + "PendingSchedule", + "Scheduled", + "ScheduleFailed", + "WaitingForActivation", +] +"""Acs Router Job Status.""" + +AcsRouterLabelOperator = Literal["Equal", "NotEqual", "Greater", "Less", "GreaterThanOrEqual", "LessThanOrEqual"] +"""Router Job Worker Selector Label Operator.""" + +AcsRouterUpdatedWorkerProperty = Literal[ + "AvailableForOffers", "TotalCapacity", "QueueAssignments", "Labels", "Tags", "ChannelConfigurations" +] +"""Worker properties that can be updated.""" + +AcsRouterWorkerSelectorState = Literal["active", "expired"] +"""Router Worker Selector State.""" + +AcsUserEngagement = Literal["view", "click"] +"""The type of engagement user have with email.""" + +AppAction = Literal["Restarted", "Stopped", "ChangedAppSettings", "Started", "Completed", "Failed"] +"""Type of action of the operation.""" + +AppServicePlanAction = Literal["Updated"] +"""Type of action on the app service plan.""" + +AsyncStatus = Literal["Started", "Completed", "Failed"] +"""Asynchronous operation status of the operation on the app service plan.""" + +CommunicationCloudEnvironmentModel = Literal["public", "dod", "gcch"] +"""Communication cloud environment model.""" + +CommunicationIdentifierModelKind = Literal[ + "unknown", "communicationUser", "phoneNumber", "microsoftTeamsUser", "microsoftTeamsApp" +] +"""Communication model identifier kind.""" + +DataBoxStageName = Literal["CopyStarted", "CopyCompleted", "OrderCompleted"] +"""Schema of DataBox Stage Name enumeration.""" + +EventGridMQTTClientDisconnectionReason = Literal[ + "ClientAuthenticationError", + "ClientAuthorizationError", + "ClientError", + "ClientInitiatedDisconnect", + "ConnectionLost", + "IpForbidden", + "QuotaExceeded", + "ServerError", + "ServerInitiatedDisconnect", + "SessionOverflow", + "SessionTakenOver", +] +"""EventGrid MQTT Client Disconnection Reason.""" + +EventGridMQTTClientState = Literal["Enabled", "Disabled"] +"""EventGrid MQTT Client State.""" + +HealthcareFhirResourceType = Literal[ + "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", +] +"""Schema of FHIR resource type enumeration.""" + +StampKind = Literal["Public", "AseV1", "AseV2"] +"""Kind of environment where app service plan is.""" + +StorageBlobAccessTier = Literal["Hot", "Cool", "Cold", "Archive", "Default"] +"""The access tier of the blob.""" + +StorageLifecycleCompletionStatus = Literal["Completed", "CompletedWithError", "Incomplete"] +"""The status for a LCM policy.""" + +StorageTaskAssignmentCompletedStatus = Literal["Succeeded", "Failed"] +"""The status for a storage task.""" + +StorageTaskCompletedStatus = Literal["Succeeded", "Failed"] +"""The status for a storage task.""" + + +class AcsCallEndedByProperties(TypedDict, total=False): + """Schema of calling event ended by properties. + + :ivar communication_identifier: The communication identifier of the call ended by. Required. + :vartype communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar kind: The type of call ended by. Required. Known values are: "Participant" and + "MicrosoftInternal". + :vartype kind: str or ~azure.eventgrid.models.AcsCallEndedByKind + :ivar name: The name of the call ended by. Required. + :vartype name: str + """ + + communicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the call ended by. Required.""" + type: Required[AcsCallEndedByKind] + """The type of call ended by. Required. Known values are: \"Participant\" and + \"MicrosoftInternal\".""" + name: Required[str] + """The name of the call ended by. Required.""" + + +class AcsCallingEventProperties(TypedDict, total=False): + """Schema of common properties of all calling events. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + """ + + startedBy: Required["AcsCallParticipantProperties"] + """The call participant who initiated the call. Required.""" + serverCallId: Required[str] + """The call id of the server. Required.""" + group: "AcsCallGroupProperties" + """The group metadata.""" + room: "AcsCallRoomProperties" + """The room metadata.""" + isTwoParty: bool + """Is two-party in calling event.""" + correlationId: Required[str] + """The correlationId of calling event. Required.""" + isRoomsCall: bool + """Is the calling event a room call.""" + + +class AcsCallEndedEventData(AcsCallingEventProperties): + """Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallEnded event. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + :ivar ended_by: The communication identifier of the user who was disconnected. + :vartype ended_by: ~azure.eventgrid.types.AcsCallEndedByProperties + :ivar reason: The reason for ending the call. + :vartype reason: ~azure.eventgrid.types.AcsCallEndReasonProperties + :ivar call_duration_in_seconds: Duration of the call in seconds. + :vartype call_duration_in_seconds: float + """ + + endedBy: "AcsCallEndedByProperties" + """The communication identifier of the user who was disconnected.""" + reason: "AcsCallEndReasonProperties" + """The reason for ending the call.""" + callDurationInSeconds: float + """Duration of the call in seconds.""" + + +class AcsCallEndReasonProperties(TypedDict, total=False): + """Schema of calling event reason properties. + + :ivar code: Reason code for ending the call. + :vartype code: int + :ivar sub_code: Reason subcode for ending the call. + :vartype sub_code: int + :ivar phrase: Reason for the ending the call. + :vartype phrase: str + """ + + code: int + """Reason code for ending the call.""" + subCode: int + """Reason subcode for ending the call.""" + phrase: str + """Reason for the ending the call.""" + + +class AcsCallGroupProperties(TypedDict, total=False): + """Schema of calling event group properties. + + :ivar id: Group Id. + :vartype id: str + """ + + id: str + """Group Id.""" + + +class AcsCallParticipantEventData(AcsCallingEventProperties): + """Schema of common properties of all participant events. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + :ivar user: The user of the call participant. + :vartype user: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar display_name: The display name of the participant. + :vartype display_name: str + :ivar participant_id: The id of the participant. + :vartype participant_id: str + :ivar user_agent: The user agent of the participant. + :vartype user_agent: str + """ + + user: "AcsCallParticipantProperties" + """The user of the call participant.""" + displayName: str + """The display name of the participant.""" + participantId: str + """The id of the participant.""" + userAgent: str + """The user agent of the participant.""" + + +class AcsCallParticipantAddedEventData(AcsCallParticipantEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.CallParticipantAdded event. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + :ivar user: The user of the call participant. + :vartype user: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar display_name: The display name of the participant. + :vartype display_name: str + :ivar participant_id: The id of the participant. + :vartype participant_id: str + :ivar user_agent: The user agent of the participant. + :vartype user_agent: str + """ + + +class AcsCallParticipantProperties(TypedDict, total=False): + """Schema of common properties of all participant event user. + + :ivar communication_identifier: The communication identifier of the participant user. + :vartype communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar role: The role of the participant. Known values are: "Attendee", "Presenter", + "Organizer", "Consumer", and "Collaborator". + :vartype role: str or ~azure.eventgrid.models.AcsCallParticipantKind + """ + + communicationIdentifier: "CommunicationIdentifierModel" + """The communication identifier of the participant user.""" + role: AcsCallParticipantKind + """The role of the participant. Known values are: \"Attendee\", \"Presenter\", \"Organizer\", + \"Consumer\", and \"Collaborator\".""" + + +class AcsCallParticipantRemovedEventData(AcsCallParticipantEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.CallParticipantRemoved event. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + :ivar user: The user of the call participant. + :vartype user: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar display_name: The display name of the participant. + :vartype display_name: str + :ivar participant_id: The id of the participant. + :vartype participant_id: str + :ivar user_agent: The user agent of the participant. + :vartype user_agent: str + """ + + +class AcsCallRoomProperties(TypedDict, total=False): + """Schema of calling event room properties. + + :ivar id: Room Id. + :vartype id: str + """ + + id: str + """Room Id.""" + + +class AcsCallStartedEventData(AcsCallingEventProperties): + """Schema of the Data property of an EventGridEvent for a Microsoft.Communication.CallStarted + event. + + :ivar started_by: The call participant who initiated the call. Required. + :vartype started_by: ~azure.eventgrid.types.AcsCallParticipantProperties + :ivar server_call_id: The call id of the server. Required. + :vartype server_call_id: str + :ivar group: The group metadata. + :vartype group: ~azure.eventgrid.types.AcsCallGroupProperties + :ivar room: The room metadata. + :vartype room: ~azure.eventgrid.types.AcsCallRoomProperties + :ivar is_two_party: Is two-party in calling event. + :vartype is_two_party: bool + :ivar correlation_id: The correlationId of calling event. Required. + :vartype correlation_id: str + :ivar is_rooms_call: Is the calling event a room call. + :vartype is_rooms_call: bool + """ + + +class AcsChatEventInThreadBaseProperties(TypedDict, total=False): + """Schema of common properties of all thread-level chat events. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + """ + + transactionId: str + """The transaction id will be used as co-relation vector.""" + threadId: Required[str] + """The chat thread id. Required.""" + + +class AcsChatMessageEventInThreadBaseProperties(AcsChatEventInThreadBaseProperties): # pylint: disable=name-too-long + """Schema of common properties of all thread-level chat message events. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + """ + + messageId: Required[str] + """The chat message id. Required.""" + senderCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the sender. Required.""" + senderDisplayName: str + """The display name of the sender.""" + sequenceId: int + """The Sequence id of the message.""" + composeTime: Required[datetime.datetime] + """The original compose time of the message. Required.""" + type: Required[str] + """The type of the message. Required.""" + version: Required[int] + """The version of the message. Required.""" + + +class AcsChatAzureBotCommandReceivedInThreadEventData( + AcsChatMessageEventInThreadBaseProperties +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatAzureBotCommandReceivedInThread event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + + +class AcsChatEventBaseProperties(TypedDict, total=False): + """Schema of common properties of all chat events. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + """ + + recipientCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the target user. Required.""" + transactionId: str + """The transaction id will be used as co-relation vector.""" + threadId: Required[str] + """The chat thread id. Required.""" + + +class AcsChatMessageEventBaseProperties(AcsChatEventBaseProperties): + """Schema of common properties of all chat message events. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + """ + + messageId: Required[str] + """The chat message id. Required.""" + senderCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the sender. Required.""" + senderDisplayName: str + """The display name of the sender.""" + sequenceId: int + """The Sequence id of the message.""" + composeTime: Required[datetime.datetime] + """The original compose time of the message. Required.""" + type: Required[str] + """The type of the message. Required.""" + version: Required[int] + """The version of the message. Required.""" + + +class AcsChatMessageDeletedEventData(AcsChatMessageEventBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageDeleted event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar delete_time: The time at which the message was deleted. Required. + :vartype delete_time: ~datetime.datetime + """ + + deleteTime: Required[datetime.datetime] + """The time at which the message was deleted. Required.""" + + +class AcsChatMessageDeletedInThreadEventData(AcsChatMessageEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageDeletedInThread event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar delete_time: The time at which the message was deleted. Required. + :vartype delete_time: ~datetime.datetime + """ + + deleteTime: Required[datetime.datetime] + """The time at which the message was deleted. Required.""" + + +class AcsChatMessageEditedEventData(AcsChatMessageEventBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageEdited event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + :ivar edit_time: The time at which the message was edited. Required. + :vartype edit_time: ~datetime.datetime + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + editTime: Required[datetime.datetime] + """The time at which the message was edited. Required.""" + + +class AcsChatMessageEditedInThreadEventData(AcsChatMessageEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageEditedInThread event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + :ivar edit_time: The time at which the message was edited. Required. + :vartype edit_time: ~datetime.datetime + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + editTime: Required[datetime.datetime] + """The time at which the message was edited. Required.""" + + +class AcsChatMessageReceivedEventData(AcsChatMessageEventBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageReceived event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + + +class AcsChatMessageReceivedInThreadEventData(AcsChatMessageEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatMessageReceivedInThread event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + + +class AcsChatParticipantAddedToThreadEventData(AcsChatEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadParticipantAdded event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar time: The time at which the user was added to the thread. Required. + :vartype time: ~datetime.datetime + :ivar added_by_communication_identifier: The communication identifier of the user who added the + user. Required. + :vartype added_by_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar participant_added: The details of the user who was added. Required. + :vartype participant_added: ~azure.eventgrid.types.AcsChatThreadParticipantProperties + :ivar version: The version of the thread. + :vartype version: int + """ + + time: Required[datetime.datetime] + """The time at which the user was added to the thread. Required.""" + addedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who added the user. Required.""" + participantAdded: Required["AcsChatThreadParticipantProperties"] + """The details of the user who was added. Required.""" + version: int + """The version of the thread.""" + + +class AcsChatThreadEventBaseProperties(AcsChatEventBaseProperties): + """Schema of common properties of all chat thread events. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + """ + + createTime: Required[datetime.datetime] + """The original creation time of the thread. Required.""" + version: int + """The version of the thread.""" + + +class AcsChatParticipantAddedToThreadWithUserEventData( + AcsChatThreadEventBaseProperties +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatParticipantAddedToThreadWithUser event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar time: The time at which the user was added to the thread. Required. + :vartype time: ~datetime.datetime + :ivar added_by_communication_identifier: The communication identifier of the user who added the + user. Required. + :vartype added_by_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar participant_added: The details of the user who was added. Required. + :vartype participant_added: ~azure.eventgrid.types.AcsChatThreadParticipantProperties + """ + + time: Required[datetime.datetime] + """The time at which the user was added to the thread. Required.""" + addedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who added the user. Required.""" + participantAdded: Required["AcsChatThreadParticipantProperties"] + """The details of the user who was added. Required.""" + + +class AcsChatParticipantRemovedFromThreadEventData(AcsChatEventInThreadBaseProperties): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadParticipantRemoved event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar time: The time at which the user was removed to the thread. Required. + :vartype time: ~datetime.datetime + :ivar removed_by_communication_identifier: The communication identifier of the user who removed + the user. Required. + :vartype removed_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar participant_removed: The details of the user who was removed. Required. + :vartype participant_removed: ~azure.eventgrid.types.AcsChatThreadParticipantProperties + :ivar version: The version of the thread. + :vartype version: int + """ + + time: Required[datetime.datetime] + """The time at which the user was removed to the thread. Required.""" + removedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who removed the user. Required.""" + participantRemoved: Required["AcsChatThreadParticipantProperties"] + """The details of the user who was removed. Required.""" + version: int + """The version of the thread.""" + + +class AcsChatParticipantRemovedFromThreadWithUserEventData( + AcsChatThreadEventBaseProperties +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatParticipantRemovedFromThreadWithUser event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar time: The time at which the user was removed to the thread. Required. + :vartype time: ~datetime.datetime + :ivar removed_by_communication_identifier: The communication identifier of the user who removed + the user. Required. + :vartype removed_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar participant_removed: The details of the user who was removed. Required. + :vartype participant_removed: ~azure.eventgrid.types.AcsChatThreadParticipantProperties + """ + + time: Required[datetime.datetime] + """The time at which the user was removed to the thread. Required.""" + removedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who removed the user. Required.""" + participantRemoved: Required["AcsChatThreadParticipantProperties"] + """The details of the user who was removed. Required.""" + + +class AcsChatRetentionPolicy(TypedDict, total=False): + """Schema of common properties of all chat retention policy. + + :ivar kind: The chat retention policy kind. Known values are: "none" and "threadCreationDate". + :vartype kind: str or ~azure.eventgrid.models.AcsChatRetentionPolicyKind + :ivar delete_thread_after_days: The delete thread after number of days. + :vartype delete_thread_after_days: int + """ + + kind: AcsChatRetentionPolicyKind + """The chat retention policy kind. Known values are: \"none\" and \"threadCreationDate\".""" + deleteThreadAfterDays: int + """The delete thread after number of days.""" + + +class AcsChatThreadEventInThreadBaseProperties(AcsChatEventInThreadBaseProperties): + """Schema of common properties of all chat thread events. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + """ + + createTime: Required[datetime.datetime] + """The original creation time of the thread. Required.""" + version: int + """The version of the thread.""" + + +class AcsChatThreadCreatedEventData(AcsChatThreadEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadCreated event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar created_by_communication_identifier: The communication identifier of the user who created + the thread. Required. + :vartype created_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar properties: The thread properties. Required. + :vartype properties: dict[str, any] + :ivar metadata: The thread metadata. + :vartype metadata: dict[str, str] + :ivar participants: The list of properties of participants who are part of the thread. + Required. + :vartype participants: list[~azure.eventgrid.types.AcsChatThreadParticipantProperties] + :ivar retention_policy: The retention policy for the chat. + :vartype retention_policy: ~azure.eventgrid.types.AcsChatRetentionPolicy + """ + + createdByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who created the thread. Required.""" + properties: Required[dict[str, Any]] + """The thread properties. Required.""" + metadata: dict[str, str] + """The thread metadata.""" + participants: Required[list["AcsChatThreadParticipantProperties"]] + """The list of properties of participants who are part of the thread. Required.""" + retentionPolicy: "AcsChatRetentionPolicy" + """The retention policy for the chat.""" + + +class AcsChatThreadCreatedWithUserEventData(AcsChatThreadEventBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadCreatedWithUser event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar created_by_communication_identifier: The communication identifier of the user who created + the thread. Required. + :vartype created_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar properties: The thread properties. Required. + :vartype properties: dict[str, any] + :ivar metadata: The thread metadata. + :vartype metadata: dict[str, str] + :ivar participants: The list of properties of participants who are part of the thread. + Required. + :vartype participants: list[~azure.eventgrid.types.AcsChatThreadParticipantProperties] + :ivar retention_policy: The retention policy for the chat. + :vartype retention_policy: ~azure.eventgrid.types.AcsChatRetentionPolicy + """ + + createdByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who created the thread. Required.""" + properties: Required[dict[str, Any]] + """The thread properties. Required.""" + metadata: dict[str, str] + """The thread metadata.""" + participants: Required[list["AcsChatThreadParticipantProperties"]] + """The list of properties of participants who are part of the thread. Required.""" + retentionPolicy: "AcsChatRetentionPolicy" + """The retention policy for the chat.""" + + +class AcsChatThreadDeletedEventData(AcsChatThreadEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadDeleted event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar deleted_by_communication_identifier: The communication identifier of the user who deleted + the thread. Required. + :vartype deleted_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar delete_time: The deletion time of the thread. Required. + :vartype delete_time: ~datetime.datetime + :ivar reason: The chat thread deletion reason. Known values are: "deletedByUser" and + "deletedByPolicy". + :vartype reason: str or ~azure.eventgrid.models.AcsChatThreadDeletedReasonType + """ + + deletedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who deleted the thread. Required.""" + deleteTime: Required[datetime.datetime] + """The deletion time of the thread. Required.""" + reason: AcsChatThreadDeletedReasonType + """The chat thread deletion reason. Known values are: \"deletedByUser\" and \"deletedByPolicy\".""" + + +class AcsChatThreadParticipantProperties(TypedDict, total=False): + """Schema of the chat thread participant. + + :ivar display_name: The name of the user. + :vartype display_name: str + :ivar participant_communication_identifier: The communication identifier of the user. Required. + :vartype participant_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar metadata: The metadata of the user. + :vartype metadata: dict[str, str] + """ + + displayName: str + """The name of the user.""" + participantCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user. Required.""" + metadata: dict[str, str] + """The metadata of the user.""" + + +class AcsChatThreadPropertiesUpdatedEventData(AcsChatThreadEventInThreadBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadPropertiesUpdated event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar edited_by_communication_identifier: The communication identifier of the user who updated + the thread properties. Required. + :vartype edited_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar edit_time: The time at which the properties of the thread were updated. Required. + :vartype edit_time: ~datetime.datetime + :ivar properties: The updated thread properties. Required. + :vartype properties: dict[str, any] + :ivar metadata: The thread metadata. Required. + :vartype metadata: dict[str, str] + :ivar retention_policy: The retention policy for the chat. + :vartype retention_policy: ~azure.eventgrid.types.AcsChatRetentionPolicy + """ + + editedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who updated the thread properties. Required.""" + editTime: Required[datetime.datetime] + """The time at which the properties of the thread were updated. Required.""" + properties: Required[dict[str, Any]] + """The updated thread properties. Required.""" + metadata: Required[dict[str, str]] + """The thread metadata. Required.""" + retentionPolicy: "AcsChatRetentionPolicy" + """The retention policy for the chat.""" + + +class AcsChatThreadPropertiesUpdatedPerUserEventData(AcsChatThreadEventBaseProperties): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar edited_by_communication_identifier: The communication identifier of the user who updated + the thread properties. Required. + :vartype edited_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar edit_time: The time at which the properties of the thread were updated. Required. + :vartype edit_time: ~datetime.datetime + :ivar metadata: The thread metadata. + :vartype metadata: dict[str, str] + :ivar properties: The updated thread properties. Required. + :vartype properties: dict[str, any] + :ivar retention_policy: The retention policy for the chat. + :vartype retention_policy: ~azure.eventgrid.types.AcsChatRetentionPolicy + """ + + editedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who updated the thread properties. Required.""" + editTime: Required[datetime.datetime] + """The time at which the properties of the thread were updated. Required.""" + metadata: dict[str, str] + """The thread metadata.""" + properties: Required[dict[str, Any]] + """The updated thread properties. Required.""" + retentionPolicy: "AcsChatRetentionPolicy" + """The retention policy for the chat.""" + + +class AcsChatThreadWithUserDeletedEventData(AcsChatThreadEventBaseProperties): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatThreadWithUserDeleted event. + + :ivar recipient_communication_identifier: The communication identifier of the target user. + Required. + :vartype recipient_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar create_time: The original creation time of the thread. Required. + :vartype create_time: ~datetime.datetime + :ivar version: The version of the thread. + :vartype version: int + :ivar deleted_by_communication_identifier: The communication identifier of the user who deleted + the thread. Required. + :vartype deleted_by_communication_identifier: + ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar delete_time: The deletion time of the thread. Required. + :vartype delete_time: ~datetime.datetime + """ + + deletedByCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who deleted the thread. Required.""" + deleteTime: Required[datetime.datetime] + """The deletion time of the thread. Required.""" + + +class AcsChatTypingIndicatorReceivedInThreadEventData( + AcsChatMessageEventInThreadBaseProperties +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.ChatTypingIndicatorReceivedInThread event. + + :ivar transaction_id: The transaction id will be used as co-relation vector. + :vartype transaction_id: str + :ivar thread_id: The chat thread id. Required. + :vartype thread_id: str + :ivar message_id: The chat message id. Required. + :vartype message_id: str + :ivar sender_communication_identifier: The communication identifier of the sender. Required. + :vartype sender_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + :ivar sender_display_name: The display name of the sender. + :vartype sender_display_name: str + :ivar sequence_id: The Sequence id of the message. + :vartype sequence_id: int + :ivar compose_time: The original compose time of the message. Required. + :vartype compose_time: ~datetime.datetime + :ivar type: The type of the message. Required. + :vartype type: str + :ivar version: The version of the message. Required. + :vartype version: int + :ivar message_body: The body of the chat message. Required. + :vartype message_body: str + :ivar metadata: The chat message metadata. + :vartype metadata: dict[str, str] + """ + + messageBody: Required[str] + """The body of the chat message. Required.""" + metadata: dict[str, str] + """The chat message metadata.""" + + +class AcsEmailDeliveryReportReceivedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.EmailDeliveryReportReceived event. + + :ivar sender: The Sender Email Address. Required. + :vartype sender: str + :ivar recipient: The recipient Email Address. Required. + :vartype recipient: str + :ivar internet_message_id: The Internet Message Id of the email that has been sent. Required. + :vartype internet_message_id: str + :ivar message_id: The Id of the email that has been sent. + :vartype message_id: str + :ivar status: The status of the email. Any value other than Delivered is considered failed. + Required. Known values are: "Bounced", "Delivered", "Failed", "FilteredSpam", "Quarantined", + and "Suppressed". + :vartype status: str or ~azure.eventgrid.models.AcsEmailDeliveryReportStatus + :ivar delivery_status_details: Detailed information about the status if any. Required. + :vartype delivery_status_details: ~azure.eventgrid.types.AcsEmailDeliveryReportStatusDetails + :ivar delivery_attempt_timestamp: The time at which the email delivery report received + timestamp. Required. + :vartype delivery_attempt_timestamp: ~datetime.datetime + """ + + sender: Required[str] + """The Sender Email Address. Required.""" + recipient: Required[str] + """The recipient Email Address. Required.""" + internetMessageId: Required[str] + """The Internet Message Id of the email that has been sent. Required.""" + messageId: str + """The Id of the email that has been sent.""" + status: Required[AcsEmailDeliveryReportStatus] + """The status of the email. Any value other than Delivered is considered failed. Required. Known + values are: \"Bounced\", \"Delivered\", \"Failed\", \"FilteredSpam\", \"Quarantined\", and + \"Suppressed\".""" + deliveryStatusDetails: Required["AcsEmailDeliveryReportStatusDetails"] + """Detailed information about the status if any. Required.""" + deliveryAttemptTimestamp: Required[datetime.datetime] + """The time at which the email delivery report received timestamp. Required.""" + + +class AcsEmailDeliveryReportStatusDetails(TypedDict, total=False): + """Detailed information about the status if any. + + :ivar status_message: Detailed status message. + :vartype status_message: str + :ivar recipient_mail_server_host_name: Recipient mail server host name. + :vartype recipient_mail_server_host_name: str + """ + + statusMessage: str + """Detailed status message.""" + recipientMailServerHostName: str + """Recipient mail server host name.""" + + +class AcsEmailEngagementTrackingReportReceivedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.EmailEngagementTrackingReportReceived event. + + :ivar sender: The Sender Email Address. + :vartype sender: str + :ivar recipient: The Recipient Email Address. + :vartype recipient: str + :ivar message_id: The Id of the email that has been sent. + :vartype message_id: str + :ivar user_action_timestamp: The time at which the user interacted with the email. Required. + :vartype user_action_timestamp: ~datetime.datetime + :ivar engagement_context: The context of the type of engagement user had with email. + :vartype engagement_context: str + :ivar user_agent: The user agent interacting with the email. + :vartype user_agent: str + :ivar engagement: The type of engagement user have with email. Required. Known values are: + "view" and "click". + :vartype engagement: str or ~azure.eventgrid.models.AcsUserEngagement + """ + + sender: str + """The Sender Email Address.""" + recipient: str + """The Recipient Email Address.""" + messageId: str + """The Id of the email that has been sent.""" + userActionTimestamp: Required[datetime.datetime] + """The time at which the user interacted with the email. Required.""" + engagementContext: str + """The context of the type of engagement user had with email.""" + userAgent: str + """The user agent interacting with the email.""" + engagementType: Required[AcsUserEngagement] + """The type of engagement user have with email. Required. Known values are: \"view\" and + \"click\".""" + + +class AcsIncomingCallCustomContext(TypedDict, total=False): + """Custom Context of Incoming Call. + + :ivar sip_headers: Sip Headers for incoming call. Required. + :vartype sip_headers: dict[str, str] + :ivar voip_headers: Voip Headers for incoming call. Required. + :vartype voip_headers: dict[str, str] + """ + + sipHeaders: Required[dict[str, str]] + """Sip Headers for incoming call. Required.""" + voipHeaders: Required[dict[str, str]] + """Voip Headers for incoming call. Required.""" + + +AcsIncomingCallEventData = TypedDict( + "AcsIncomingCallEventData", + { + "to": Required["CommunicationIdentifierModel"], + "from": Required["CommunicationIdentifierModel"], + "serverCallId": str, + "callerDisplayName": str, + "customContext": Required["AcsIncomingCallCustomContext"], + "incomingCallContext": str, + "onBehalfOfCallee": "CommunicationIdentifierModel", + "onBehalfOf": "CommunicationIdentifierModel", + "correlationId": str, + }, + total=False, +) +"""Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall +event. + +:ivar to_communication_identifier: The communication identifier of the target user. Required. +:vartype to_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel +:ivar from_communication_identifier: The communication identifier of the user who initiated the + call. Required. +:vartype from_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel +:ivar server_call_id: The Id of the server call. +:vartype server_call_id: str +:ivar caller_display_name: Display name of caller. +:vartype caller_display_name: str +:ivar custom_context: Custom Context of Incoming Call. Required. +:vartype custom_context: ~azure.eventgrid.types.AcsIncomingCallCustomContext +:ivar incoming_call_context: Signed incoming call context. +:vartype incoming_call_context: str +:ivar on_behalf_of_callee: The communication identifier of the callee for the "on behalf of" + call. +:vartype on_behalf_of_callee: ~azure.eventgrid.types.CommunicationIdentifierModel +:ivar on_behalf_of: The communication identifier on behalf of whom the call is made. +:vartype on_behalf_of: ~azure.eventgrid.types.CommunicationIdentifierModel +:ivar correlation_id: CorrelationId (CallId). +:vartype correlation_id: str +""" + + +class AcsMessageButtonContent(TypedDict, total=False): + """Message Button Content. + + :ivar text: The Text of the button. + :vartype text: str + :ivar payload: The Payload of the button which was clicked by the user, setup by the business. + :vartype payload: str + """ + + text: str + """The Text of the button.""" + payload: str + """The Payload of the button which was clicked by the user, setup by the business.""" + + +class AcsMessageChannelEventError(TypedDict, total=False): + """Message Channel Event Error. + + :ivar channel_code: The channel error code. + :vartype channel_code: str + :ivar channel_message: The channel error message. + :vartype channel_message: str + """ + + channelCode: str + """The channel error code.""" + channelMessage: str + """The channel error message.""" + + +AcsMessageContext = TypedDict( + "AcsMessageContext", + { + "from": str, + "id": str, + }, + total=False, +) +"""Message Context. + +:ivar from_property: The WhatsApp ID for the customer who replied to an inbound message. +:vartype from_property: str +:ivar message_id: The message ID for the sent message for an inbound reply. +:vartype message_id: str +""" + + +AcsMessageEventData = TypedDict( + "AcsMessageEventData", + { + "from": Required[str], + "to": Required[str], + "receivedTimeStamp": Required[datetime.datetime], + "error": "AcsMessageChannelEventError", + }, + total=False, +) +"""Schema of common properties of all chat thread events. + +:ivar from_property: The message sender. Required. +:vartype from_property: str +:ivar to: The message recipient. Required. +:vartype to: str +:ivar received_time_stamp: The time message was received. Required. +:vartype received_time_stamp: ~datetime.datetime +:ivar error: The channel event error. +:vartype error: ~azure.eventgrid.types.AcsMessageChannelEventError +""" + + +AcsMessageDeliveryStatusUpdatedEventData = TypedDict( + "AcsMessageDeliveryStatusUpdatedEventData", + { + "from": Required[str], + "to": Required[str], + "receivedTimeStamp": Required[datetime.datetime], + "error": "AcsMessageChannelEventError", + "messageId": str, + "toBSUID": str, + "status": Required[AcsMessageDeliveryStatus], + "channelType": Required[AcsMessageChannelKind], + }, + total=False, +) +"""Schema of the Data property of an EventGridEvent for a +Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event. + +:ivar from_property: The message sender. Required. +:vartype from_property: str +:ivar to: The message recipient. Required. +:vartype to: str +:ivar received_time_stamp: The time message was received. Required. +:vartype received_time_stamp: ~datetime.datetime +:ivar error: The channel event error. +:vartype error: ~azure.eventgrid.types.AcsMessageChannelEventError +:ivar message_id: The message id. +:vartype message_id: str +:ivar to_bsuid: Optional. The BSUID of the recipient. +:vartype to_bsuid: str +:ivar status: The updated message status. Required. Known values are: "read", "delivered", + "failed", "sent", "warning", and "unknown". +:vartype status: str or ~azure.eventgrid.models.AcsMessageDeliveryStatus +:ivar channel_kind: The updated message channel type. Required. "whatsapp" +:vartype channel_kind: str or ~azure.eventgrid.models.AcsMessageChannelKind +""" + + +class AcsMessageInteractiveButtonReplyContent(TypedDict, total=False): + """Message Interactive button reply content for a user to business message. + + :ivar button_id: The ID of the button. + :vartype button_id: str + :ivar title: The title of the button. + :vartype title: str + """ + + id: str + """The ID of the button.""" + title: str + """The title of the button.""" + + +class AcsMessageInteractiveContent(TypedDict, total=False): + """Message Interactive Content. + + :ivar reply_kind: The Message interactive reply type. Required. Known values are: + "buttonReply", "listReply", and "unknown". + :vartype reply_kind: str or ~azure.eventgrid.models.AcsInteractiveReplyKind + :ivar button_reply: The Message Sent when a customer clicks a button. + :vartype button_reply: ~azure.eventgrid.types.AcsMessageInteractiveButtonReplyContent + :ivar list_reply: The Message Sent when a customer selects an item from a list. + :vartype list_reply: ~azure.eventgrid.types.AcsMessageInteractiveListReplyContent + """ + + type: Required[AcsInteractiveReplyKind] + """The Message interactive reply type. Required. Known values are: \"buttonReply\", \"listReply\", + and \"unknown\".""" + buttonReply: "AcsMessageInteractiveButtonReplyContent" + """The Message Sent when a customer clicks a button.""" + listReply: "AcsMessageInteractiveListReplyContent" + """The Message Sent when a customer selects an item from a list.""" + + +class AcsMessageInteractiveListReplyContent(TypedDict, total=False): + """Message Interactive list reply content for a user to business message. + + :ivar list_item_id: The ID of the selected list item. + :vartype list_item_id: str + :ivar title: The title of the selected list item. + :vartype title: str + :ivar description: The description of the selected row. + :vartype description: str + """ + + id: str + """The ID of the selected list item.""" + title: str + """The title of the selected list item.""" + description: str + """The description of the selected row.""" + + +class AcsMessageMediaContent(TypedDict, total=False): + """Message Media Content. + + :ivar mime_type: Required. The MIME type of the file this media represents. Required. + :vartype mime_type: str + :ivar media_id: Required. The media identifier. Required. + :vartype media_id: str + :ivar file_name: Optional. The filename of the underlying media file as specified when + uploaded. + :vartype file_name: str + :ivar caption: Optional. The caption for the media object, if supported and provided. + :vartype caption: str + :ivar animated: Optional. Set to true if the sticker is animated; false otherwise. + :vartype animated: bool + """ + + mimeType: Required[str] + """Required. The MIME type of the file this media represents. Required.""" + id: Required[str] + """Required. The media identifier. Required.""" + fileName: str + """Optional. The filename of the underlying media file as specified when uploaded.""" + caption: str + """Optional. The caption for the media object, if supported and provided.""" + animated: bool + """Optional. Set to true if the sticker is animated; false otherwise.""" + + +class AcsMessageReactionContent(TypedDict, total=False): + """Message Reaction Content. + + :ivar message_id: Required. WhatsApp message ID of the message that the emoji is applied to. + Required. + :vartype message_id: str + :ivar emoji: Optional. Unicode escape sequence of the emoji. + :vartype emoji: str + """ + + messageId: Required[str] + """Required. WhatsApp message ID of the message that the emoji is applied to. Required.""" + emoji: str + """Optional. Unicode escape sequence of the emoji.""" + + +AcsMessageReceivedEventData = TypedDict( + "AcsMessageReceivedEventData", + { + "from": Required[str], + "to": Required[str], + "receivedTimeStamp": Required[datetime.datetime], + "error": "AcsMessageChannelEventError", + "content": str, + "messageId": str, + "fromBSUID": str, + "channelType": Required[AcsMessageChannelKind], + "messageType": Required[str], + "media": "AcsMessageMediaContent", + "reaction": "AcsMessageReactionContent", + "context": "AcsMessageContext", + "button": "AcsMessageButtonContent", + "interactive": "AcsMessageInteractiveContent", + }, + total=False, +) +"""Schema of the Data property of an EventGridEvent for a +Microsoft.Communication.AdvancedMessageReceived event. + +:ivar from_property: The message sender. Required. +:vartype from_property: str +:ivar to: The message recipient. Required. +:vartype to: str +:ivar received_time_stamp: The time message was received. Required. +:vartype received_time_stamp: ~datetime.datetime +:ivar error: The channel event error. +:vartype error: ~azure.eventgrid.types.AcsMessageChannelEventError +:ivar content: Optional. The message content. +:vartype content: str +:ivar message_id: Optional. Message ID. Format is Guid as string. +:vartype message_id: str +:ivar from_bsuid: Optional. The BSUID of the sender. +:vartype from_bsuid: str +:ivar channel_kind: Required. The message channel type. Required. "whatsapp" +:vartype channel_kind: str or ~azure.eventgrid.models.AcsMessageChannelKind +:ivar message_type: Required. Whatsapp message type. Required. +:vartype message_type: str +:ivar media_content: Optional. The received message media content. +:vartype media_content: ~azure.eventgrid.types.AcsMessageMediaContent +:ivar reaction: Optional. The received message reaction content. +:vartype reaction: ~azure.eventgrid.types.AcsMessageReactionContent +:ivar context: Optional. The received message context. +:vartype context: ~azure.eventgrid.types.AcsMessageContext +:ivar button: Optional. The received message button content. +:vartype button: ~azure.eventgrid.types.AcsMessageButtonContent +:ivar interactive_content: Optional. The received message interactive content. +:vartype interactive_content: ~azure.eventgrid.types.AcsMessageInteractiveContent +""" + + +class AcsRecordingChunkInfoProperties(TypedDict, total=False): + """Schema for all properties of Recording Chunk Information. + + :ivar document_id: The documentId of the recording chunk. + :vartype document_id: str + :ivar index: The index of the recording chunk. + :vartype index: int + :ivar end_reason: The reason for ending the recording chunk. + :vartype end_reason: str + :ivar metadata_location: The location of the metadata for this chunk. + :vartype metadata_location: str + :ivar content_location: The location of the content for this chunk. + :vartype content_location: str + :ivar delete_location: The location to delete all chunk storage. + :vartype delete_location: str + """ + + documentId: str + """The documentId of the recording chunk.""" + index: int + """The index of the recording chunk.""" + endReason: str + """The reason for ending the recording chunk.""" + metadataLocation: str + """The location of the metadata for this chunk.""" + contentLocation: str + """The location of the content for this chunk.""" + deleteLocation: str + """The location to delete all chunk storage.""" + + +class AcsRecordingFileStatusUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RecordingFileStatusUpdated event. + + :ivar recording_storage_info: The details of recording storage information. Required. + :vartype recording_storage_info: ~azure.eventgrid.types.AcsRecordingStorageInfoProperties + :ivar recording_start_time: The time at which the recording started. Required. + :vartype recording_start_time: ~datetime.datetime + :ivar recording_duration_ms: The recording duration in milliseconds. + :vartype recording_duration_ms: int + :ivar recording_content_type: The recording content type- AudioVideo, or Audio. Required. Known + values are: "AudioVideo" and "Audio". + :vartype recording_content_type: str or ~azure.eventgrid.models.AcsRecordingContentType + :ivar recording_channel_type: The recording channel type - Mixed, Unmixed. Required. Known + values are: "Mixed" and "Unmixed". + :vartype recording_channel_type: str or ~azure.eventgrid.models.AcsRecordingChannelType + :ivar recording_format_type: The recording format type - Mp4, Mp3, Wav. Required. Known values + are: "Wav", "Mp3", and "Mp4". + :vartype recording_format_type: str or ~azure.eventgrid.models.AcsRecordingFormatType + :ivar session_end_reason: The reason for ending recording session. + :vartype session_end_reason: str + """ + + recordingStorageInfo: Required["AcsRecordingStorageInfoProperties"] + """The details of recording storage information. Required.""" + recordingStartTime: Required[datetime.datetime] + """The time at which the recording started. Required.""" + recordingDurationMs: int + """The recording duration in milliseconds.""" + recordingContentType: Required[AcsRecordingContentType] + """The recording content type- AudioVideo, or Audio. Required. Known values are: \"AudioVideo\" + and \"Audio\".""" + recordingChannelType: Required[AcsRecordingChannelType] + """The recording channel type - Mixed, Unmixed. Required. Known values are: \"Mixed\" and + \"Unmixed\".""" + recordingFormatType: Required[AcsRecordingFormatType] + """The recording format type - Mp4, Mp3, Wav. Required. Known values are: \"Wav\", \"Mp3\", and + \"Mp4\".""" + sessionEndReason: str + """The reason for ending recording session.""" + + +class AcsRecordingStorageInfoProperties(TypedDict, total=False): + """Schema for all properties of Recording Storage Information. + + :ivar recording_chunks: List of details of recording chunks information. Required. + :vartype recording_chunks: list[~azure.eventgrid.types.AcsRecordingChunkInfoProperties] + """ + + recordingChunks: Required[list["AcsRecordingChunkInfoProperties"]] + """List of details of recording chunks information. Required.""" + + +class AcsRouterChannelConfiguration(TypedDict, total=False): + """Router Channel Configuration. + + :ivar channel_id: Channel ID for Router Job. + :vartype channel_id: str + :ivar capacity_cost_per_job: Capacity Cost Per Job for Router Job. + :vartype capacity_cost_per_job: int + :ivar max_number_of_jobs: Max Number of Jobs for Router Job. + :vartype max_number_of_jobs: int + """ + + channelId: str + """Channel ID for Router Job.""" + capacityCostPerJob: int + """Capacity Cost Per Job for Router Job.""" + maxNumberOfJobs: int + """Max Number of Jobs for Router Job.""" + + +class AcsRouterCommunicationError(TypedDict, total=False): + """Router Communication Error. + + :ivar code: Router Communication Error Code. + :vartype code: str + :ivar message: Router Communication Error Message. + :vartype message: str + :ivar target: Router Communication Error Target. + :vartype target: str + :ivar innererror: Router Communication Inner Error. Required. + :vartype innererror: ~azure.eventgrid.types.AcsRouterCommunicationError + :ivar details: List of Router Communication Errors. Required. + :vartype details: list[~azure.eventgrid.types.AcsRouterCommunicationError] + """ + + code: str + """Router Communication Error Code.""" + message: str + """Router Communication Error Message.""" + target: str + """Router Communication Error Target.""" + innererror: Required["AcsRouterCommunicationError"] + """Router Communication Inner Error. Required.""" + details: Required[list["AcsRouterCommunicationError"]] + """List of Router Communication Errors. Required.""" + + +class AcsRouterEventData(TypedDict, total=False): + """Schema of common properties of all Router events. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + """ + + jobId: Required[str] + """Router Event Job ID. Required.""" + channelReference: str + """Router Event Channel Reference.""" + channelId: str + """Router Event Channel ID.""" + + +class AcsRouterJobEventData(AcsRouterEventData): + """Schema of common properties of all Router Job events. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + """ + + queueId: str + """Router Job events Queue Id.""" + labels: Required[dict[str, str]] + """Router Job events Labels. Required.""" + tags: Required[dict[str, str]] + """Router Jobs events Tags. Required.""" + + +class AcsRouterJobCancelledEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobCancelled event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar note: Router Job Note. + :vartype note: str + :ivar disposition_code: Router Job Disposition Code. + :vartype disposition_code: str + """ + + note: str + """Router Job Note.""" + dispositionCode: str + """Router Job Disposition Code.""" + + +class AcsRouterJobClassificationFailedEventData(AcsRouterJobEventData): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobClassificationFailed event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar classification_policy_id: Router Job Classification Policy Id. + :vartype classification_policy_id: str + :ivar errors: Router Job Classification Failed Errors. Required. + :vartype errors: list[~azure.eventgrid.types.AcsRouterCommunicationError] + """ + + classificationPolicyId: str + """Router Job Classification Policy Id.""" + errors: Required[list["AcsRouterCommunicationError"]] + """Router Job Classification Failed Errors. Required.""" + + +class AcsRouterJobClassifiedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobClassified event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar queue_details: Router Job Queue Info. Required. + :vartype queue_details: ~azure.eventgrid.types.AcsRouterQueueDetails + :ivar classification_policy_id: Router Job Classification Policy Id. + :vartype classification_policy_id: str + :ivar priority: Router Job Priority. + :vartype priority: int + :ivar attached_worker_selectors: Router Job Attached Worker Selector. Required. + :vartype attached_worker_selectors: list[~azure.eventgrid.types.AcsRouterWorkerSelector] + """ + + queueDetails: Required["AcsRouterQueueDetails"] + """Router Job Queue Info. Required.""" + classificationPolicyId: str + """Router Job Classification Policy Id.""" + priority: int + """Router Job Priority.""" + attachedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Attached Worker Selector. Required.""" + + +class AcsRouterJobClosedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobClosed + event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar assignment_id: Router Job Closed Assignment Id. + :vartype assignment_id: str + :ivar worker_id: Router Job Closed Worker Id. + :vartype worker_id: str + :ivar disposition_code: Router Job Closed Disposition Code. + :vartype disposition_code: str + """ + + assignmentId: str + """Router Job Closed Assignment Id.""" + workerId: str + """Router Job Closed Worker Id.""" + dispositionCode: str + """Router Job Closed Disposition Code.""" + + +class AcsRouterJobCompletedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobCompleted event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar assignment_id: Router Job Completed Assignment Id. + :vartype assignment_id: str + :ivar worker_id: Router Job Completed Worker Id. + :vartype worker_id: str + """ + + assignmentId: str + """Router Job Completed Assignment Id.""" + workerId: str + """Router Job Completed Worker Id.""" + + +class AcsRouterJobDeletedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobDeleted + event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + """ + + +class AcsRouterJobExceptionTriggeredEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobExceptionTriggered event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar rule_key: Router Job Exception Triggered Rule Key. + :vartype rule_key: str + :ivar exception_rule_id: Router Job Exception Triggered Rule Id. + :vartype exception_rule_id: str + """ + + ruleKey: str + """Router Job Exception Triggered Rule Key.""" + exceptionRuleId: str + """Router Job Exception Triggered Rule Id.""" + + +class AcsRouterJobQueuedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.Communication.RouterJobQueued + event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar priority: Router Job Priority. Required. + :vartype priority: int + :ivar attached_worker_selectors: Router Job Queued Attached Worker Selector. Required. + :vartype attached_worker_selectors: list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar requested_worker_selectors: Router Job Queued Requested Worker Selector. Required. + :vartype requested_worker_selectors: list[~azure.eventgrid.types.AcsRouterWorkerSelector] + """ + + priority: Required[int] + """Router Job Priority. Required.""" + attachedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Queued Attached Worker Selector. Required.""" + requestedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Queued Requested Worker Selector. Required.""" + + +class AcsRouterJobReceivedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobReceived event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar job_status: Router Job Received Job Status. Required. Known values are: + "PendingClassification", "Queued", "Assigned", "Completed", "Closed", "Cancelled", + "ClassificationFailed", "Created", "PendingSchedule", "Scheduled", "ScheduleFailed", and + "WaitingForActivation". + :vartype job_status: str or ~azure.eventgrid.models.AcsRouterJobStatus + :ivar classification_policy_id: Router Job Classification Policy Id. + :vartype classification_policy_id: str + :ivar priority: Router Job Priority. + :vartype priority: int + :ivar requested_worker_selectors: Router Job Received Requested Worker Selectors. Required. + :vartype requested_worker_selectors: list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar scheduled_on: Router Job Received Scheduled Time in UTC. Required. + :vartype scheduled_on: ~datetime.datetime + :ivar unavailable_for_matching: Unavailable For Matching for Router Job Received. Required. + :vartype unavailable_for_matching: bool + """ + + jobStatus: Required[AcsRouterJobStatus] + """Router Job Received Job Status. Required. Known values are: \"PendingClassification\", + \"Queued\", \"Assigned\", \"Completed\", \"Closed\", \"Cancelled\", \"ClassificationFailed\", + \"Created\", \"PendingSchedule\", \"Scheduled\", \"ScheduleFailed\", and + \"WaitingForActivation\".""" + classificationPolicyId: str + """Router Job Classification Policy Id.""" + priority: int + """Router Job Priority.""" + requestedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Received Requested Worker Selectors. Required.""" + scheduledOn: Required[datetime.datetime] + """Router Job Received Scheduled Time in UTC. Required.""" + unavailableForMatching: Required[bool] + """Unavailable For Matching for Router Job Received. Required.""" + + +class AcsRouterJobSchedulingFailedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobSchedulingFailed event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar priority: Router Job Priority. Required. + :vartype priority: int + :ivar expired_attached_worker_selectors: Router Job Scheduling Failed Attached Worker Selector + Expired. Required. + :vartype expired_attached_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar expired_requested_worker_selectors: Router Job Scheduling Failed Requested Worker + Selector Expired. Required. + :vartype expired_requested_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar scheduled_on: Router Job Scheduling Failed Scheduled Time in UTC. Required. + :vartype scheduled_on: ~datetime.datetime + :ivar failure_reason: Router Job Scheduling Failed Reason. + :vartype failure_reason: str + """ + + priority: Required[int] + """Router Job Priority. Required.""" + expiredAttachedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Scheduling Failed Attached Worker Selector Expired. Required.""" + expiredRequestedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Scheduling Failed Requested Worker Selector Expired. Required.""" + scheduledOn: Required[datetime.datetime] + """Router Job Scheduling Failed Scheduled Time in UTC. Required.""" + failureReason: str + """Router Job Scheduling Failed Reason.""" + + +class AcsRouterJobUnassignedEventData(AcsRouterJobEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobUnassigned event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar assignment_id: Router Job Unassigned Assignment Id. + :vartype assignment_id: str + :ivar worker_id: Router Job Unassigned Worker Id. + :vartype worker_id: str + """ + + assignmentId: str + """Router Job Unassigned Assignment Id.""" + workerId: str + """Router Job Unassigned Worker Id.""" + + +class AcsRouterJobWaitingForActivationEventData(AcsRouterJobEventData): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobWaitingForActivation event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar priority: Router Job Waiting For Activation Priority. Required. + :vartype priority: int + :ivar expired_attached_worker_selectors: Router Job Waiting For Activation Worker Selector + Expired. Required. + :vartype expired_attached_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar expired_requested_worker_selectors: Router Job Waiting For Activation Requested Worker + Selector Expired. Required. + :vartype expired_requested_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar scheduled_on: Router Job Waiting For Activation Scheduled Time in UTC. Required. + :vartype scheduled_on: ~datetime.datetime + :ivar unavailable_for_matching: Router Job Waiting For Activation Unavailable For Matching. + Required. + :vartype unavailable_for_matching: bool + """ + + priority: Required[int] + """Router Job Waiting For Activation Priority. Required.""" + expiredAttachedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Waiting For Activation Worker Selector Expired. Required.""" + expiredRequestedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Waiting For Activation Requested Worker Selector Expired. Required.""" + scheduledOn: Required[datetime.datetime] + """Router Job Waiting For Activation Scheduled Time in UTC. Required.""" + unavailableForMatching: Required[bool] + """Router Job Waiting For Activation Unavailable For Matching. Required.""" + + +class AcsRouterJobWorkerSelectorsExpiredEventData(AcsRouterJobEventData): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterJobWorkerSelectorsExpired event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar queue_id: Router Job events Queue Id. + :vartype queue_id: str + :ivar labels: Router Job events Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Jobs events Tags. Required. + :vartype tags: dict[str, str] + :ivar expired_requested_worker_selectors: Router Job Worker Selectors Expired Requested Worker + Selectors. Required. + :vartype expired_requested_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + :ivar expired_attached_worker_selectors: Router Job Worker Selectors Expired Attached Worker + Selectors. Required. + :vartype expired_attached_worker_selectors: + list[~azure.eventgrid.types.AcsRouterWorkerSelector] + """ + + expiredRequestedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Worker Selectors Expired Requested Worker Selectors. Required.""" + expiredAttachedWorkerSelectors: Required[list["AcsRouterWorkerSelector"]] + """Router Job Worker Selectors Expired Attached Worker Selectors. Required.""" + + +class AcsRouterQueueDetails(TypedDict, total=False): + """Router Queue Details. + + :ivar id: Router Queue Id. + :vartype id: str + :ivar name: Router Queue Name. + :vartype name: str + :ivar labels: Router Queue Labels. Required. + :vartype labels: dict[str, str] + """ + + id: str + """Router Queue Id.""" + name: str + """Router Queue Name.""" + labels: Required[dict[str, str]] + """Router Queue Labels. Required.""" + + +class AcsRouterWorkerEventData(AcsRouterEventData): + """Schema of common properties of all Router Worker events. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + """ + + workerId: str + """Router Worker events Worker Id.""" + + +class AcsRouterWorkerDeletedEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerDeleted event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + """ + + +class AcsRouterWorkerDeregisteredEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerDeregistered event. + + :ivar worker_id: Router Worker Deregistered Worker Id. + :vartype worker_id: str + """ + + workerId: str + """Router Worker Deregistered Worker Id.""" + + +class AcsRouterWorkerOfferAcceptedEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerOfferAccepted event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + :ivar queue_id: Router Worker Offer Accepted Queue Id. + :vartype queue_id: str + :ivar offer_id: Router Worker Offer Accepted Offer Id. + :vartype offer_id: str + :ivar assignment_id: Router Worker Offer Accepted Assignment Id. + :vartype assignment_id: str + :ivar job_priority: Router Worker Offer Accepted Job Priority. + :vartype job_priority: int + :ivar worker_labels: Router Worker Offer Accepted Worker Labels. Required. + :vartype worker_labels: dict[str, str] + :ivar worker_tags: Router Worker Offer Accepted Worker Tags. Required. + :vartype worker_tags: dict[str, str] + :ivar job_labels: Router Worker Offer Accepted Job Labels. Required. + :vartype job_labels: dict[str, str] + :ivar job_tags: Router Worker Offer Accepted Job Tags. Required. + :vartype job_tags: dict[str, str] + """ + + queueId: str + """Router Worker Offer Accepted Queue Id.""" + offerId: str + """Router Worker Offer Accepted Offer Id.""" + assignmentId: str + """Router Worker Offer Accepted Assignment Id.""" + jobPriority: int + """Router Worker Offer Accepted Job Priority.""" + workerLabels: Required[dict[str, str]] + """Router Worker Offer Accepted Worker Labels. Required.""" + workerTags: Required[dict[str, str]] + """Router Worker Offer Accepted Worker Tags. Required.""" + jobLabels: Required[dict[str, str]] + """Router Worker Offer Accepted Job Labels. Required.""" + jobTags: Required[dict[str, str]] + """Router Worker Offer Accepted Job Tags. Required.""" + + +class AcsRouterWorkerOfferDeclinedEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerOfferDeclined event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + :ivar queue_id: Router Worker Offer Declined Queue Id. + :vartype queue_id: str + :ivar offer_id: Router Worker Offer Declined Offer Id. + :vartype offer_id: str + """ + + queueId: str + """Router Worker Offer Declined Queue Id.""" + offerId: str + """Router Worker Offer Declined Offer Id.""" + + +class AcsRouterWorkerOfferExpiredEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerOfferExpired event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + :ivar queue_id: Router Worker Offer Expired Queue Id. + :vartype queue_id: str + :ivar offer_id: Router Worker Offer Expired Offer Id. + :vartype offer_id: str + """ + + queueId: str + """Router Worker Offer Expired Queue Id.""" + offerId: str + """Router Worker Offer Expired Offer Id.""" + + +class AcsRouterWorkerOfferIssuedEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerOfferIssued event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + :ivar queue_id: Router Worker Offer Issued Queue Id. + :vartype queue_id: str + :ivar offer_id: Router Worker Offer Issued Offer Id. + :vartype offer_id: str + :ivar job_priority: Router Worker Offer Issued Job Priority. + :vartype job_priority: int + :ivar worker_labels: Router Worker Offer Issued Worker Labels. Required. + :vartype worker_labels: dict[str, str] + :ivar offered_on: Router Worker Offer Issued Time in UTC. Required. + :vartype offered_on: ~datetime.datetime + :ivar expires_on: Router Worker Offer Issued Expiration Time in UTC. Required. + :vartype expires_on: ~datetime.datetime + :ivar worker_tags: Router Worker Offer Issued Worker Tags. Required. + :vartype worker_tags: dict[str, str] + :ivar job_labels: Router Worker Offer Issued Job Labels. Required. + :vartype job_labels: dict[str, str] + :ivar job_tags: Router Worker Offer Issued Job Tags. Required. + :vartype job_tags: dict[str, str] + """ + + queueId: str + """Router Worker Offer Issued Queue Id.""" + offerId: str + """Router Worker Offer Issued Offer Id.""" + jobPriority: int + """Router Worker Offer Issued Job Priority.""" + workerLabels: Required[dict[str, str]] + """Router Worker Offer Issued Worker Labels. Required.""" + offeredOn: Required[datetime.datetime] + """Router Worker Offer Issued Time in UTC. Required.""" + expiresOn: Required[datetime.datetime] + """Router Worker Offer Issued Expiration Time in UTC. Required.""" + workerTags: Required[dict[str, str]] + """Router Worker Offer Issued Worker Tags. Required.""" + jobLabels: Required[dict[str, str]] + """Router Worker Offer Issued Job Labels. Required.""" + jobTags: Required[dict[str, str]] + """Router Worker Offer Issued Job Tags. Required.""" + + +class AcsRouterWorkerOfferRevokedEventData(AcsRouterWorkerEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerOfferRevoked event. + + :ivar job_id: Router Event Job ID. Required. + :vartype job_id: str + :ivar channel_reference: Router Event Channel Reference. + :vartype channel_reference: str + :ivar channel_id: Router Event Channel ID. + :vartype channel_id: str + :ivar worker_id: Router Worker events Worker Id. + :vartype worker_id: str + :ivar queue_id: Router Worker Offer Revoked Queue Id. + :vartype queue_id: str + :ivar offer_id: Router Worker Offer Revoked Offer Id. + :vartype offer_id: str + """ + + queueId: str + """Router Worker Offer Revoked Queue Id.""" + offerId: str + """Router Worker Offer Revoked Offer Id.""" + + +class AcsRouterWorkerRegisteredEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerRegistered event. + + :ivar worker_id: Router Worker Registered Worker Id. + :vartype worker_id: str + :ivar queue_assignments: Router Worker Registered Queue Info. Required. + :vartype queue_assignments: list[~azure.eventgrid.types.AcsRouterQueueDetails] + :ivar channel_configurations: Router Worker Registered Channel Configuration. Required. + :vartype channel_configurations: list[~azure.eventgrid.types.AcsRouterChannelConfiguration] + :ivar total_capacity: Router Worker Register Total Capacity. + :vartype total_capacity: int + :ivar labels: Router Worker Registered Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Worker Registered Tags. Required. + :vartype tags: dict[str, str] + """ + + workerId: str + """Router Worker Registered Worker Id.""" + queueAssignments: Required[list["AcsRouterQueueDetails"]] + """Router Worker Registered Queue Info. Required.""" + channelConfigurations: Required[list["AcsRouterChannelConfiguration"]] + """Router Worker Registered Channel Configuration. Required.""" + totalCapacity: int + """Router Worker Register Total Capacity.""" + labels: Required[dict[str, str]] + """Router Worker Registered Labels. Required.""" + tags: Required[dict[str, str]] + """Router Worker Registered Tags. Required.""" + + +class AcsRouterWorkerSelector(TypedDict, total=False): + """Router Job Worker Selector. + + :ivar key: Router Job Worker Selector Key. + :vartype key: str + :ivar label_operator: Router Job Worker Selector Label Operator. Required. Known values are: + "Equal", "NotEqual", "Greater", "Less", "GreaterThanOrEqual", and "LessThanOrEqual". + :vartype label_operator: str or ~azure.eventgrid.models.AcsRouterLabelOperator + :ivar label_value: Router Job Worker Selector Value. Required. + :vartype label_value: any + :ivar ttl_seconds: Router Job Worker Selector Time to Live in Seconds. Required. + :vartype ttl_seconds: float + :ivar state: Router Job Worker Selector State. Required. Known values are: "active" and + "expired". + :vartype state: str or ~azure.eventgrid.models.AcsRouterWorkerSelectorState + :ivar expiration_time: Router Job Worker Selector Expiration Time. Required. + :vartype expiration_time: ~datetime.datetime + """ + + key: str + """Router Job Worker Selector Key.""" + labelOperator: Required[AcsRouterLabelOperator] + """Router Job Worker Selector Label Operator. Required. Known values are: \"Equal\", \"NotEqual\", + \"Greater\", \"Less\", \"GreaterThanOrEqual\", and \"LessThanOrEqual\".""" + value: Required[Any] + """Router Job Worker Selector Value. Required.""" + ttlSeconds: Required[float] + """Router Job Worker Selector Time to Live in Seconds. Required.""" + state: Required[AcsRouterWorkerSelectorState] + """Router Job Worker Selector State. Required. Known values are: \"active\" and \"expired\".""" + expirationTime: Required[datetime.datetime] + """Router Job Worker Selector Expiration Time. Required.""" + + +class AcsRouterWorkerUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Communication.RouterWorkerUpdated event. + + :ivar worker_id: Router Worker Updated Worker Id. + :vartype worker_id: str + :ivar queue_assignments: Router Worker Updated Queue Info. Required. + :vartype queue_assignments: list[~azure.eventgrid.types.AcsRouterQueueDetails] + :ivar channel_configurations: Router Worker Updated Channel Configuration. Required. + :vartype channel_configurations: list[~azure.eventgrid.types.AcsRouterChannelConfiguration] + :ivar total_capacity: Router Worker Updated Total Capacity. + :vartype total_capacity: int + :ivar labels: Router Worker Updated Labels. Required. + :vartype labels: dict[str, str] + :ivar tags: Router Worker Updated Tags. Required. + :vartype tags: dict[str, str] + :ivar updated_worker_properties: Router Worker Properties Updated. Required. + :vartype updated_worker_properties: list[str or + ~azure.eventgrid.models.AcsRouterUpdatedWorkerProperty] + """ + + workerId: str + """Router Worker Updated Worker Id.""" + queueAssignments: Required[list["AcsRouterQueueDetails"]] + """Router Worker Updated Queue Info. Required.""" + channelConfigurations: Required[list["AcsRouterChannelConfiguration"]] + """Router Worker Updated Channel Configuration. Required.""" + totalCapacity: int + """Router Worker Updated Total Capacity.""" + labels: Required[dict[str, str]] + """Router Worker Updated Labels. Required.""" + tags: Required[dict[str, str]] + """Router Worker Updated Tags. Required.""" + updatedWorkerProperties: Required[list[AcsRouterUpdatedWorkerProperty]] + """Router Worker Properties Updated. Required.""" + + +class AcsSmsDeliveryAttemptProperties(TypedDict, total=False): + """Schema for details of a delivery attempt. + + :ivar timestamp: TimeStamp when delivery was attempted. Required. + :vartype timestamp: ~datetime.datetime + :ivar segments_succeeded: Number of segments that were successfully delivered. Required. + :vartype segments_succeeded: int + :ivar segments_failed: Number of segments whose delivery failed. Required. + :vartype segments_failed: int + """ + + timestamp: Required[datetime.datetime] + """TimeStamp when delivery was attempted. Required.""" + segmentsSucceeded: Required[int] + """Number of segments that were successfully delivered. Required.""" + segmentsFailed: Required[int] + """Number of segments whose delivery failed. Required.""" + + +AcsSmsEventBaseProperties = TypedDict( + "AcsSmsEventBaseProperties", + { + "messageId": Required[str], + "from": Required[str], + "to": Required[str], + }, + total=False, +) +"""Schema of common properties of all SMS events. + +:ivar message_id: The identity of the SMS message. Required. +:vartype message_id: str +:ivar from_property: The identity of SMS message sender. Required. +:vartype from_property: str +:ivar to: The identity of SMS message receiver. Required. +:vartype to: str +""" + + +AcsSmsDeliveryReportReceivedEventData = TypedDict( + "AcsSmsDeliveryReportReceivedEventData", + { + "messageId": Required[str], + "from": Required[str], + "to": Required[str], + "deliveryStatus": Required[str], + "deliveryStatusDetails": Required[str], + "deliveryAttempts": Required[list["AcsSmsDeliveryAttemptProperties"]], + "receivedTimestamp": Required[datetime.datetime], + "tag": str, + }, + total=False, +) +"""Schema of the Data property of an EventGridEvent for a +Microsoft.Communication.SMSDeliveryReportReceived event. + +:ivar message_id: The identity of the SMS message. Required. +:vartype message_id: str +:ivar from_property: The identity of SMS message sender. Required. +:vartype from_property: str +:ivar to: The identity of SMS message receiver. Required. +:vartype to: str +:ivar delivery_status: Status of Delivery. Required. +:vartype delivery_status: str +:ivar delivery_status_details: Details about Delivery Status. Required. +:vartype delivery_status_details: str +:ivar delivery_attempts: List of details of delivery attempts made. Required. +:vartype delivery_attempts: list[~azure.eventgrid.types.AcsSmsDeliveryAttemptProperties] +:ivar received_timestamp: The time at which the SMS delivery report was received. Required. +:vartype received_timestamp: ~datetime.datetime +:ivar tag: Customer Content. +:vartype tag: str +""" + + +AcsSmsReceivedEventData = TypedDict( + "AcsSmsReceivedEventData", + { + "messageId": Required[str], + "from": Required[str], + "to": Required[str], + "message": Required[str], + "receivedTimestamp": Required[datetime.datetime], + "segmentCount": Required[int], + }, + total=False, +) +"""Schema of the Data property of an EventGridEvent for a Microsoft.Communication.SMSReceived +event. + +:ivar message_id: The identity of the SMS message. Required. +:vartype message_id: str +:ivar from_property: The identity of SMS message sender. Required. +:vartype from_property: str +:ivar to: The identity of SMS message receiver. Required. +:vartype to: str +:ivar message: The SMS content. Required. +:vartype message: str +:ivar received_timestamp: The time at which the SMS was received. Required. +:vartype received_timestamp: ~datetime.datetime +:ivar segment_count: Number of segments in the message. Required. +:vartype segment_count: int +""" + + +class AcsUserDisconnectedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for an + Microsoft.Communication.UserDisconnected event. + + :ivar user_communication_identifier: The communication identifier of the user who was + disconnected. Required. + :vartype user_communication_identifier: ~azure.eventgrid.types.CommunicationIdentifierModel + """ + + userCommunicationIdentifier: Required["CommunicationIdentifierModel"] + """The communication identifier of the user who was disconnected. Required.""" + + +class ApiCenterApiDefinitionAddedEventData(TypedDict, total=False): + """Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionAdded + event. + + :ivar title: API definition title. Required. + :vartype title: str + :ivar description: API definition description. + :vartype description: str + :ivar specification: API definition specification. + :vartype specification: ~azure.eventgrid.types.ApiCenterApiSpecification + """ + + title: Required[str] + """API definition title. Required.""" + description: str + """API definition description.""" + specification: "ApiCenterApiSpecification" + """API definition specification.""" + + +class ApiCenterApiDefinitionUpdatedEventData(TypedDict, total=False): + """Schema of the data property of an EventGridEvent for a Microsoft.ApiCenter.ApiDefinitionUpdated + event. + + :ivar title: API definition title. Required. + :vartype title: str + :ivar description: API definition description. + :vartype description: str + :ivar specification: API definition specification. + :vartype specification: ~azure.eventgrid.types.ApiCenterApiSpecification + """ + + title: Required[str] + """API definition title. Required.""" + description: str + """API definition description.""" + specification: "ApiCenterApiSpecification" + """API definition specification.""" + + +class ApiCenterApiSpecification(TypedDict, total=False): + """API specification details. + + :ivar name: Specification name. Required. + :vartype name: str + :ivar version: Specification version. + :vartype version: str + """ + + name: Required[str] + """Specification name. Required.""" + version: str + """Specification version.""" + + +class ApiManagementApiCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementApiDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementApiReleaseCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.APIReleaseCreated event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementApiReleaseDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.APIReleaseDeleted event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementApiReleaseUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.APIReleaseUpdated event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementApiUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementCircuitBreakerClosedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.CircuitBreaker.Closed event. + + :ivar backend_name: Name of the backend for which the circuit has closed. Required. + :vartype backend_name: str + :ivar circuit_breaker: Information related to the circuit breaker configured on the backend. + Required. + :vartype circuit_breaker: ~azure.eventgrid.types.ApiManagementCircuitBreakerProperties + """ + + backendName: Required[str] + """Name of the backend for which the circuit has closed. Required.""" + circuitBreaker: Required["ApiManagementCircuitBreakerProperties"] + """Information related to the circuit breaker configured on the backend. Required.""" + + +class ApiManagementCircuitBreakerOpenedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.CircuitBreaker.Opened event. + + :ivar backend_name: Name of the backend for which the circuit has opened. Required. + :vartype backend_name: str + :ivar circuit_breaker: Information related to the circuit breaker configured on the backend. + Required. + :vartype circuit_breaker: ~azure.eventgrid.types.ApiManagementCircuitBreakerProperties + """ + + backendName: Required[str] + """Name of the backend for which the circuit has opened. Required.""" + circuitBreaker: Required["ApiManagementCircuitBreakerProperties"] + """Information related to the circuit breaker configured on the backend. Required.""" + + +class ApiManagementCircuitBreakerProperties(TypedDict, total=False): + """Information related to the circuit breaker configured on the backend. + + :ivar rules: Overview of all configured rules and respective details. Required. + :vartype rules: dict[str, dict[str, any]] + """ + + rules: Required[dict[str, dict[str, Any]]] + """Overview of all configured rules and respective details. Required.""" + + +class ApiManagementExpiredGatewayTokenProperties(TypedDict, total=False): # pylint: disable=name-too-long + """Information related to a gateway token that has expired for a self-hosted gateway deployment. + + :ivar expires_on: Timestamp when the gateway token has expired. Required. + :vartype expires_on: ~datetime.datetime + """ + + expiredAtUtc: Required[datetime.datetime] + """Timestamp when the gateway token has expired. Required.""" + + +class ApiManagementGatewayApiAddedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayAPIAdded + event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayApiRemovedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayAPIRemoved event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayCertificateAuthorityCreatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayCertificateAuthorityCreated event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayCertificateAuthorityDeletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayCertificateAuthorityUpdatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayCreated + event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayDeleted + event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayHostnameConfigurationCreatedEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayHostnameConfigurationCreated event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayHostnameConfigurationDeletedEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayHostnameConfigurationUpdatedEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementGatewayProperties(TypedDict, total=False): + """Information related to a given self-hosted gateway deployment. + + :ivar gateway_id: 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/``. + Required. + :vartype gateway_id: str + :ivar instance_id: Unique instance ID of the deployed gateway. Required. + :vartype instance_id: str + """ + + gatewayId: Required[str] + """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/``. + Required.""" + instanceId: Required[str] + """Unique instance ID of the deployed gateway. Required.""" + + +class ApiManagementGatewayTokenExpiredEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayTokenExpired event. + + :ivar gateway: Information related to a given self-hosted gateway deployment. Required. + :vartype gateway: ~azure.eventgrid.types.ApiManagementGatewayProperties + :ivar token: Information related to a an expired gateway token for a self-hosted gateway + deployment. Required. + :vartype token: ~azure.eventgrid.types.ApiManagementExpiredGatewayTokenProperties + """ + + gatewayInfo: Required["ApiManagementGatewayProperties"] + """Information related to a given self-hosted gateway deployment. Required.""" + tokenInfo: Required["ApiManagementExpiredGatewayTokenProperties"] + """Information related to a an expired gateway token for a self-hosted gateway deployment. + Required.""" + + +class ApiManagementGatewayTokenNearExpiryEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.GatewayTokenNearExpiry event. + + :ivar gateway: Information related to a given self-hosted gateway deployment. Required. + :vartype gateway: ~azure.eventgrid.types.ApiManagementGatewayProperties + :ivar token: Information related to a an expired gateway token for a self-hosted gateway + deployment. Required. + :vartype token: ~azure.eventgrid.types.ApiManagementNearExpiryGatewayTokenProperties + """ + + gatewayInfo: Required["ApiManagementGatewayProperties"] + """Information related to a given self-hosted gateway deployment. Required.""" + tokenInfo: Required["ApiManagementNearExpiryGatewayTokenProperties"] + """Information related to a an expired gateway token for a self-hosted gateway deployment. + Required.""" + + +class ApiManagementGatewayUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.GatewayUpdated + event. + + :ivar resource_url: 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/``. + :vartype resource_url: str + """ + + resourceUri: str + """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/``.""" + + +class ApiManagementNearExpiryGatewayTokenProperties(TypedDict, total=False): # pylint: disable=name-too-long + """Information related to a gateway token that is near expiry for a self-hosted gateway + deployment. + + :ivar expires_on: Timestamp when the gateway token will expire. Required. + :vartype expires_on: ~datetime.datetime + """ + + expiredAtUtc: Required[datetime.datetime] + """Timestamp when the gateway token will expire. Required.""" + + +class ApiManagementProductCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementProductDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementProductUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementSubscriptionCreatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.SubscriptionCreated event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementSubscriptionDeletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.SubscriptionDeleted event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementSubscriptionUpdatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ApiManagement.SubscriptionUpdated event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementUserCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementUserDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class ApiManagementUserUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated + event. + + :ivar resource_url: 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///``. + :vartype resource_url: str + """ + + resourceUri: str + """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///``.""" + + +class AppConfigurationKeyValueDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.AppConfiguration.KeyValueDeleted event. + + :ivar key: The key used to identify the key-value that was deleted. Required. + :vartype key: str + :ivar label: The label, if any, used to identify the key-value that was deleted. Required. + :vartype label: str + :ivar etag: The etag representing the key-value that was deleted. Required. + :vartype etag: str + :ivar sync_token: The sync token representing the server state after the event. Required. + :vartype sync_token: str + """ + + key: Required[str] + """The key used to identify the key-value that was deleted. Required.""" + label: Required[str] + """The label, if any, used to identify the key-value that was deleted. Required.""" + etag: Required[str] + """The etag representing the key-value that was deleted. Required.""" + syncToken: Required[str] + """The sync token representing the server state after the event. Required.""" + + +class AppConfigurationKeyValueModifiedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.AppConfiguration.KeyValueModified event. + + :ivar key: The key used to identify the key-value that was modified. Required. + :vartype key: str + :ivar label: The label, if any, used to identify the key-value that was modified. Required. + :vartype label: str + :ivar etag: The etag representing the new state of the key-value. Required. + :vartype etag: str + :ivar sync_token: The sync token representing the server state after the event. Required. + :vartype sync_token: str + """ + + key: Required[str] + """The key used to identify the key-value that was modified. Required.""" + label: Required[Optional[str]] + """The label, if any, used to identify the key-value that was modified. Required.""" + etag: Required[str] + """The etag representing the new state of the key-value. Required.""" + syncToken: Required[str] + """The sync token representing the server state after the event. Required.""" + + +class AppConfigurationSnapshotEventData(TypedDict, total=False): + """Schema of common properties of snapshot events. + + :ivar name: The name of the snapshot. Required. + :vartype name: str + :ivar etag: The etag representing the new state of the snapshot. Required. + :vartype etag: str + :ivar sync_token: The sync token representing the server state after the event. Required. + :vartype sync_token: str + """ + + name: Required[str] + """The name of the snapshot. Required.""" + etag: Required[str] + """The etag representing the new state of the snapshot. Required.""" + syncToken: Required[str] + """The sync token representing the server state after the event. Required.""" + + +class AppConfigurationSnapshotCreatedEventData(AppConfigurationSnapshotEventData): + """Schema of the Data property of an EventGridEvent for a + Microsoft.AppConfiguration.SnapshotCreated event. + + :ivar name: The name of the snapshot. Required. + :vartype name: str + :ivar etag: The etag representing the new state of the snapshot. Required. + :vartype etag: str + :ivar sync_token: The sync token representing the server state after the event. Required. + :vartype sync_token: str + """ + + +class AppConfigurationSnapshotModifiedEventData(AppConfigurationSnapshotEventData): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.AppConfiguration.SnapshotModified event. + + :ivar name: The name of the snapshot. Required. + :vartype name: str + :ivar etag: The etag representing the new state of the snapshot. Required. + :vartype etag: str + :ivar sync_token: The sync token representing the server state after the event. Required. + :vartype sync_token: str + """ + + +class AppEventTypeDetail(TypedDict, total=False): + """Detail of action on the app. + + :ivar action: Type of action of the operation. Known values are: "Restarted", "Stopped", + "ChangedAppSettings", "Started", "Completed", and "Failed". + :vartype action: str or ~azure.eventgrid.models.AppAction + """ + + action: AppAction + """Type of action of the operation. Known values are: \"Restarted\", \"Stopped\", + \"ChangedAppSettings\", \"Started\", \"Completed\", and \"Failed\".""" + + +class AppServicePlanEventTypeDetail(TypedDict, total=False): + """Detail of action on the app service plan. + + :ivar stamp_kind: Kind of environment where app service plan is. Known values are: "Public", + "AseV1", and "AseV2". + :vartype stamp_kind: str or ~azure.eventgrid.models.StampKind + :ivar action: Type of action on the app service plan. "Updated" + :vartype action: str or ~azure.eventgrid.models.AppServicePlanAction + :ivar status: Asynchronous operation status of the operation on the app service plan. Known + values are: "Started", "Completed", and "Failed". + :vartype status: str or ~azure.eventgrid.models.AsyncStatus + """ + + stampKind: StampKind + """Kind of environment where app service plan is. Known values are: \"Public\", \"AseV1\", and + \"AseV2\".""" + action: AppServicePlanAction + """Type of action on the app service plan. \"Updated\"""" + status: AsyncStatus + """Asynchronous operation status of the operation on the app service plan. Known values are: + \"Started\", \"Completed\", and \"Failed\".""" + + +class AvsClusterEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for Microsoft.AVS/clusters events. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + """ + + operationId: Required[str] + """Id of the operation that caused this event. Required.""" + addedHostNames: list[str] + """Hosts added to the cluster in this event, if any.""" + removedHostNames: list[str] + """Hosts removed from the cluster in this event, if any.""" + inMaintenanceHostNames: list[str] + """Hosts in Maintenance mode in the cluster, if any.""" + + +class AvsClusterCreatedEventData(AvsClusterEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterCreated event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + """ + + +class AvsClusterDeletedEventData(AvsClusterEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterDeleted event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + """ + + +class AvsClusterFailedEventData(AvsClusterEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterFailed event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + :ivar failure_message: Failure reason of an event. + :vartype failure_message: str + """ + + failureMessage: str + """Failure reason of an event.""" + + +class AvsClusterUpdatedEventData(AvsClusterEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdated event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + """ + + +class AvsClusterUpdatingEventData(AvsClusterEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ClusterUpdating event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar added_host_names: Hosts added to the cluster in this event, if any. + :vartype added_host_names: list[str] + :ivar removed_host_names: Hosts removed from the cluster in this event, if any. + :vartype removed_host_names: list[str] + :ivar in_maintenance_host_names: Hosts in Maintenance mode in the cluster, if any. + :vartype in_maintenance_host_names: list[str] + """ + + +class AvsPrivateCloudEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for Microsoft.AVS/privateClouds events. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + """ + + operationId: Required[str] + """Id of the operation that caused this event. Required.""" + + +class AvsPrivateCloudFailedEventData(AvsPrivateCloudEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudFailed event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar failure_message: Failure reason of an event. + :vartype failure_message: str + """ + + failureMessage: str + """Failure reason of an event.""" + + +class AvsPrivateCloudUpdatedEventData(AvsPrivateCloudEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdated event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + """ + + +class AvsPrivateCloudUpdatingEventData(AvsPrivateCloudEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.PrivateCloudUpdating + event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + """ + + +class AvsScriptExecutionEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for Microsoft.AVS/scriptExecutions events. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar cmdlet_id: Cmdlet referenced in the execution that caused this event. Required. + :vartype cmdlet_id: str + :ivar output: Stdout outputs from the execution, if any. + :vartype output: list[str] + """ + + operationId: Required[str] + """Id of the operation that caused this event. Required.""" + cmdletId: Required[str] + """Cmdlet referenced in the execution that caused this event. Required.""" + output: list[str] + """Stdout outputs from the execution, if any.""" + + +class AvsScriptExecutionCancelledEventData(AvsScriptExecutionEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionCancelled + event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar cmdlet_id: Cmdlet referenced in the execution that caused this event. Required. + :vartype cmdlet_id: str + :ivar output: Stdout outputs from the execution, if any. + :vartype output: list[str] + """ + + +class AvsScriptExecutionFailedEventData(AvsScriptExecutionEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFailed + event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar cmdlet_id: Cmdlet referenced in the execution that caused this event. Required. + :vartype cmdlet_id: str + :ivar output: Stdout outputs from the execution, if any. + :vartype output: list[str] + :ivar failure_message: Failure reason of an event. + :vartype failure_message: str + """ + + failureMessage: str + """Failure reason of an event.""" + + +class AvsScriptExecutionFinishedEventData(AvsScriptExecutionEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionFinished + event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar cmdlet_id: Cmdlet referenced in the execution that caused this event. Required. + :vartype cmdlet_id: str + :ivar output: Stdout outputs from the execution, if any. + :vartype output: list[str] + :ivar named_outputs: Named outputs of completed execution, if any. Required. + :vartype named_outputs: dict[str, str] + """ + + namedOutputs: Required[dict[str, str]] + """Named outputs of completed execution, if any. Required.""" + + +class AvsScriptExecutionStartedEventData(AvsScriptExecutionEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.AVS.ScriptExecutionStarted + event. + + :ivar operation_id: Id of the operation that caused this event. Required. + :vartype operation_id: str + :ivar cmdlet_id: Cmdlet referenced in the execution that caused this event. Required. + :vartype cmdlet_id: str + :ivar output: Stdout outputs from the execution, if any. + :vartype output: list[str] + """ + + +class CommunicationIdentifierModel(TypedDict, total=False): + """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. + + :ivar kind: The identifier kind. Only required in responses. Known values are: "unknown", + "communicationUser", "phoneNumber", "microsoftTeamsUser", and "microsoftTeamsApp". + :vartype kind: str or ~azure.eventgrid.models.CommunicationIdentifierModelKind + :ivar raw_id: Raw Id of the identifier. Optional in requests, required in responses. Required. + :vartype raw_id: str + :ivar communication_user: The communication user. Required. + :vartype communication_user: ~azure.eventgrid.types.CommunicationUserIdentifierModel + :ivar phone_number: The phone number. + :vartype phone_number: ~azure.eventgrid.types.PhoneNumberIdentifierModel + :ivar microsoft_teams_user: The Microsoft Teams user. + :vartype microsoft_teams_user: ~azure.eventgrid.types.MicrosoftTeamsUserIdentifierModel + :ivar microsoft_teams_app: The Microsoft Teams application. + :vartype microsoft_teams_app: ~azure.eventgrid.types.MicrosoftTeamsAppIdentifierModel + """ + + kind: CommunicationIdentifierModelKind + """The identifier kind. Only required in responses. Known values are: \"unknown\", + \"communicationUser\", \"phoneNumber\", \"microsoftTeamsUser\", and \"microsoftTeamsApp\".""" + rawId: Required[str] + """Raw Id of the identifier. Optional in requests, required in responses. Required.""" + communicationUser: Required["CommunicationUserIdentifierModel"] + """The communication user. Required.""" + phoneNumber: "PhoneNumberIdentifierModel" + """The phone number.""" + microsoftTeamsUser: "MicrosoftTeamsUserIdentifierModel" + """The Microsoft Teams user.""" + microsoftTeamsApp: "MicrosoftTeamsAppIdentifierModel" + """The Microsoft Teams application.""" + + +class CommunicationUserIdentifierModel(TypedDict, total=False): + """A user that got created with an Azure Communication Services resource. + + :ivar id: The Id of the communication user. Required. + :vartype id: str + """ + + id: Required[str] + """The Id of the communication user. Required.""" + + +class ContainerRegistryArtifactEventData(TypedDict, total=False): + """The content of the event request message. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryArtifactEventTarget + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + id: Required[str] + """The event ID. Required.""" + timestamp: Required[datetime.datetime] + """The time at which the event occurred. Required.""" + action: Required[str] + """The action that encompasses the provided event. Required.""" + location: Required[str] + """The location of the event. Required.""" + target: Required["ContainerRegistryArtifactEventTarget"] + """The target of the event. Required.""" + connectedRegistry: "ContainerRegistryEventConnectedRegistry" + """The connected registry information if the event is generated by a connected registry.""" + + +class ContainerRegistryArtifactEventTarget(TypedDict, total=False): + """The target of the event. + + :ivar media_type: The MIME type of the artifact. Required. + :vartype media_type: str + :ivar size: The size in bytes of the artifact. + :vartype size: int + :ivar digest: The digest of the artifact. + :vartype digest: str + :ivar repository: The repository name of the artifact. Required. + :vartype repository: str + :ivar tag: The tag of the artifact. + :vartype tag: str + :ivar name: The name of the artifact. + :vartype name: str + :ivar version: The version of the artifact. + :vartype version: str + """ + + mediaType: Required[str] + """The MIME type of the artifact. Required.""" + size: int + """The size in bytes of the artifact.""" + digest: str + """The digest of the artifact.""" + repository: Required[str] + """The repository name of the artifact. Required.""" + tag: str + """The tag of the artifact.""" + name: str + """The name of the artifact.""" + version: str + """The version of the artifact.""" + + +class ContainerRegistryChartDeletedEventData(ContainerRegistryArtifactEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted + event. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryArtifactEventTarget + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + +class ContainerRegistryChartPushedEventData(ContainerRegistryArtifactEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed + event. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryArtifactEventTarget + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + +class ContainerRegistryEventActor(TypedDict, total=False): + """The agent that initiated the event. For most situations, this could be from the authorization + context of the request. + + :ivar name: The subject or username associated with the request context that generated the + event. + :vartype name: str + """ + + name: str + """The subject or username associated with the request context that generated the event.""" + + +class ContainerRegistryEventConnectedRegistry(TypedDict, total=False): + """The connected registry information if the event is generated by a connected registry. + + :ivar name: The name of the connected registry that generated this event. Required. + :vartype name: str + """ + + name: Required[str] + """The name of the connected registry that generated this event. Required.""" + + +class ContainerRegistryEventData(TypedDict, total=False): + """The content of the event request message. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryEventTarget + :ivar request: The request that generated the event. + :vartype request: ~azure.eventgrid.types.ContainerRegistryEventRequest + :ivar actor: The agent that initiated the event. For most situations, this could be from the + authorization context of the request. + :vartype actor: ~azure.eventgrid.types.ContainerRegistryEventActor + :ivar source: The registry node that generated the event. Put differently, while the actor + initiates the event, the source generates it. + :vartype source: ~azure.eventgrid.types.ContainerRegistryEventSource + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + id: Required[str] + """The event ID. Required.""" + timestamp: Required[datetime.datetime] + """The time at which the event occurred. Required.""" + action: Required[str] + """The action that encompasses the provided event. Required.""" + location: Required[str] + """The location of the event. Required.""" + target: Required["ContainerRegistryEventTarget"] + """The target of the event. Required.""" + request: "ContainerRegistryEventRequest" + """The request that generated the event.""" + actor: "ContainerRegistryEventActor" + """The agent that initiated the event. For most situations, this could be from the authorization + context of the request.""" + source: "ContainerRegistryEventSource" + """The registry node that generated the event. Put differently, while the actor initiates the + event, the source generates it.""" + connectedRegistry: "ContainerRegistryEventConnectedRegistry" + """The connected registry information if the event is generated by a connected registry.""" + + +class ContainerRegistryEventRequest(TypedDict, total=False): + """The request that generated the event. + + :ivar id: The ID of the request that initiated the event. Required. + :vartype id: str + :ivar addr: The IP or hostname and possibly port of the client connection that initiated the + event. This is the RemoteAddr from the standard http request. + :vartype addr: str + :ivar host: The externally accessible hostname of the registry instance, as specified by the + http host header on incoming requests. Required. + :vartype host: str + :ivar method: The request method that generated the event. Required. + :vartype method: str + :ivar useragent: The user agent header of the request. + :vartype useragent: str + """ + + id: Required[str] + """The ID of the request that initiated the event. Required.""" + addr: str + """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: Required[str] + """The externally accessible hostname of the registry instance, as specified by the http host + header on incoming requests. Required.""" + method: Required[str] + """The request method that generated the event. Required.""" + useragent: str + """The user agent header of the request.""" + + +class ContainerRegistryEventSource(TypedDict, total=False): + """The registry node that generated the event. Put differently, while the actor initiates the + event, the source generates it. + + :ivar addr: 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. + :vartype addr: str + :ivar instance_id: The running instance of an application. Changes after each restart. + :vartype instance_id: str + """ + + addr: str + """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: str + """The running instance of an application. Changes after each restart.""" + + +class ContainerRegistryEventTarget(TypedDict, total=False): + """The target of the event. + + :ivar media_type: The MIME type of the referenced object. Required. + :vartype media_type: str + :ivar size: The number of bytes of the content. Same as Length field. + :vartype size: int + :ivar digest: The digest of the content, as defined by the Registry V2 HTTP API Specification. + :vartype digest: str + :ivar length: The number of bytes of the content. Same as Size field. + :vartype length: int + :ivar repository: The repository name. Required. + :vartype repository: str + :ivar url: The direct URL to the content. + :vartype url: str + :ivar tag: The tag name. + :vartype tag: str + """ + + mediaType: Required[str] + """The MIME type of the referenced object. Required.""" + size: int + """The number of bytes of the content. Same as Length field.""" + digest: str + """The digest of the content, as defined by the Registry V2 HTTP API Specification.""" + length: int + """The number of bytes of the content. Same as Size field.""" + repository: Required[str] + """The repository name. Required.""" + url: str + """The direct URL to the content.""" + tag: str + """The tag name.""" + + +class ContainerRegistryImageDeletedEventData(ContainerRegistryEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted + event. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryEventTarget + :ivar request: The request that generated the event. + :vartype request: ~azure.eventgrid.types.ContainerRegistryEventRequest + :ivar actor: The agent that initiated the event. For most situations, this could be from the + authorization context of the request. + :vartype actor: ~azure.eventgrid.types.ContainerRegistryEventActor + :ivar source: The registry node that generated the event. Put differently, while the actor + initiates the event, the source generates it. + :vartype source: ~azure.eventgrid.types.ContainerRegistryEventSource + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + +class ContainerRegistryImagePushedEventData(ContainerRegistryEventData): + """Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed + event. + + :ivar id: The event ID. Required. + :vartype id: str + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar action: The action that encompasses the provided event. Required. + :vartype action: str + :ivar location: The location of the event. Required. + :vartype location: str + :ivar target: The target of the event. Required. + :vartype target: ~azure.eventgrid.types.ContainerRegistryEventTarget + :ivar request: The request that generated the event. + :vartype request: ~azure.eventgrid.types.ContainerRegistryEventRequest + :ivar actor: The agent that initiated the event. For most situations, this could be from the + authorization context of the request. + :vartype actor: ~azure.eventgrid.types.ContainerRegistryEventActor + :ivar source: The registry node that generated the event. Put differently, while the actor + initiates the event, the source generates it. + :vartype source: ~azure.eventgrid.types.ContainerRegistryEventSource + :ivar connected_registry: The connected registry information if the event is generated by a + connected registry. + :vartype connected_registry: ~azure.eventgrid.types.ContainerRegistryEventConnectedRegistry + """ + + +class ContainerServiceClusterSupportEventData(TypedDict, total=False): + """Schema of common properties of cluster support events. + + :ivar kubernetes_version: The Kubernetes version of the ManagedCluster resource. Required. + :vartype kubernetes_version: str + """ + + kubernetesVersion: Required[str] + """The Kubernetes version of the ManagedCluster resource. Required.""" + + +class ContainerServiceClusterSupportEndedEventData( + ContainerServiceClusterSupportEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.ClusterSupportEnded event. + + :ivar kubernetes_version: The Kubernetes version of the ManagedCluster resource. Required. + :vartype kubernetes_version: str + """ + + +class ContainerServiceClusterSupportEndingEventData( + ContainerServiceClusterSupportEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.ClusterSupportEnding event. + + :ivar kubernetes_version: The Kubernetes version of the ManagedCluster resource. Required. + :vartype kubernetes_version: str + """ + + +class ContainerServiceNewKubernetesVersionAvailableEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.NewKubernetesVersionAvailable event. + + :ivar latest_supported_kubernetes_version: The highest PATCH Kubernetes version for the highest + MINOR version supported by ManagedCluster resource. Required. + :vartype latest_supported_kubernetes_version: str + :ivar latest_stable_kubernetes_version: The highest PATCH Kubernetes version for the MINOR + version considered stable for the ManagedCluster resource. Required. + :vartype latest_stable_kubernetes_version: str + :ivar lowest_minor_kubernetes_version: The highest PATCH Kubernetes version for the lowest + applicable MINOR version available for the ManagedCluster resource. Required. + :vartype lowest_minor_kubernetes_version: str + :ivar latest_preview_kubernetes_version: 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. + :vartype latest_preview_kubernetes_version: str + """ + + latestSupportedKubernetesVersion: Required[str] + """The highest PATCH Kubernetes version for the highest MINOR version supported by ManagedCluster + resource. Required.""" + latestStableKubernetesVersion: Required[str] + """The highest PATCH Kubernetes version for the MINOR version considered stable for the + ManagedCluster resource. Required.""" + lowestMinorKubernetesVersion: Required[str] + """The highest PATCH Kubernetes version for the lowest applicable MINOR version available for the + ManagedCluster resource. Required.""" + latestPreviewKubernetesVersion: str + """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.""" + + +class ContainerServiceNodePoolRollingEventData(TypedDict, total=False): + """Schema of common properties of node pool rolling events. + + :ivar node_pool_name: The name of the node pool in the ManagedCluster resource. Required. + :vartype node_pool_name: str + """ + + nodePoolName: Required[str] + """The name of the node pool in the ManagedCluster resource. Required.""" + + +class ContainerServiceNodePoolRollingFailedEventData( + ContainerServiceNodePoolRollingEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.NodePoolRollingFailed event. + + :ivar node_pool_name: The name of the node pool in the ManagedCluster resource. Required. + :vartype node_pool_name: str + """ + + +class ContainerServiceNodePoolRollingStartedEventData( + ContainerServiceNodePoolRollingEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.NodePoolRollingStarted event. + + :ivar node_pool_name: The name of the node pool in the ManagedCluster resource. Required. + :vartype node_pool_name: str + """ + + +class ContainerServiceNodePoolRollingSucceededEventData( + ContainerServiceNodePoolRollingEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ContainerService.NodePoolRollingSucceeded event. + + :ivar node_pool_name: The name of the node pool in the ManagedCluster resource. Required. + :vartype node_pool_name: str + """ + + +class DataBoxCopyCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyCompleted event. + + :ivar serial_number: Serial Number of the device associated with the event. The list is comma + separated if more than one serial number is associated. Required. + :vartype serial_number: str + :ivar stage_name: Name of the current Stage. Required. Known values are: "CopyStarted", + "CopyCompleted", and "OrderCompleted". + :vartype stage_name: str or ~azure.eventgrid.models.DataBoxStageName + :ivar stage_time: The time at which the stage happened. Required. + :vartype stage_time: ~datetime.datetime + """ + + serialNumber: Required[str] + """Serial Number of the device associated with the event. The list is comma separated if more than + one serial number is associated. Required.""" + stageName: Required[DataBoxStageName] + """Name of the current Stage. Required. Known values are: \"CopyStarted\", \"CopyCompleted\", and + \"OrderCompleted\".""" + stageTime: Required[datetime.datetime] + """The time at which the stage happened. Required.""" + + +class DataBoxCopyStartedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.CopyStarted event. + + :ivar serial_number: Serial Number of the device associated with the event. The list is comma + separated if more than one serial number is associated. Required. + :vartype serial_number: str + :ivar stage_name: Name of the current Stage. Required. Known values are: "CopyStarted", + "CopyCompleted", and "OrderCompleted". + :vartype stage_name: str or ~azure.eventgrid.models.DataBoxStageName + :ivar stage_time: The time at which the stage happened. Required. + :vartype stage_time: ~datetime.datetime + """ + + serialNumber: Required[str] + """Serial Number of the device associated with the event. The list is comma separated if more than + one serial number is associated. Required.""" + stageName: Required[DataBoxStageName] + """Name of the current Stage. Required. Known values are: \"CopyStarted\", \"CopyCompleted\", and + \"OrderCompleted\".""" + stageTime: Required[datetime.datetime] + """The time at which the stage happened. Required.""" + + +class DataBoxOrderCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.DataBox.OrderCompleted event. + + :ivar serial_number: Serial Number of the device associated with the event. The list is comma + separated if more than one serial number is associated. Required. + :vartype serial_number: str + :ivar stage_name: Name of the current Stage. Required. Known values are: "CopyStarted", + "CopyCompleted", and "OrderCompleted". + :vartype stage_name: str or ~azure.eventgrid.models.DataBoxStageName + :ivar stage_time: The time at which the stage happened. Required. + :vartype stage_time: ~datetime.datetime + """ + + serialNumber: Required[str] + """Serial Number of the device associated with the event. The list is comma separated if more than + one serial number is associated. Required.""" + stageName: Required[DataBoxStageName] + """Name of the current Stage. Required. Known values are: \"CopyStarted\", \"CopyCompleted\", and + \"OrderCompleted\".""" + stageTime: Required[datetime.datetime] + """The time at which the stage happened. Required.""" + + +class DeviceConnectionStateEventInfo(TypedDict, total=False): + """Information about the device connection state event. + + :ivar sequence_number: 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. + :vartype sequence_number: str + """ + + sequenceNumber: Required[str] + """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.""" + + +class DeviceConnectionStateEventProperties(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a device connection state event + (DeviceConnected, DeviceDisconnected). + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar module_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. + :vartype module_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar device_connection_state_event_info: Information about the device connection state event. + Required. + :vartype device_connection_state_event_info: + ~azure.eventgrid.types.DeviceConnectionStateEventInfo + """ + + deviceId: Required[str] + """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: - + : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required.""" + moduleId: str + """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: Required[str] + """Name of the IoT Hub where the device was created or deleted. Required.""" + deviceConnectionStateEventInfo: Required["DeviceConnectionStateEventInfo"] + """Information about the device connection state event. Required.""" + + +class DeviceLifeCycleEventProperties(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, + DeviceDeleted). + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar twin: Information about the device twin, which is the cloud representation of application + device metadata. Required. + :vartype twin: ~azure.eventgrid.types.DeviceTwinInfo + """ + + deviceId: Required[str] + """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: - + : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required.""" + hubName: Required[str] + """Name of the IoT Hub where the device was created or deleted. Required.""" + twin: Required["DeviceTwinInfo"] + """Information about the device twin, which is the cloud representation of application device + metadata. Required.""" + + +class DeviceTelemetryEventProperties(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a device telemetry event + (DeviceTelemetry). + + :ivar body: The content of the message from the device. Required. + :vartype body: dict[str, any] + :ivar properties: Application properties are user-defined strings that can be added to the + message. These fields are optional. Required. + :vartype properties: dict[str, str] + :ivar system_properties: System properties help identify contents and source of the messages. + Required. + :vartype system_properties: dict[str, str] + """ + + body: Required[dict[str, Any]] + """The content of the message from the device. Required.""" + properties: Required[dict[str, str]] + """Application properties are user-defined strings that can be added to the message. These fields + are optional. Required.""" + systemProperties: Required[dict[str, str]] + """System properties help identify contents and source of the messages. Required.""" + + +class DeviceTwinInfo(TypedDict, total=False): + """Information about the device twin, which is the cloud representation of application device + metadata. + + :ivar authentication_type: Authentication type used for this device: either SAS, SelfSigned, or + CertificateAuthority. Required. + :vartype authentication_type: str + :ivar cloud_to_device_message_count: Count of cloud to device messages sent to this device. + Required. + :vartype cloud_to_device_message_count: float + :ivar connection_state: Whether the device is connected or disconnected. Required. + :vartype connection_state: str + :ivar device_id: The unique identifier of the device twin. Required. + :vartype device_id: str + :ivar etag: A piece of information that describes the content of the device twin. Each etag is + guaranteed to be unique per device twin. Required. + :vartype etag: str + :ivar last_activity_time: The ISO8601 timestamp of the last activity. Required. + :vartype last_activity_time: str + :ivar properties: Properties JSON element. Required. + :vartype properties: ~azure.eventgrid.types.DeviceTwinInfoProperties + :ivar status: Whether the device twin is enabled or disabled. Required. + :vartype status: str + :ivar status_update_time: The ISO8601 timestamp of the last device twin status update. + Required. + :vartype status_update_time: str + :ivar version: An integer that is incremented by one each time the device twin is updated. + Required. + :vartype version: float + :ivar x509_thumbprint: 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. + :vartype x509_thumbprint: ~azure.eventgrid.types.DeviceTwinInfoX509Thumbprint + """ + + authenticationType: Required[str] + """Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority. + Required.""" + cloudToDeviceMessageCount: Required[float] + """Count of cloud to device messages sent to this device. Required.""" + connectionState: Required[str] + """Whether the device is connected or disconnected. Required.""" + deviceId: Required[str] + """The unique identifier of the device twin. Required.""" + etag: Required[str] + """A piece of information that describes the content of the device twin. Each etag is guaranteed + to be unique per device twin. Required.""" + lastActivityTime: Required[str] + """The ISO8601 timestamp of the last activity. Required.""" + properties: Required["DeviceTwinInfoProperties"] + """Properties JSON element. Required.""" + status: Required[str] + """Whether the device twin is enabled or disabled. Required.""" + statusUpdateTime: Required[str] + """The ISO8601 timestamp of the last device twin status update. Required.""" + version: Required[float] + """An integer that is incremented by one each time the device twin is updated. Required.""" + x509Thumbprint: Required["DeviceTwinInfoX509Thumbprint"] + """The thumbprint is a unique value for the x509 certificate, commonly used to find a particular + certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 + algorithm, and does not physically exist in the certificate. Required.""" + + +class DeviceTwinInfoProperties(TypedDict, total=False): + """Properties JSON element. + + :ivar desired: A portion of the properties that can be written only by the application + back-end, and read by the device. Required. + :vartype desired: ~azure.eventgrid.types.DeviceTwinProperties + :ivar reported: A portion of the properties that can be written only by the device, and read by + the application back-end. Required. + :vartype reported: ~azure.eventgrid.types.DeviceTwinProperties + """ + + desired: Required["DeviceTwinProperties"] + """A portion of the properties that can be written only by the application back-end, and read by + the device. Required.""" + reported: Required["DeviceTwinProperties"] + """A portion of the properties that can be written only by the device, and read by the application + back-end. Required.""" + + +class DeviceTwinInfoX509Thumbprint(TypedDict, total=False): + """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. + + :ivar primary_thumbprint: Primary thumbprint for the x509 certificate. Required. + :vartype primary_thumbprint: str + :ivar secondary_thumbprint: Secondary thumbprint for the x509 certificate. Required. + :vartype secondary_thumbprint: str + """ + + primaryThumbprint: Required[str] + """Primary thumbprint for the x509 certificate. Required.""" + secondaryThumbprint: Required[str] + """Secondary thumbprint for the x509 certificate. Required.""" + + +class DeviceTwinMetadata(TypedDict, total=False): + """Metadata information for the properties JSON document. + + :ivar last_updated: The ISO8601 timestamp of the last time the properties were updated. + Required. + :vartype last_updated: str + """ + + lastUpdated: Required[str] + """The ISO8601 timestamp of the last time the properties were updated. Required.""" + + +class DeviceTwinProperties(TypedDict, total=False): + """A portion of the properties that can be written only by the application back-end, and read by + the device. + + :ivar metadata: Metadata information for the properties JSON document. Required. + :vartype metadata: ~azure.eventgrid.types.DeviceTwinMetadata + :ivar version: Version of device twin properties. Required. + :vartype version: float + """ + + metadata: Required["DeviceTwinMetadata"] + """Metadata information for the properties JSON document. Required.""" + version: Required[float] + """Version of device twin properties. Required.""" + + +class EdgeSolutionVersionPublishedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Edge.SolutionVersionPublished + event. + + :ivar external_validation_id: A GUID to uniquely track External Solution Validation. Required. + :vartype external_validation_id: str + :ivar target_id: ARM ID of the Target resource. Required. + :vartype target_id: str + :ivar solution_template_id: ARM ID of the Solution Template resource. Required. + :vartype solution_template_id: str + :ivar solution_template_version_id: ARM ID of the Solution Template Version resource. Required. + :vartype solution_template_version_id: str + :ivar solution_version_id: ARM ID of the Solution Version resource. Required. + :vartype solution_version_id: str + :ivar api_version: API Version supported for the resources. Required. + :vartype api_version: str + :ivar callback_url: Direct URL to callback for updating validation status. Required. + :vartype callback_url: str + """ + + externalValidationId: Required[str] + """A GUID to uniquely track External Solution Validation. Required.""" + targetId: Required[str] + """ARM ID of the Target resource. Required.""" + solutionTemplateId: Required[str] + """ARM ID of the Solution Template resource. Required.""" + solutionTemplateVersionId: Required[str] + """ARM ID of the Solution Template Version resource. Required.""" + solutionVersionId: Required[str] + """ARM ID of the Solution Version resource. Required.""" + apiVersion: Required[str] + """API Version supported for the resources. Required.""" + callbackUrl: Required[str] + """Direct URL to callback for updating validation status. Required.""" + + +class EventGridMQTTClientEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for MQTT Client state changes. + + :ivar client_authentication_name: Unique identifier for the MQTT client that the client + presents to the service for authentication. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required. + :vartype client_authentication_name: str + :ivar client_name: Name of the client resource in the Event Grid namespace. + :vartype client_name: str + :ivar namespace_name: Name of the Event Grid namespace where the MQTT client was created or + updated. Required. + :vartype namespace_name: str + """ + + clientAuthenticationName: Required[str] + """Unique identifier for the MQTT client that the client presents to the service for + authentication. This case-sensitive string can be up to 128 characters long, and supports UTF-8 + characters. Required.""" + clientName: str + """Name of the client resource in the Event Grid namespace.""" + namespaceName: Required[str] + """Name of the Event Grid namespace where the MQTT client was created or updated. Required.""" + + +class EventGridMQTTClientCreatedOrUpdatedEventData(EventGridMQTTClientEventData): # pylint: disable=name-too-long + """Event data for Microsoft.EventGrid.MQTTClientCreatedOrUpdated event. + + :ivar client_authentication_name: Unique identifier for the MQTT client that the client + presents to the service for authentication. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required. + :vartype client_authentication_name: str + :ivar client_name: Name of the client resource in the Event Grid namespace. + :vartype client_name: str + :ivar namespace_name: Name of the Event Grid namespace where the MQTT client was created or + updated. Required. + :vartype namespace_name: str + :ivar state: Configured state of the client. The value could be Enabled or Disabled. Required. + Known values are: "Enabled" and "Disabled". + :vartype state: str or ~azure.eventgrid.models.EventGridMQTTClientState + :ivar created_on: Time the client resource is created based on the provider's UTC time. + Required. + :vartype created_on: ~datetime.datetime + :ivar updated_on: Time the client resource is last updated based on the provider's UTC time. If + the client resource was never updated, this value is identical to the value of the 'createdOn' + property. Required. + :vartype updated_on: ~datetime.datetime + :ivar attributes: The key-value attributes that are assigned to the client resource. Required. + :vartype attributes: dict[str, str] + """ + + state: Required[EventGridMQTTClientState] + """Configured state of the client. The value could be Enabled or Disabled. Required. Known values + are: \"Enabled\" and \"Disabled\".""" + createdOn: Required[datetime.datetime] + """Time the client resource is created based on the provider's UTC time. Required.""" + updatedOn: Required[datetime.datetime] + """Time the client resource is last updated based on the provider's UTC time. If the client + resource was never updated, this value is identical to the value of the 'createdOn' property. + Required.""" + attributes: Required[dict[str, str]] + """The key-value attributes that are assigned to the client resource. Required.""" + + +class EventGridMQTTClientDeletedEventData(EventGridMQTTClientEventData): + """Event data for Microsoft.EventGrid.MQTTClientDeleted event. + + :ivar client_authentication_name: Unique identifier for the MQTT client that the client + presents to the service for authentication. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required. + :vartype client_authentication_name: str + :ivar client_name: Name of the client resource in the Event Grid namespace. + :vartype client_name: str + :ivar namespace_name: Name of the Event Grid namespace where the MQTT client was created or + updated. Required. + :vartype namespace_name: str + """ + + +class EventGridMQTTClientSessionConnectedEventData(EventGridMQTTClientEventData): # pylint: disable=name-too-long + """Event data for Microsoft.EventGrid.MQTTClientSessionConnected event. + + :ivar client_authentication_name: Unique identifier for the MQTT client that the client + presents to the service for authentication. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required. + :vartype client_authentication_name: str + :ivar client_name: Name of the client resource in the Event Grid namespace. + :vartype client_name: str + :ivar namespace_name: Name of the Event Grid namespace where the MQTT client was created or + updated. Required. + :vartype namespace_name: str + :ivar client_session_name: Unique identifier for the MQTT client's session. This case-sensitive + string can be up to 128 characters long, and supports UTF-8 characters. Required. + :vartype client_session_name: str + :ivar sequence_number: A number that helps indicate order of MQTT client session connected or + disconnected events. Latest event will have a sequence number that is higher than the previous + event. Required. + :vartype sequence_number: int + """ + + clientSessionName: Required[str] + """Unique identifier for the MQTT client's session. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required.""" + sequenceNumber: Required[int] + """A number that helps indicate order of MQTT client session connected or disconnected events. + Latest event will have a sequence number that is higher than the previous event. Required.""" + + +class EventGridMQTTClientSessionDisconnectedEventData(EventGridMQTTClientEventData): # pylint: disable=name-too-long + """Event data for Microsoft.EventGrid.MQTTClientSessionDisconnected event. + + :ivar client_authentication_name: Unique identifier for the MQTT client that the client + presents to the service for authentication. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required. + :vartype client_authentication_name: str + :ivar client_name: Name of the client resource in the Event Grid namespace. + :vartype client_name: str + :ivar namespace_name: Name of the Event Grid namespace where the MQTT client was created or + updated. Required. + :vartype namespace_name: str + :ivar client_session_name: Unique identifier for the MQTT client's session. This case-sensitive + string can be up to 128 characters long, and supports UTF-8 characters. Required. + :vartype client_session_name: str + :ivar sequence_number: A number that helps indicate order of MQTT client session connected or + disconnected events. Latest event will have a sequence number that is higher than the previous + event. Required. + :vartype sequence_number: int + :ivar disconnection_reason: Reason for the disconnection of the MQTT client's session. The + value could be one of the values in the disconnection reasons table. Required. Known values + are: "ClientAuthenticationError", "ClientAuthorizationError", "ClientError", + "ClientInitiatedDisconnect", "ConnectionLost", "IpForbidden", "QuotaExceeded", "ServerError", + "ServerInitiatedDisconnect", "SessionOverflow", and "SessionTakenOver". + :vartype disconnection_reason: str or + ~azure.eventgrid.models.EventGridMQTTClientDisconnectionReason + """ + + clientSessionName: Required[str] + """Unique identifier for the MQTT client's session. This case-sensitive string can be up to 128 + characters long, and supports UTF-8 characters. Required.""" + sequenceNumber: Required[int] + """A number that helps indicate order of MQTT client session connected or disconnected events. + Latest event will have a sequence number that is higher than the previous event. Required.""" + disconnectionReason: Required[EventGridMQTTClientDisconnectionReason] + """Reason for the disconnection of the MQTT client's session. The value could be one of the values + in the disconnection reasons table. Required. Known values are: \"ClientAuthenticationError\", + \"ClientAuthorizationError\", \"ClientError\", \"ClientInitiatedDisconnect\", + \"ConnectionLost\", \"IpForbidden\", \"QuotaExceeded\", \"ServerError\", + \"ServerInitiatedDisconnect\", \"SessionOverflow\", and \"SessionTakenOver\".""" + + +class EventHubCaptureFileCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.EventHub.CaptureFileCreated + event. + + :ivar file_url: The path to the capture file. Required. + :vartype file_url: str + :ivar file_type: The file type of the capture file. Required. + :vartype file_type: str + :ivar partition_id: The shard ID. Required. + :vartype partition_id: str + :ivar size_in_bytes: The file size. Required. + :vartype size_in_bytes: int + :ivar event_count: The number of events in the file. Required. + :vartype event_count: int + :ivar first_sequence_number: The smallest sequence number from the queue. Required. + :vartype first_sequence_number: int + :ivar last_sequence_number: The last sequence number from the queue. Required. + :vartype last_sequence_number: int + :ivar first_enqueue_time: The first time from the queue. Required. + :vartype first_enqueue_time: ~datetime.datetime + :ivar last_enqueue_time: The last time from the queue. Required. + :vartype last_enqueue_time: ~datetime.datetime + """ + + fileUrl: Required[str] + """The path to the capture file. Required.""" + fileType: Required[str] + """The file type of the capture file. Required.""" + partitionId: Required[str] + """The shard ID. Required.""" + sizeInBytes: Required[int] + """The file size. Required.""" + eventCount: Required[int] + """The number of events in the file. Required.""" + firstSequenceNumber: Required[int] + """The smallest sequence number from the queue. Required.""" + lastSequenceNumber: Required[int] + """The last sequence number from the queue. Required.""" + firstEnqueueTime: Required[datetime.datetime] + """The first time from the queue. Required.""" + lastEnqueueTime: Required[datetime.datetime] + """The last time from the queue. Required.""" + + +class HealthcareDicomImageCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.DicomImageCreated event. + + :ivar partition_name: Data partition name. Required. + :vartype partition_name: str + :ivar image_study_instance_uid: Unique identifier for the Study. Required. + :vartype image_study_instance_uid: str + :ivar image_series_instance_uid: Unique identifier for the Series. Required. + :vartype image_series_instance_uid: str + :ivar image_sop_instance_uid: Unique identifier for the DICOM Image. Required. + :vartype image_sop_instance_uid: str + :ivar service_host_name: Domain name of the DICOM account for this image. Required. + :vartype service_host_name: str + :ivar sequence_number: Sequence number of the DICOM Service within Azure Health Data Services. + It is unique for every image creation and deletion within the service. Required. + :vartype sequence_number: int + """ + + partitionName: Required[str] + """Data partition name. Required.""" + imageStudyInstanceUid: Required[str] + """Unique identifier for the Study. Required.""" + imageSeriesInstanceUid: Required[str] + """Unique identifier for the Series. Required.""" + imageSopInstanceUid: Required[str] + """Unique identifier for the DICOM Image. Required.""" + serviceHostName: Required[str] + """Domain name of the DICOM account for this image. Required.""" + sequenceNumber: Required[int] + """Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every + image creation and deletion within the service. Required.""" + + +class HealthcareDicomImageDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.DicomImageDeleted event. + + :ivar partition_name: Data partition name. Required. + :vartype partition_name: str + :ivar image_study_instance_uid: Unique identifier for the Study. Required. + :vartype image_study_instance_uid: str + :ivar image_series_instance_uid: Unique identifier for the Series. Required. + :vartype image_series_instance_uid: str + :ivar image_sop_instance_uid: Unique identifier for the DICOM Image. Required. + :vartype image_sop_instance_uid: str + :ivar service_host_name: Host name of the DICOM account for this image. Required. + :vartype service_host_name: str + :ivar sequence_number: Sequence number of the DICOM Service within Azure Health Data Services. + It is unique for every image creation and deletion within the service. Required. + :vartype sequence_number: int + """ + + partitionName: Required[str] + """Data partition name. Required.""" + imageStudyInstanceUid: Required[str] + """Unique identifier for the Study. Required.""" + imageSeriesInstanceUid: Required[str] + """Unique identifier for the Series. Required.""" + imageSopInstanceUid: Required[str] + """Unique identifier for the DICOM Image. Required.""" + serviceHostName: Required[str] + """Host name of the DICOM account for this image. Required.""" + sequenceNumber: Required[int] + """Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every + image creation and deletion within the service. Required.""" + + +class HealthcareDicomImageUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.DicomImageUpdated event. + + :ivar partition_name: Data partition name. Required. + :vartype partition_name: str + :ivar image_study_instance_uid: Unique identifier for the Study. Required. + :vartype image_study_instance_uid: str + :ivar image_series_instance_uid: Unique identifier for the Series. Required. + :vartype image_series_instance_uid: str + :ivar image_sop_instance_uid: Unique identifier for the DICOM Image. Required. + :vartype image_sop_instance_uid: str + :ivar service_host_name: Domain name of the DICOM account for this image. Required. + :vartype service_host_name: str + :ivar sequence_number: 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. + :vartype sequence_number: int + """ + + partitionName: Required[str] + """Data partition name. Required.""" + imageStudyInstanceUid: Required[str] + """Unique identifier for the Study. Required.""" + imageSeriesInstanceUid: Required[str] + """Unique identifier for the Series. Required.""" + imageSopInstanceUid: Required[str] + """Unique identifier for the DICOM Image. Required.""" + serviceHostName: Required[str] + """Domain name of the DICOM account for this image. Required.""" + sequenceNumber: Required[int] + """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.""" + + +class HealthcareFhirResourceCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.FhirResourceCreated event. + + :ivar fhir_resource_type: Type of HL7 FHIR resource. Required. Known values are: "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", and "VisionPrescription". + :vartype fhir_resource_type: str or ~azure.eventgrid.models.HealthcareFhirResourceType + :ivar fhir_service_host_name: Domain name of FHIR account for this resource. Required. + :vartype fhir_service_host_name: str + :ivar fhir_resource_id: Id of HL7 FHIR resource. Required. + :vartype fhir_resource_id: str + :ivar fhir_resource_version_id: VersionId of HL7 FHIR resource. It changes when the resource is + created, updated, or deleted(soft-deletion). Required. + :vartype fhir_resource_version_id: int + """ + + resourceType: Required[HealthcareFhirResourceType] + """Type of HL7 FHIR resource. Required. Known values are: \"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\", and \"VisionPrescription\".""" + resourceFhirAccount: Required[str] + """Domain name of FHIR account for this resource. Required.""" + resourceFhirId: Required[str] + """Id of HL7 FHIR resource. Required.""" + resourceVersionId: Required[int] + """VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or + deleted(soft-deletion). Required.""" + + +class HealthcareFhirResourceDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.FhirResourceDeleted event. + + :ivar fhir_resource_type: Type of HL7 FHIR resource. Required. Known values are: "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", and "VisionPrescription". + :vartype fhir_resource_type: str or ~azure.eventgrid.models.HealthcareFhirResourceType + :ivar fhir_service_host_name: Domain name of FHIR account for this resource. Required. + :vartype fhir_service_host_name: str + :ivar fhir_resource_id: Id of HL7 FHIR resource. Required. + :vartype fhir_resource_id: str + :ivar fhir_resource_version_id: VersionId of HL7 FHIR resource. It changes when the resource is + created, updated, or deleted(soft-deletion). Required. + :vartype fhir_resource_version_id: int + """ + + resourceType: Required[HealthcareFhirResourceType] + """Type of HL7 FHIR resource. Required. Known values are: \"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\", and \"VisionPrescription\".""" + resourceFhirAccount: Required[str] + """Domain name of FHIR account for this resource. Required.""" + resourceFhirId: Required[str] + """Id of HL7 FHIR resource. Required.""" + resourceVersionId: Required[int] + """VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or + deleted(soft-deletion). Required.""" + + +class HealthcareFhirResourceUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.HealthcareApis.FhirResourceUpdated event. + + :ivar fhir_resource_type: Type of HL7 FHIR resource. Required. Known values are: "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", and "VisionPrescription". + :vartype fhir_resource_type: str or ~azure.eventgrid.models.HealthcareFhirResourceType + :ivar fhir_service_host_name: Domain name of FHIR account for this resource. Required. + :vartype fhir_service_host_name: str + :ivar fhir_resource_id: Id of HL7 FHIR resource. Required. + :vartype fhir_resource_id: str + :ivar fhir_resource_version_id: VersionId of HL7 FHIR resource. It changes when the resource is + created, updated, or deleted(soft-deletion). Required. + :vartype fhir_resource_version_id: int + """ + + resourceType: Required[HealthcareFhirResourceType] + """Type of HL7 FHIR resource. Required. Known values are: \"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\", and \"VisionPrescription\".""" + resourceFhirAccount: Required[str] + """Domain name of FHIR account for this resource. Required.""" + resourceFhirId: Required[str] + """Id of HL7 FHIR resource. Required.""" + resourceVersionId: Required[int] + """VersionId of HL7 FHIR resource. It changes when the resource is created, updated, or + deleted(soft-deletion). Required.""" + + +class IotHubDeviceConnectedEventData(DeviceConnectionStateEventProperties): + """Event data for Microsoft.Devices.DeviceConnected event. + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar module_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. + :vartype module_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar device_connection_state_event_info: Information about the device connection state event. + Required. + :vartype device_connection_state_event_info: + ~azure.eventgrid.types.DeviceConnectionStateEventInfo + """ + + +class IotHubDeviceCreatedEventData(DeviceLifeCycleEventProperties): + """Event data for Microsoft.Devices.DeviceCreated event. + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar twin: Information about the device twin, which is the cloud representation of application + device metadata. Required. + :vartype twin: ~azure.eventgrid.types.DeviceTwinInfo + """ + + +class IotHubDeviceDeletedEventData(DeviceLifeCycleEventProperties): + """Event data for Microsoft.Devices.DeviceDeleted event. + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar twin: Information about the device twin, which is the cloud representation of application + device metadata. Required. + :vartype twin: ~azure.eventgrid.types.DeviceTwinInfo + """ + + +class IotHubDeviceDisconnectedEventData(DeviceConnectionStateEventProperties): + """Event data for Microsoft.Devices.DeviceDisconnected event. + + :ivar device_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. Required. + :vartype device_id: str + :ivar module_id: 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: - : . + % _ # * ? ! ( ) , = ``@`` ; $ '. + :vartype module_id: str + :ivar hub_name: Name of the IoT Hub where the device was created or deleted. Required. + :vartype hub_name: str + :ivar device_connection_state_event_info: Information about the device connection state event. + Required. + :vartype device_connection_state_event_info: + ~azure.eventgrid.types.DeviceConnectionStateEventInfo + """ + + +class IotHubDeviceTelemetryEventData(DeviceTelemetryEventProperties): + """Event data for Microsoft.Devices.DeviceTelemetry event. + + :ivar body: The content of the message from the device. Required. + :vartype body: dict[str, any] + :ivar properties: Application properties are user-defined strings that can be added to the + message. These fields are optional. Required. + :vartype properties: dict[str, str] + :ivar system_properties: System properties help identify contents and source of the messages. + Required. + :vartype system_properties: dict[str, str] + """ + + +class KeyVaultAccessPolicyChangedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.KeyVault.VaultAccessPolicyChanged event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultCertificateExpiredEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateExpired + event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultCertificateNearExpiryEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.CertificateNearExpiry + event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultCertificateNewVersionCreatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.KeyVault.CertificateNewVersionCreated event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultKeyExpiredEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyExpired event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultKeyNearExpiryEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNearExpiry event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultKeyNewVersionCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.KeyNewVersionCreated + event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultSecretExpiredEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretExpired event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultSecretNearExpiryEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.KeyVault.SecretNearExpiry + event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class KeyVaultSecretNewVersionCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.KeyVault.SecretNewVersionCreated event. + + :ivar id: The id of the object that triggered this event. Required. + :vartype id: str + :ivar vault_name: Key vault name of the object that triggered this event. Required. + :vartype vault_name: str + :ivar object_type: The type of the object that triggered this event. Required. + :vartype object_type: str + :ivar object_name: The name of the object that triggered this event. Required. + :vartype object_name: str + :ivar version: The version of the object that triggered this event. Required. + :vartype version: str + :ivar nbf: Not before date of the object that triggered this event. Required. + :vartype nbf: float + :ivar exp: The expiration date of the object that triggered this event. Required. + :vartype exp: float + """ + + Id: Required[str] + """The id of the object that triggered this event. Required.""" + VaultName: Required[str] + """Key vault name of the object that triggered this event. Required.""" + ObjectType: Required[str] + """The type of the object that triggered this event. Required.""" + ObjectName: Required[str] + """The name of the object that triggered this event. Required.""" + Version: Required[str] + """The version of the object that triggered this event. Required.""" + NBF: Required[float] + """Not before date of the object that triggered this event. Required.""" + EXP: Required[float] + """The expiration date of the object that triggered this event. Required.""" + + +class MachineLearningServicesDatasetDriftDetectedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.MachineLearningServices.DatasetDriftDetected event. + + :ivar data_drift_id: The ID of the data drift monitor that triggered the event. Required. + :vartype data_drift_id: str + :ivar data_drift_name: The name of the data drift monitor that triggered the event. Required. + :vartype data_drift_name: str + :ivar run_id: The ID of the Run that detected data drift. Required. + :vartype run_id: str + :ivar base_dataset_id: The ID of the base Dataset used to detect drift. Required. + :vartype base_dataset_id: str + :ivar target_dataset_id: The ID of the target Dataset used to detect drift. Required. + :vartype target_dataset_id: str + :ivar drift_coefficient: The coefficient result that triggered the event. Required. + :vartype drift_coefficient: float + :ivar start_time: The start time of the target dataset time series that resulted in drift + detection. Required. + :vartype start_time: ~datetime.datetime + :ivar end_time: The end time of the target dataset time series that resulted in drift + detection. Required. + :vartype end_time: ~datetime.datetime + """ + + dataDriftId: Required[str] + """The ID of the data drift monitor that triggered the event. Required.""" + dataDriftName: Required[str] + """The name of the data drift monitor that triggered the event. Required.""" + runId: Required[str] + """The ID of the Run that detected data drift. Required.""" + baseDatasetId: Required[str] + """The ID of the base Dataset used to detect drift. Required.""" + targetDatasetId: Required[str] + """The ID of the target Dataset used to detect drift. Required.""" + driftCoefficient: Required[float] + """The coefficient result that triggered the event. Required.""" + startTime: Required[Optional[datetime.datetime]] + """The start time of the target dataset time series that resulted in drift detection. Required.""" + endTime: Required[Optional[datetime.datetime]] + """The end time of the target dataset time series that resulted in drift detection. Required.""" + + +class MachineLearningServicesModelDeployedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.MachineLearningServices.ModelDeployed event. + + :ivar service_name: The name of the deployed service. Required. + :vartype service_name: str + :ivar service_compute_type: The compute type (e.g. ACI, AKS) of the deployed service. Required. + :vartype service_compute_type: str + :ivar model_ids: A common separated list of model IDs. The IDs of the models deployed in the + service. Required. + :vartype model_ids: str + :ivar service_tags: The tags of the deployed service. + :vartype service_tags: dict[str, any] + :ivar service_properties: The properties of the deployed service. + :vartype service_properties: dict[str, any] + """ + + serviceName: Required[str] + """The name of the deployed service. Required.""" + serviceComputeType: Required[str] + """The compute type (e.g. ACI, AKS) of the deployed service. Required.""" + modelIds: Required[str] + """A common separated list of model IDs. The IDs of the models deployed in the service. Required.""" + serviceTags: dict[str, Any] + """The tags of the deployed service.""" + serviceProperties: dict[str, Any] + """The properties of the deployed service.""" + + +class MachineLearningServicesModelRegisteredEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.MachineLearningServices.ModelRegistered event. + + :ivar model_name: The name of the model that was registered. Required. + :vartype model_name: str + :ivar model_version: The version of the model that was registered. Required. + :vartype model_version: str + :ivar model_tags: The tags of the model that was registered. + :vartype model_tags: dict[str, any] + :ivar model_properties: The properties of the model that was registered. + :vartype model_properties: dict[str, any] + """ + + modelName: Required[str] + """The name of the model that was registered. Required.""" + modelVersion: Required[str] + """The version of the model that was registered. Required.""" + modelTags: dict[str, Any] + """The tags of the model that was registered.""" + modelProperties: dict[str, Any] + """The properties of the model that was registered.""" + + +class MachineLearningServicesRunCompletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.MachineLearningServices.RunCompleted event. + + :ivar experiment_id: The ID of the experiment that the run belongs to. Required. + :vartype experiment_id: str + :ivar experiment_name: The name of the experiment that the run belongs to. Required. + :vartype experiment_name: str + :ivar run_id: The ID of the Run that was completed. Required. + :vartype run_id: str + :ivar run_type: The Run Type of the completed Run. Required. + :vartype run_type: str + :ivar run_tags: The tags of the completed Run. + :vartype run_tags: dict[str, any] + :ivar run_properties: The properties of the completed Run. + :vartype run_properties: dict[str, any] + """ + + experimentId: Required[str] + """The ID of the experiment that the run belongs to. Required.""" + experimentName: Required[str] + """The name of the experiment that the run belongs to. Required.""" + runId: Required[str] + """The ID of the Run that was completed. Required.""" + runType: Required[str] + """The Run Type of the completed Run. Required.""" + runTags: dict[str, Any] + """The tags of the completed Run.""" + runProperties: dict[str, Any] + """The properties of the completed Run.""" + + +class MachineLearningServicesRunStatusChangedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.MachineLearningServices.RunStatusChanged event. + + :ivar experiment_id: The ID of the experiment that the Machine Learning Run belongs to. + Required. + :vartype experiment_id: str + :ivar experiment_name: The name of the experiment that the Machine Learning Run belongs to. + Required. + :vartype experiment_name: str + :ivar run_id: The ID of the Machine Learning Run. Required. + :vartype run_id: str + :ivar run_type: The Run Type of the Machine Learning Run. Required. + :vartype run_type: str + :ivar run_tags: The tags of the Machine Learning Run. + :vartype run_tags: dict[str, any] + :ivar run_properties: The properties of the Machine Learning Run. + :vartype run_properties: dict[str, any] + :ivar run_status: The status of the Machine Learning Run. Required. + :vartype run_status: str + """ + + experimentId: Required[str] + """The ID of the experiment that the Machine Learning Run belongs to. Required.""" + experimentName: Required[str] + """The name of the experiment that the Machine Learning Run belongs to. Required.""" + runId: Required[str] + """The ID of the Machine Learning Run. Required.""" + runType: Required[str] + """The Run Type of the Machine Learning Run. Required.""" + runTags: dict[str, Any] + """The tags of the Machine Learning Run.""" + runProperties: dict[str, Any] + """The properties of the Machine Learning Run.""" + runStatus: Required[str] + """The status of the Machine Learning Run. Required.""" + + +class MapsGeofenceEventProperties(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, + GeofenceExited, GeofenceResult). + + :ivar expired_geofence_geometry_id: Lists of the geometry ID of the geofence which is expired + relative to the user time in the request. Required. + :vartype expired_geofence_geometry_id: list[str] + :ivar geometries: Lists the fence geometries that either fully contain the coordinate position + or have an overlap with the searchBuffer around the fence. Required. + :vartype geometries: list[~azure.eventgrid.types.MapsGeofenceGeometry] + :ivar invalid_period_geofence_geometry_id: Lists of the geometry ID of the geofence which is in + invalid period relative to the user time in the request. Required. + :vartype invalid_period_geofence_geometry_id: list[str] + :ivar is_event_published: 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. + :vartype is_event_published: bool + """ + + expiredGeofenceGeometryId: Required[list[str]] + """Lists of the geometry ID of the geofence which is expired relative to the user time in the + request. Required.""" + geometries: Required[list["MapsGeofenceGeometry"]] + """Lists the fence geometries that either fully contain the coordinate position or have an overlap + with the searchBuffer around the fence. Required.""" + invalidPeriodGeofenceGeometryId: Required[list[str]] + """Lists of the geometry ID of the geofence which is in invalid period relative to the user time + in the request. Required.""" + isEventPublished: Required[bool] + """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.""" + + +class MapsGeofenceEnteredEventData(MapsGeofenceEventProperties): + """Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event. + + :ivar expired_geofence_geometry_id: Lists of the geometry ID of the geofence which is expired + relative to the user time in the request. Required. + :vartype expired_geofence_geometry_id: list[str] + :ivar geometries: Lists the fence geometries that either fully contain the coordinate position + or have an overlap with the searchBuffer around the fence. Required. + :vartype geometries: list[~azure.eventgrid.types.MapsGeofenceGeometry] + :ivar invalid_period_geofence_geometry_id: Lists of the geometry ID of the geofence which is in + invalid period relative to the user time in the request. Required. + :vartype invalid_period_geofence_geometry_id: list[str] + :ivar is_event_published: 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. + :vartype is_event_published: bool + """ + + +class MapsGeofenceExitedEventData(MapsGeofenceEventProperties): + """Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event. + + :ivar expired_geofence_geometry_id: Lists of the geometry ID of the geofence which is expired + relative to the user time in the request. Required. + :vartype expired_geofence_geometry_id: list[str] + :ivar geometries: Lists the fence geometries that either fully contain the coordinate position + or have an overlap with the searchBuffer around the fence. Required. + :vartype geometries: list[~azure.eventgrid.types.MapsGeofenceGeometry] + :ivar invalid_period_geofence_geometry_id: Lists of the geometry ID of the geofence which is in + invalid period relative to the user time in the request. Required. + :vartype invalid_period_geofence_geometry_id: list[str] + :ivar is_event_published: 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. + :vartype is_event_published: bool + """ + + +class MapsGeofenceGeometry(TypedDict, total=False): + """The geofence geometry. + + :ivar device_id: ID of the device. Required. + :vartype device_id: str + :ivar distance: 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. Required. + :vartype distance: float + :ivar geometry_id: The unique ID for the geofence geometry. Required. + :vartype geometry_id: str + :ivar nearest_lat: Latitude of the nearest point of the geometry. Required. + :vartype nearest_lat: float + :ivar nearest_lon: Longitude of the nearest point of the geometry. Required. + :vartype nearest_lon: float + :ivar ud_id: The unique id returned from user upload service when uploading a geofence. Will + not be included in geofencing post API. + :vartype ud_id: str + """ + + deviceId: Required[str] + """ID of the device. Required.""" + distance: Required[float] + """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. Required.""" + geometryId: Required[str] + """The unique ID for the geofence geometry. Required.""" + nearestLat: Required[float] + """Latitude of the nearest point of the geometry. Required.""" + nearestLon: Required[float] + """Longitude of the nearest point of the geometry. Required.""" + udId: str + """The unique id returned from user upload service when uploading a geofence. Will not be included + in geofencing post API.""" + + +class MapsGeofenceResultEventData(MapsGeofenceEventProperties): + """Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event. + + :ivar expired_geofence_geometry_id: Lists of the geometry ID of the geofence which is expired + relative to the user time in the request. Required. + :vartype expired_geofence_geometry_id: list[str] + :ivar geometries: Lists the fence geometries that either fully contain the coordinate position + or have an overlap with the searchBuffer around the fence. Required. + :vartype geometries: list[~azure.eventgrid.types.MapsGeofenceGeometry] + :ivar invalid_period_geofence_geometry_id: Lists of the geometry ID of the geofence which is in + invalid period relative to the user time in the request. Required. + :vartype invalid_period_geofence_geometry_id: list[str] + :ivar is_event_published: 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. + :vartype is_event_published: bool + """ + + +class MicrosoftTeamsAppIdentifierModel(TypedDict, total=False): + """A Microsoft Teams application. + + :ivar app_id: The Id of the Microsoft Teams application. Required. + :vartype app_id: str + :ivar cloud: The cloud that the Microsoft Teams application belongs to. By default 'public' if + missing. Required. Known values are: "public", "dod", and "gcch". + :vartype cloud: str or ~azure.eventgrid.models.CommunicationCloudEnvironmentModel + """ + + appId: Required[str] + """The Id of the Microsoft Teams application. Required.""" + cloud: Required[CommunicationCloudEnvironmentModel] + """The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. + Required. Known values are: \"public\", \"dod\", and \"gcch\".""" + + +class MicrosoftTeamsUserIdentifierModel(TypedDict, total=False): + """A Microsoft Teams user. + + :ivar user_id: The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id + of the user. Required. + :vartype user_id: str + :ivar is_anonymous: True if the Microsoft Teams user is anonymous. By default false if missing. + :vartype is_anonymous: bool + :ivar cloud: The cloud that the Microsoft Teams user belongs to. By default 'public' if + missing. Required. Known values are: "public", "dod", and "gcch". + :vartype cloud: str or ~azure.eventgrid.models.CommunicationCloudEnvironmentModel + """ + + userId: Required[str] + """The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user. + Required.""" + isAnonymous: bool + """True if the Microsoft Teams user is anonymous. By default false if missing.""" + cloud: Required[CommunicationCloudEnvironmentModel] + """The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. Required. + Known values are: \"public\", \"dod\", and \"gcch\".""" + + +class PhoneNumberIdentifierModel(TypedDict, total=False): + """A phone number. + + :ivar value: The phone number in E.164 format. Required. + :vartype value: str + """ + + value: Required[str] + """The phone number in E.164 format. Required.""" + + +class PolicyInsightsPolicyStateChangedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.PolicyInsights.PolicyStateChanged event. + + :ivar timestamp: The time that the resource was scanned by Azure Policy in the Universal ISO + 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required. + :vartype timestamp: ~datetime.datetime + :ivar policy_assignment_id: The resource ID of the policy assignment. Required. + :vartype policy_assignment_id: str + :ivar policy_definition_id: The resource ID of the policy definition. Required. + :vartype policy_definition_id: str + :ivar policy_definition_reference_id: The reference ID for the policy definition inside the + initiative definition, if the policy assignment is for an initiative. May be empty. Required. + :vartype policy_definition_reference_id: str + :ivar compliance_state: The compliance state of the resource with respect to the policy + assignment. Required. + :vartype compliance_state: str + :ivar subscription_id: The subscription ID of the resource. Required. + :vartype subscription_id: str + :ivar compliance_reason_code: The compliance reason code. May be empty. Required. + :vartype compliance_reason_code: str + """ + + timestamp: Required[datetime.datetime] + """The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime + format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required.""" + policyAssignmentId: Required[str] + """The resource ID of the policy assignment. Required.""" + policyDefinitionId: Required[str] + """The resource ID of the policy definition. Required.""" + policyDefinitionReferenceId: Required[str] + """The reference ID for the policy definition inside the initiative definition, if the policy + assignment is for an initiative. May be empty. Required.""" + complianceState: Required[str] + """The compliance state of the resource with respect to the policy assignment. Required.""" + subscriptionId: Required[str] + """The subscription ID of the resource. Required.""" + complianceReasonCode: Required[str] + """The compliance reason code. May be empty. Required.""" + + +class PolicyInsightsPolicyStateCreatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.PolicyInsights.PolicyStateCreated event. + + :ivar timestamp: The time that the resource was scanned by Azure Policy in the Universal ISO + 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required. + :vartype timestamp: ~datetime.datetime + :ivar policy_assignment_id: The resource ID of the policy assignment. Required. + :vartype policy_assignment_id: str + :ivar policy_definition_id: The resource ID of the policy definition. Required. + :vartype policy_definition_id: str + :ivar policy_definition_reference_id: The reference ID for the policy definition inside the + initiative definition, if the policy assignment is for an initiative. May be empty. Required. + :vartype policy_definition_reference_id: str + :ivar compliance_state: The compliance state of the resource with respect to the policy + assignment. Required. + :vartype compliance_state: str + :ivar subscription_id: The subscription ID of the resource. Required. + :vartype subscription_id: str + :ivar compliance_reason_code: The compliance reason code. May be empty. Required. + :vartype compliance_reason_code: str + """ + + timestamp: Required[datetime.datetime] + """The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime + format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required.""" + policyAssignmentId: Required[str] + """The resource ID of the policy assignment. Required.""" + policyDefinitionId: Required[str] + """The resource ID of the policy definition. Required.""" + policyDefinitionReferenceId: Required[str] + """The reference ID for the policy definition inside the initiative definition, if the policy + assignment is for an initiative. May be empty. Required.""" + complianceState: Required[str] + """The compliance state of the resource with respect to the policy assignment. Required.""" + subscriptionId: Required[str] + """The subscription ID of the resource. Required.""" + complianceReasonCode: Required[str] + """The compliance reason code. May be empty. Required.""" + + +class PolicyInsightsPolicyStateDeletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.PolicyInsights.PolicyStateDeleted event. + + :ivar timestamp: The time that the resource was scanned by Azure Policy in the Universal ISO + 8601 DateTime format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required. + :vartype timestamp: ~datetime.datetime + :ivar policy_assignment_id: The resource ID of the policy assignment. Required. + :vartype policy_assignment_id: str + :ivar policy_definition_id: The resource ID of the policy definition. Required. + :vartype policy_definition_id: str + :ivar policy_definition_reference_id: The reference ID for the policy definition inside the + initiative definition, if the policy assignment is for an initiative. May be empty. Required. + :vartype policy_definition_reference_id: str + :ivar compliance_state: The compliance state of the resource with respect to the policy + assignment. Required. + :vartype compliance_state: str + :ivar subscription_id: The subscription ID of the resource. Required. + :vartype subscription_id: str + :ivar compliance_reason_code: The compliance reason code. May be empty. Required. + :vartype compliance_reason_code: str + """ + + timestamp: Required[datetime.datetime] + """The time that the resource was scanned by Azure Policy in the Universal ISO 8601 DateTime + format yyyy-MM-ddTHH:mm:ss.fffffffZ. Required.""" + policyAssignmentId: Required[str] + """The resource ID of the policy assignment. Required.""" + policyDefinitionId: Required[str] + """The resource ID of the policy definition. Required.""" + policyDefinitionReferenceId: Required[str] + """The reference ID for the policy definition inside the initiative definition, if the policy + assignment is for an initiative. May be empty. Required.""" + complianceState: Required[str] + """The compliance state of the resource with respect to the policy assignment. Required.""" + subscriptionId: Required[str] + """The subscription ID of the resource. Required.""" + complianceReasonCode: Required[str] + """The compliance reason code. May be empty. Required.""" + + +class RedisExportRDBCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ExportRDBCompleted + event. + + :ivar timestamp: The time at which the event occurred. + :vartype timestamp: ~datetime.datetime + :ivar name: The name of this event. + :vartype name: str + :ivar status: The status of this event. Failed or succeeded. + :vartype status: str + """ + + timestamp: datetime.datetime + """The time at which the event occurred.""" + name: str + """The name of this event.""" + status: str + """The status of this event. Failed or succeeded.""" + + +class RedisImportRDBCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ImportRDBCompleted + event. + + :ivar timestamp: The time at which the event occurred. + :vartype timestamp: ~datetime.datetime + :ivar name: The name of this event. + :vartype name: str + :ivar status: The status of this event. Failed or succeeded. + :vartype status: str + """ + + timestamp: datetime.datetime + """The time at which the event occurred.""" + name: str + """The name of this event.""" + status: str + """The status of this event. Failed or succeeded.""" + + +class RedisPatchingCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Cache.PatchingCompleted event. + + :ivar timestamp: The time at which the event occurred. + :vartype timestamp: ~datetime.datetime + :ivar name: The name of this event. + :vartype name: str + :ivar status: The status of this event. Failed or succeeded. + :vartype status: str + """ + + timestamp: datetime.datetime + """The time at which the event occurred.""" + name: str + """The name of this event.""" + status: str + """The status of this event. Failed or succeeded.""" + + +class RedisScalingCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Cache.ScalingCompleted event. + + :ivar timestamp: The time at which the event occurred. + :vartype timestamp: ~datetime.datetime + :ivar name: The name of this event. + :vartype name: str + :ivar status: The status of this event. Failed or succeeded. + :vartype status: str + """ + + timestamp: datetime.datetime + """The time at which the event occurred.""" + name: str + """The name of this event.""" + status: str + """The status of this event. Failed or succeeded.""" + + +class ResourceActionCancelEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionCancel + event. This is raised when a resource action operation is canceled. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceActionFailureEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action + operation fails. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceActionSuccessEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action + operation succeeds. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceAuthorization(TypedDict, total=False): + """The details of the authorization for the resource. + + :ivar scope: The scope of the authorization. + :vartype scope: str + :ivar action: The action being requested. + :vartype action: str + :ivar evidence: The evidence for the authorization. Required. + :vartype evidence: dict[str, str] + """ + + scope: str + """The scope of the authorization.""" + action: str + """The action being requested.""" + evidence: Required[dict[str, str]] + """The evidence for the authorization. Required.""" + + +class ResourceDeleteCancelEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteCancel + event. This is raised when a resource delete operation is canceled. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceDeleteFailureEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete + operation fails. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceDeleteSuccessEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete + operation succeeds. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceHttpRequest(TypedDict, total=False): + """The details of the HTTP request. + + :ivar client_request_id: The client request ID. + :vartype client_request_id: str + :ivar client_ip_address: The client IP address. + :vartype client_ip_address: str + :ivar method: The request method. + :vartype method: str + :ivar url: The url used in the request. + :vartype url: str + """ + + clientRequestId: str + """The client request ID.""" + clientIpAddress: str + """The client IP address.""" + method: str + """The request method.""" + url: str + """The url used in the request.""" + + +class ResourceNotificationsResourceUpdatedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Describes the schema of the common properties across all ARN system topic events. + + :ivar resource_details: resourceInfo details for update event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceUpdatedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + :ivar api_version: api version of the resource properties bag. Required. + :vartype api_version: str + """ + + resourceInfo: Required["ResourceNotificationsResourceUpdatedDetails"] + """resourceInfo details for update event. Required.""" + operationalInfo: Required["ResourceNotificationsOperationalDetails"] + """details about operational info. Required.""" + apiVersion: Required[str] + """api version of the resource properties bag. Required.""" + + +class ResourceNotificationsContainerServiceEventResourcesScheduledEventData( + ResourceNotificationsResourceUpdatedEventData +): # pylint: disable=name-too-long + """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. + + :ivar resource_details: resourceInfo details for update event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceUpdatedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + :ivar api_version: api version of the resource properties bag. Required. + :vartype api_version: str + """ + + +class ResourceNotificationsHealthResourcesAnnotatedEventData( + ResourceNotificationsResourceUpdatedEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ResourceNotifications.HealthResources.ResourceAnnotated event. + + :ivar resource_details: resourceInfo details for update event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceUpdatedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + :ivar api_version: api version of the resource properties bag. Required. + :vartype api_version: str + """ + + +class ResourceNotificationsHealthResourcesAvailabilityStatusChangedEventData( + ResourceNotificationsResourceUpdatedEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ResourceNotifications.HealthResources.AvailabilityStatusChanged event. + + :ivar resource_details: resourceInfo details for update event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceUpdatedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + :ivar api_version: api version of the resource properties bag. Required. + :vartype api_version: str + """ + + +class ResourceNotificationsOperationalDetails(TypedDict, total=False): + """details of operational info. + + :ivar resource_event_time: Date and Time when resource was updated. Required. + :vartype resource_event_time: ~datetime.datetime + """ + + resourceEventTime: Required[datetime.datetime] + """Date and Time when resource was updated. Required.""" + + +class ResourceNotificationsResourceDeletedDetails(TypedDict, total=False): # pylint: disable=name-too-long + """Describes the schema of the properties under resource info which are common across all ARN + system topic delete events. + + :ivar id: id of the resource for which the event is being emitted. Required. + :vartype id: str + :ivar name: name of the resource for which the event is being emitted. Required. + :vartype name: str + :ivar type: the type of the resource for which the event is being emitted. Required. + :vartype type: str + """ + + id: Required[str] + """id of the resource for which the event is being emitted. Required.""" + name: Required[str] + """name of the resource for which the event is being emitted. Required.""" + type: Required[str] + """the type of the resource for which the event is being emitted. Required.""" + + +class ResourceNotificationsResourceDeletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Describes the schema of the common properties across all ARN system topic delete events. + + :ivar resource_details: resourceInfo details for delete event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceDeletedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + """ + + resourceInfo: Required["ResourceNotificationsResourceDeletedDetails"] + """resourceInfo details for delete event. Required.""" + operationalInfo: Required["ResourceNotificationsOperationalDetails"] + """details about operational info. Required.""" + + +class ResourceNotificationsResourceManagementCreatedOrUpdatedEventData( + ResourceNotificationsResourceUpdatedEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ResourceNotifications.Resources.CreatedOrUpdated event. + + :ivar resource_details: resourceInfo details for update event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceUpdatedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + :ivar api_version: api version of the resource properties bag. Required. + :vartype api_version: str + """ + + +class ResourceNotificationsResourceManagementDeletedEventData( + ResourceNotificationsResourceDeletedEventData +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ResourceNotifications.Resources.Deleted event. + + :ivar resource_details: resourceInfo details for delete event. Required. + :vartype resource_details: ~azure.eventgrid.types.ResourceNotificationsResourceDeletedDetails + :ivar operational_details: details about operational info. Required. + :vartype operational_details: ~azure.eventgrid.types.ResourceNotificationsOperationalDetails + """ + + +class ResourceNotificationsResourceUpdatedDetails(TypedDict, total=False): # pylint: disable=name-too-long + """Describes the schema of the properties under resource info which are common across all ARN + system topic events. + + :ivar id: id of the resource for which the event is being emitted. Required. + :vartype id: str + :ivar name: name of the resource for which the event is being emitted. Required. + :vartype name: str + :ivar type: the type of the resource for which the event is being emitted. Required. + :vartype type: str + :ivar location: the location of the resource for which the event is being emitted. + :vartype location: str + :ivar tags: the tags on the resource for which the event is being emitted. + :vartype tags: dict[str, str] + :ivar properties: properties in the payload of the resource for which the event is being + emitted. + :vartype properties: dict[str, any] + """ + + id: Required[str] + """id of the resource for which the event is being emitted. Required.""" + name: Required[str] + """name of the resource for which the event is being emitted. Required.""" + type: Required[str] + """the type of the resource for which the event is being emitted. Required.""" + location: str + """the location of the resource for which the event is being emitted.""" + tags: dict[str, str] + """the tags on the resource for which the event is being emitted.""" + properties: dict[str, Any] + """properties in the payload of the resource for which the event is being emitted.""" + + +class ResourceWriteCancelEventData(TypedDict, total=False): + """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. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceWriteFailureEventData(TypedDict, total=False): + """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. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ResourceWriteSuccessEventData(TypedDict, total=False): + """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. + + :ivar tenant_id: The tenant ID of the resource. + :vartype tenant_id: str + :ivar subscription_id: The subscription ID of the resource. + :vartype subscription_id: str + :ivar resource_group: The resource group of the resource. + :vartype resource_group: str + :ivar resource_provider: The resource provider performing the operation. + :vartype resource_provider: str + :ivar resource_url: The URI of the resource in the operation. + :vartype resource_url: str + :ivar operation_name: The operation that was performed. + :vartype operation_name: str + :ivar status: The status of the operation. + :vartype status: str + :ivar authorization: The requested authorization for the operation. Required. + :vartype authorization: ~azure.eventgrid.types.ResourceAuthorization + :ivar claims: The properties of the claims. Required. + :vartype claims: dict[str, str] + :ivar correlation_id: An operation ID used for troubleshooting. + :vartype correlation_id: str + :ivar http_request: The details of the operation. Required. + :vartype http_request: ~azure.eventgrid.types.ResourceHttpRequest + """ + + tenantId: str + """The tenant ID of the resource.""" + subscriptionId: str + """The subscription ID of the resource.""" + resourceGroup: str + """The resource group of the resource.""" + resourceProvider: str + """The resource provider performing the operation.""" + resourceUri: str + """The URI of the resource in the operation.""" + operationName: str + """The operation that was performed.""" + status: str + """The status of the operation.""" + authorization: Required["ResourceAuthorization"] + """The requested authorization for the operation. Required.""" + claims: Required[dict[str, str]] + """The properties of the claims. Required.""" + correlationId: str + """An operation ID used for troubleshooting.""" + httpRequest: Required["ResourceHttpRequest"] + """The details of the operation. Required.""" + + +class ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ServiceBus.ActiveMessagesAvailablePeriodicNotifications event. + + :ivar namespace_name: The namespace name of the Microsoft.ServiceBus resource. Required. + :vartype namespace_name: str + :ivar request_uri: The endpoint of the Microsoft.ServiceBus resource. Required. + :vartype request_uri: str + :ivar entity_type: The entity type of the Microsoft.ServiceBus resource. Could be one of + 'queue' or 'subscriber'. Required. + :vartype entity_type: str + :ivar queue_name: The name of the Microsoft.ServiceBus queue. If the entity type is of type + 'subscriber', then this value will be null. Required. + :vartype queue_name: str + :ivar topic_name: The name of the Microsoft.ServiceBus topic. If the entity type is of type + 'queue', then this value will be null. Required. + :vartype topic_name: str + :ivar subscription_name: The name of the Microsoft.ServiceBus topic's subscription. If the + entity type is of type 'queue', then this value will be null. Required. + :vartype subscription_name: str + """ + + namespaceName: Required[str] + """The namespace name of the Microsoft.ServiceBus resource. Required.""" + requestUri: Required[str] + """The endpoint of the Microsoft.ServiceBus resource. Required.""" + entityType: Required[str] + """The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + Required.""" + queueName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + this value will be null. Required.""" + topicName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + value will be null. Required.""" + subscriptionName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + 'queue', then this value will be null. Required.""" + + +class ServiceBusActiveMessagesAvailableWithNoListenersEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event. + + :ivar namespace_name: The namespace name of the Microsoft.ServiceBus resource. Required. + :vartype namespace_name: str + :ivar request_uri: The endpoint of the Microsoft.ServiceBus resource. Required. + :vartype request_uri: str + :ivar entity_type: The entity type of the Microsoft.ServiceBus resource. Could be one of + 'queue' or 'subscriber'. Required. + :vartype entity_type: str + :ivar queue_name: The name of the Microsoft.ServiceBus queue. If the entity type is of type + 'subscriber', then this value will be null. Required. + :vartype queue_name: str + :ivar topic_name: The name of the Microsoft.ServiceBus topic. If the entity type is of type + 'queue', then this value will be null. Required. + :vartype topic_name: str + :ivar subscription_name: The name of the Microsoft.ServiceBus topic's subscription. If the + entity type is of type 'queue', then this value will be null. Required. + :vartype subscription_name: str + """ + + namespaceName: Required[str] + """The namespace name of the Microsoft.ServiceBus resource. Required.""" + requestUri: Required[str] + """The endpoint of the Microsoft.ServiceBus resource. Required.""" + entityType: Required[str] + """The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + Required.""" + queueName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + this value will be null. Required.""" + topicName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + value will be null. Required.""" + subscriptionName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + 'queue', then this value will be null. Required.""" + + +class ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ServiceBus.DeadletterMessagesAvailablePeriodicNotifications event. + + :ivar namespace_name: The namespace name of the Microsoft.ServiceBus resource. Required. + :vartype namespace_name: str + :ivar request_uri: The endpoint of the Microsoft.ServiceBus resource. Required. + :vartype request_uri: str + :ivar entity_type: The entity type of the Microsoft.ServiceBus resource. Could be one of + 'queue' or 'subscriber'. Required. + :vartype entity_type: str + :ivar queue_name: The name of the Microsoft.ServiceBus queue. If the entity type is of type + 'subscriber', then this value will be null. Required. + :vartype queue_name: str + :ivar topic_name: The name of the Microsoft.ServiceBus topic. If the entity type is of type + 'queue', then this value will be null. Required. + :vartype topic_name: str + :ivar subscription_name: The name of the Microsoft.ServiceBus topic's subscription. If the + entity type is of type 'queue', then this value will be null. Required. + :vartype subscription_name: str + """ + + namespaceName: Required[str] + """The namespace name of the Microsoft.ServiceBus resource. Required.""" + requestUri: Required[str] + """The endpoint of the Microsoft.ServiceBus resource. Required.""" + entityType: Required[str] + """The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + Required.""" + queueName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + this value will be null. Required.""" + topicName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + value will be null. Required.""" + subscriptionName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + 'queue', then this value will be null. Required.""" + + +class ServiceBusDeadletterMessagesAvailableWithNoListenersEventData( + TypedDict, total=False +): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListeners event. + + :ivar namespace_name: The namespace name of the Microsoft.ServiceBus resource. Required. + :vartype namespace_name: str + :ivar request_uri: The endpoint of the Microsoft.ServiceBus resource. Required. + :vartype request_uri: str + :ivar entity_type: The entity type of the Microsoft.ServiceBus resource. Could be one of + 'queue' or 'subscriber'. Required. + :vartype entity_type: str + :ivar queue_name: The name of the Microsoft.ServiceBus queue. If the entity type is of type + 'subscriber', then this value will be null. Required. + :vartype queue_name: str + :ivar topic_name: The name of the Microsoft.ServiceBus topic. If the entity type is of type + 'queue', then this value will be null. Required. + :vartype topic_name: str + :ivar subscription_name: The name of the Microsoft.ServiceBus topic's subscription. If the + entity type is of type 'queue', then this value will be null. Required. + :vartype subscription_name: str + """ + + namespaceName: Required[str] + """The namespace name of the Microsoft.ServiceBus resource. Required.""" + requestUri: Required[str] + """The endpoint of the Microsoft.ServiceBus resource. Required.""" + entityType: Required[str] + """The entity type of the Microsoft.ServiceBus resource. Could be one of 'queue' or 'subscriber'. + Required.""" + queueName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus queue. If the entity type is of type 'subscriber', then + this value will be null. Required.""" + topicName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic. If the entity type is of type 'queue', then this + value will be null. Required.""" + subscriptionName: Required[Optional[str]] + """The name of the Microsoft.ServiceBus topic's subscription. If the entity type is of type + 'queue', then this value will be null. Required.""" + + +class SignalRServiceClientConnectionConnectedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.SignalRService.ClientConnectionConnected event. + + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar hub_name: The hub of connected client connection. Required. + :vartype hub_name: str + :ivar connection_id: The connection Id of connected client connection. Required. + :vartype connection_id: str + :ivar user_id: The user Id of connected client connection. + :vartype user_id: str + """ + + timestamp: Required[datetime.datetime] + """The time at which the event occurred. Required.""" + hubName: Required[str] + """The hub of connected client connection. Required.""" + connectionId: Required[str] + """The connection Id of connected client connection. Required.""" + userId: str + """The user Id of connected client connection.""" + + +class SignalRServiceClientConnectionDisconnectedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for a + Microsoft.SignalRService.ClientConnectionDisconnected event. + + :ivar timestamp: The time at which the event occurred. Required. + :vartype timestamp: ~datetime.datetime + :ivar hub_name: The hub of connected client connection. Required. + :vartype hub_name: str + :ivar connection_id: The connection Id of connected client connection. Required. + :vartype connection_id: str + :ivar user_id: The user Id of connected client connection. + :vartype user_id: str + :ivar error_message: The message of error that cause the client connection disconnected. + :vartype error_message: str + """ + + timestamp: Required[datetime.datetime] + """The time at which the event occurred. Required.""" + hubName: Required[str] + """The hub of connected client connection. Required.""" + connectionId: Required[str] + """The connection Id of connected client connection. Required.""" + userId: str + """The user Id of connected client connection.""" + errorMessage: str + """The message of error that cause the client connection disconnected.""" + + +class StorageAsyncOperationInitiatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Storage.AsyncOperationInitiated event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar content_type: The content type of the blob. This is the same as what would be returned in + the Content-Type header from the blob. + :vartype content_type: str + :ivar content_length: The size of the blob in bytes. This is the same as what would be returned + in the Content-Length header from the blob. + :vartype content_length: int + :ivar blob_type: The type of blob. + :vartype blob_type: str + :ivar url: The path to the blob. + :vartype url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + contentType: str + """The content type of the blob. This is the same as what would be returned in the Content-Type + header from the blob.""" + contentLength: int + """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: str + """The type of blob.""" + url: str + """The path to the blob.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageBlobCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobCreated event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar e_tag: The etag of the blob at the time this event was triggered. + :vartype e_tag: str + :ivar content_type: The content type of the blob. This is the same as what would be returned in + the Content-Type header from the blob. + :vartype content_type: str + :ivar content_length: The size of the blob in bytes. This is the same as what would be returned + in the Content-Length header from the blob. + :vartype content_length: int + :ivar content_offset: The offset of the blob in bytes. + :vartype content_offset: int + :ivar blob_type: The type of blob. + :vartype blob_type: str + :ivar access_tier: The current tier of the blob. Required. Known values are: "Hot", "Cool", + "Cold", "Archive", and "Default". + :vartype access_tier: str or ~azure.eventgrid.models.StorageBlobAccessTier + :ivar url: The path to the blob. + :vartype url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + eTag: str + """The etag of the blob at the time this event was triggered.""" + contentType: str + """The content type of the blob. This is the same as what would be returned in the Content-Type + header from the blob.""" + contentLength: int + """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: int + """The offset of the blob in bytes.""" + blobType: str + """The type of blob.""" + accessTier: Required[StorageBlobAccessTier] + """The current tier of the blob. Required. Known values are: \"Hot\", \"Cool\", \"Cold\", + \"Archive\", and \"Default\".""" + url: str + """The path to the blob.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageBlobDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobDeleted event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar content_type: The content type of the blob. This is the same as what would be returned in + the Content-Type header from the blob. + :vartype content_type: str + :ivar blob_type: The type of blob. + :vartype blob_type: str + :ivar url: The path to the blob. + :vartype url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + contentType: str + """The content type of the blob. This is the same as what would be returned in the Content-Type + header from the blob.""" + blobType: str + """The type of blob.""" + url: str + """The path to the blob.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageBlobInventoryPolicyCompletedEventData(TypedDict, total=False): # pylint: disable=name-too-long + """Schema of the Data property of an EventGridEvent for an + Microsoft.Storage.BlobInventoryPolicyCompleted event. + + :ivar schedule_date_time: The time at which inventory policy was scheduled. Required. + :vartype schedule_date_time: ~datetime.datetime + :ivar account_name: The account name for which inventory policy is registered. + :vartype account_name: str + :ivar rule_name: The rule name for inventory policy. + :vartype rule_name: str + :ivar policy_run_status: The status of inventory run, it can be + Succeeded/PartiallySucceeded/Failed. + :vartype policy_run_status: str + :ivar policy_run_status_message: The status message for inventory run. + :vartype policy_run_status_message: str + :ivar policy_run_id: The policy run id for inventory run. + :vartype policy_run_id: str + :ivar manifest_blob_url: The blob URL for manifest file for inventory run. + :vartype manifest_blob_url: str + """ + + scheduleDateTime: Required[datetime.datetime] + """The time at which inventory policy was scheduled. Required.""" + accountName: str + """The account name for which inventory policy is registered.""" + ruleName: str + """The rule name for inventory policy.""" + policyRunStatus: str + """The status of inventory run, it can be Succeeded/PartiallySucceeded/Failed.""" + policyRunStatusMessage: str + """The status message for inventory run.""" + policyRunId: str + """The policy run id for inventory run.""" + manifestBlobUrl: str + """The blob URL for manifest file for inventory run.""" + + +class StorageBlobRenamedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobRenamed event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar source_url: The path to the blob that was renamed. + :vartype source_url: str + :ivar destination_url: The new path to the blob after the rename operation. + :vartype destination_url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + sourceUrl: str + """The path to the blob that was renamed.""" + destinationUrl: str + """The new path to the blob after the rename operation.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageBlobTierChangedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.BlobTierChanged event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar content_type: The content type of the blob. This is the same as what would be returned in + the Content-Type header from the blob. + :vartype content_type: str + :ivar content_length: The size of the blob in bytes. This is the same as what would be returned + in the Content-Length header from the blob. + :vartype content_length: int + :ivar blob_type: The type of blob. + :vartype blob_type: str + :ivar access_tier: The current tier of the blob. Required. Known values are: "Hot", "Cool", + "Cold", "Archive", and "Default". + :vartype access_tier: str or ~azure.eventgrid.models.StorageBlobAccessTier + :ivar previous_tier: The previous tier of the blob. Required. Known values are: "Hot", "Cool", + "Cold", "Archive", and "Default". + :vartype previous_tier: str or ~azure.eventgrid.models.StorageBlobAccessTier + :ivar url: The path to the blob. + :vartype url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + contentType: str + """The content type of the blob. This is the same as what would be returned in the Content-Type + header from the blob.""" + contentLength: int + """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: str + """The type of blob.""" + accessTier: Required[StorageBlobAccessTier] + """The current tier of the blob. Required. Known values are: \"Hot\", \"Cool\", \"Cold\", + \"Archive\", and \"Default\".""" + previousTier: Required[StorageBlobAccessTier] + """The previous tier of the blob. Required. Known values are: \"Hot\", \"Cool\", \"Cold\", + \"Archive\", and \"Default\".""" + url: str + """The path to the blob.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageDirectoryCreatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryCreated + event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar e_tag: The etag of the directory at the time this event was triggered. + :vartype e_tag: str + :ivar url: The path to the directory. + :vartype url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + eTag: str + """The etag of the directory at the time this event was triggered.""" + url: str + """The path to the directory.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageDirectoryDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryDeleted + event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar url: The path to the deleted directory. + :vartype url: str + :ivar recursive: Is this event for a recursive delete operation. + :vartype recursive: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + url: str + """The path to the deleted directory.""" + recursive: str + """Is this event for a recursive delete operation.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageDirectoryRenamedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Storage.DirectoryRenamed + event. + + :ivar api: The name of the API/operation that triggered this event. + :vartype api: str + :ivar client_request_id: A request id provided by the client of the storage API operation that + triggered this event. + :vartype client_request_id: str + :ivar request_id: The request id generated by the storage service for the storage API operation + that triggered this event. + :vartype request_id: str + :ivar source_url: The path to the directory that was renamed. + :vartype source_url: str + :ivar destination_url: The new path to the directory after the rename operation. + :vartype destination_url: str + :ivar sequencer: 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. + :vartype sequencer: str + :ivar identity: The identity of the requester that triggered this event. + :vartype identity: str + :ivar storage_diagnostics: For service use only. Diagnostic data occasionally included by the + Azure Storage service. This property should be ignored by event consumers. Required. + :vartype storage_diagnostics: dict[str, any] + """ + + api: str + """The name of the API/operation that triggered this event.""" + clientRequestId: str + """A request id provided by the client of the storage API operation that triggered this event.""" + requestId: str + """The request id generated by the storage service for the storage API operation that triggered + this event.""" + sourceUrl: str + """The path to the directory that was renamed.""" + destinationUrl: str + """The new path to the directory after the rename operation.""" + sequencer: str + """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: str + """The identity of the requester that triggered this event.""" + storageDiagnostics: Required[dict[str, Any]] + """For service use only. Diagnostic data occasionally included by the Azure Storage service. This + property should be ignored by event consumers. Required.""" + + +class StorageLifecyclePolicyActionSummaryDetail(TypedDict, total=False): # pylint: disable=name-too-long + """Execution statistics of a specific policy action in a Blob Management cycle. + + :ivar total_objects_count: Total number of objects to be acted on by this action. + :vartype total_objects_count: int + :ivar success_count: Number of success operations of this action. + :vartype success_count: int + :ivar error_list: Error messages of this action if any. + :vartype error_list: str + """ + + totalObjectsCount: int + """Total number of objects to be acted on by this action.""" + successCount: int + """Number of success operations of this action.""" + errorList: str + """Error messages of this action if any.""" + + +class StorageLifecyclePolicyCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Storage.LifecyclePolicyCompleted event. + + :ivar schedule_time: The time the policy task was scheduled. + :vartype schedule_time: str + :ivar policy_run_summary: Policy execution summary which shows the completion status of a LCM + run". Required. + :vartype policy_run_summary: ~azure.eventgrid.types.StorageLifecyclePolicyRunSummary + :ivar delete_summary: Execution statistics of a specific policy action in a Blob Management + cycle. Required. + :vartype delete_summary: ~azure.eventgrid.types.StorageLifecyclePolicyActionSummaryDetail + :ivar tier_to_cool_summary: Execution statistics of a specific policy action in a Blob + Management cycle. Required. + :vartype tier_to_cool_summary: ~azure.eventgrid.types.StorageLifecyclePolicyActionSummaryDetail + :ivar tier_to_archive_summary: Execution statistics of a specific policy action in a Blob + Management cycle. Required. + :vartype tier_to_archive_summary: + ~azure.eventgrid.types.StorageLifecyclePolicyActionSummaryDetail + :ivar tier_to_cold_summary: Execution statistics of a specific policy action in a Blob + Management cycle. Required. + :vartype tier_to_cold_summary: ~azure.eventgrid.types.StorageLifecyclePolicyActionSummaryDetail + """ + + scheduleTime: str + """The time the policy task was scheduled.""" + policyRunSummary: Required["StorageLifecyclePolicyRunSummary"] + """Policy execution summary which shows the completion status of a LCM run\". Required.""" + deleteSummary: Required["StorageLifecyclePolicyActionSummaryDetail"] + """Execution statistics of a specific policy action in a Blob Management cycle. Required.""" + tierToCoolSummary: Required["StorageLifecyclePolicyActionSummaryDetail"] + """Execution statistics of a specific policy action in a Blob Management cycle. Required.""" + tierToArchiveSummary: Required["StorageLifecyclePolicyActionSummaryDetail"] + """Execution statistics of a specific policy action in a Blob Management cycle. Required.""" + tierToColdSummary: Required["StorageLifecyclePolicyActionSummaryDetail"] + """Execution statistics of a specific policy action in a Blob Management cycle. Required.""" + + +class StorageLifecyclePolicyRunSummary(TypedDict, total=False): + """Policy run status of an account in a Blob Management cycle. + + :ivar completion_status: Policy status can be Completed/CompletedWithError/Incomplete. + Required. Known values are: "Completed", "CompletedWithError", and "Incomplete". + :vartype completion_status: str or ~azure.eventgrid.models.StorageLifecycleCompletionStatus + """ + + completionStatus: Required[StorageLifecycleCompletionStatus] + """Policy status can be Completed/CompletedWithError/Incomplete. Required. Known values are: + \"Completed\", \"CompletedWithError\", and \"Incomplete\".""" + + +class StorageTaskAssignmentCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for an + Microsoft.Storage.StorageTaskAssignmentCompleted event. + + :ivar status: The status for a storage task. Required. Known values are: "Succeeded" and + "Failed". + :vartype status: str or ~azure.eventgrid.models.StorageTaskAssignmentCompletedStatus + :ivar completed_on: The time at which a storage task was completed. Required. + :vartype completed_on: ~datetime.datetime + :ivar task_execution_id: The execution id for a storage task. + :vartype task_execution_id: str + :ivar task_name: The task name for a storage task. + :vartype task_name: str + :ivar summary_report_blob_url: The summary report blob url for a storage task. Required. + :vartype summary_report_blob_url: str + """ + + status: Required[StorageTaskAssignmentCompletedStatus] + """The status for a storage task. Required. Known values are: \"Succeeded\" and \"Failed\".""" + completedDateTime: Required[datetime.datetime] + """The time at which a storage task was completed. Required.""" + taskExecutionId: str + """The execution id for a storage task.""" + taskName: str + """The task name for a storage task.""" + summaryReportBlobUrl: Required[str] + """The summary report blob url for a storage task. Required.""" + + +class StorageTaskAssignmentQueuedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for an + Microsoft.Storage.StorageTaskAssignmentQueued event. + + :ivar queued_on: The time at which a storage task was queued. Required. + :vartype queued_on: ~datetime.datetime + :ivar task_execution_id: The execution id for a storage task. + :vartype task_execution_id: str + """ + + queuedDateTime: Required[datetime.datetime] + """The time at which a storage task was queued. Required.""" + taskExecutionId: str + """The execution id for a storage task.""" + + +class StorageTaskCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskCompleted + event. + + :ivar status: The status for a storage task. Required. Known values are: "Succeeded" and + "Failed". + :vartype status: str or ~azure.eventgrid.models.StorageTaskCompletedStatus + :ivar completed_date_time: The time at which a storage task was completed. Required. + :vartype completed_date_time: ~datetime.datetime + :ivar task_execution_id: The execution id for a storage task. + :vartype task_execution_id: str + :ivar task_name: The task name for a storage task. + :vartype task_name: str + :ivar summary_report_blob_url: The summary report blob url for a storage task. Required. + :vartype summary_report_blob_url: str + """ + + status: Required[StorageTaskCompletedStatus] + """The status for a storage task. Required. Known values are: \"Succeeded\" and \"Failed\".""" + completedDateTime: Required[datetime.datetime] + """The time at which a storage task was completed. Required.""" + taskExecutionId: str + """The execution id for a storage task.""" + taskName: str + """The task name for a storage task.""" + summaryReportBlobUrl: Required[str] + """The summary report blob url for a storage task. Required.""" + + +class StorageTaskQueuedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for an Microsoft.Storage.StorageTaskQueued + event. + + :ivar queued_date_time: The time at which a storage task was queued. Required. + :vartype queued_date_time: ~datetime.datetime + :ivar task_execution_id: The execution id for a storage task. + :vartype task_execution_id: str + """ + + queuedDateTime: Required[datetime.datetime] + """The time at which a storage task was queued. Required.""" + taskExecutionId: str + """The execution id for a storage task.""" + + +class SubscriptionDeletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.EventGrid.SubscriptionDeletedEvent event. + + :ivar event_subscription_id: The Azure resource ID of the deleted event subscription. Required. + :vartype event_subscription_id: str + """ + + eventSubscriptionId: Required[str] + """The Azure resource ID of the deleted event subscription. Required.""" + + +class SubscriptionValidationEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.EventGrid.SubscriptionValidationEvent event. + + :ivar validation_code: The validation code sent by Azure Event Grid to validate an event + subscription. To complete the validation handshake, the subscriber must either respond with + this validation code as part of the validation response, or perform a GET request on the + validationUrl (available starting version 2018-05-01-preview). Required. + :vartype validation_code: str + :ivar validation_url: The validation URL sent by Azure Event Grid (available starting version + 2018-05-01-preview). To complete the validation handshake, the subscriber must either respond + with the validationCode as part of the validation response, or perform a GET request on the + validationUrl (available starting version 2018-05-01-preview). Required. + :vartype validation_url: str + """ + + validationCode: Required[str] + """The validation code sent by Azure Event Grid to validate an event subscription. To complete the + validation handshake, the subscriber must either respond with this validation code as part of + the validation response, or perform a GET request on the validationUrl (available starting + version 2018-05-01-preview). Required.""" + validationUrl: Required[str] + """The validation URL sent by Azure Event Grid (available starting version 2018-05-01-preview). To + complete the validation handshake, the subscriber must either respond with the validationCode + as part of the validation response, or perform a GET request on the validationUrl (available + starting version 2018-05-01-preview). Required.""" + + +class SubscriptionValidationResponse(TypedDict, total=False): + """To complete an event subscription validation handshake, a subscriber can use either the + validationCode or the validationUrl received in a SubscriptionValidationEvent. When the + validationCode is used, the SubscriptionValidationResponse can be used to build the response. + + :ivar validation_response: The validation response sent by the subscriber to Azure Event Grid + to complete the validation of an event subscription. Required. + :vartype validation_response: str + """ + + validationResponse: Required[str] + """The validation response sent by the subscriber to Azure Event Grid to complete the validation + of an event subscription. Required.""" + + +class WebAppServicePlanUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppServicePlanUpdated + event. + + :ivar app_service_plan_event_type_detail: Detail of action on the app service plan. + :vartype app_service_plan_event_type_detail: + ~azure.eventgrid.types.AppServicePlanEventTypeDetail + :ivar sku: sku of app service plan. + :vartype sku: ~azure.eventgrid.types.WebAppServicePlanUpdatedEventDataSku + :ivar name: name of the app service plan that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the app service + plan API operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + app service plan API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the app service plan API + operation that triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appServicePlanEventTypeDetail: "AppServicePlanEventTypeDetail" + """Detail of action on the app service plan.""" + sku: "WebAppServicePlanUpdatedEventDataSku" + """sku of app service plan.""" + name: str + """name of the app service plan that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the app service plan API operation that + triggered this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the app service plan API operation + that triggered this event.""" + requestId: str + """The request id generated by the app service for the app service plan API operation that + triggered this event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebAppServicePlanUpdatedEventDataSku(TypedDict, total=False): + """sku of app service plan. + + :ivar name: name of app service plan sku. + :vartype name: str + :ivar tier: tier of app service plan sku. + :vartype tier: str + :ivar size: size of app service plan sku. + :vartype size: str + :ivar family: family of app service plan sku. + :vartype family: str + :ivar capacity: capacity of app service plan sku. + :vartype capacity: str + """ + + name: str + """name of app service plan sku.""" + Tier: str + """tier of app service plan sku.""" + Size: str + """size of app service plan sku.""" + Family: str + """family of app service plan sku.""" + Capacity: str + """capacity of app service plan sku.""" + + +class WebAppUpdatedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.AppUpdated event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebBackupOperationCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationCompleted + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebBackupOperationFailedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationFailed + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebBackupOperationStartedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.BackupOperationStarted + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebRestoreOperationCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationCompleted + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebRestoreOperationFailedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationFailed + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebRestoreOperationStartedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.RestoreOperationStarted + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebSlotSwapCompletedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapCompleted event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebSlotSwapFailedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapFailed event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebSlotSwapStartedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapStarted event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebSlotSwapWithPreviewCancelledEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a + Microsoft.Web.SlotSwapWithPreviewCancelled event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation.""" + + +class WebSlotSwapWithPreviewStartedEventData(TypedDict, total=False): + """Schema of the Data property of an EventGridEvent for a Microsoft.Web.SlotSwapWithPreviewStarted + event. + + :ivar app_event_type_detail: Detail of action on the app. + :vartype app_event_type_detail: ~azure.eventgrid.types.AppEventTypeDetail + :ivar name: name of the web site that had this event. + :vartype name: str + :ivar client_request_id: The client request id generated by the app service for the site API + operation that triggered this event. + :vartype client_request_id: str + :ivar correlation_request_id: The correlation request id generated by the app service for the + site API operation that triggered this event. + :vartype correlation_request_id: str + :ivar request_id: The request id generated by the app service for the site API operation that + triggered this event. + :vartype request_id: str + :ivar address: HTTP request URL of this operation. + :vartype address: str + :ivar verb: HTTP verb of this operation. + :vartype verb: str + """ + + appEventTypeDetail: "AppEventTypeDetail" + """Detail of action on the app.""" + name: str + """name of the web site that had this event.""" + clientRequestId: str + """The client request id generated by the app service for the site API operation that triggered + this event.""" + correlationRequestId: str + """The correlation request id generated by the app service for the site API operation that + triggered this event.""" + requestId: str + """The request id generated by the app service for the site API operation that triggered this + event.""" + address: str + """HTTP request URL of this operation.""" + verb: str + """HTTP verb of this operation."""