azure.eventgrid.models module

class azure.eventgrid.models.ACSChatEventBaseProperties(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of common properties of all chat events.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

class azure.eventgrid.models.ACSChatMemberAddedToThreadWithUserEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, time: Optional[datetime.datetime] = None, added_by: Optional[str] = None, member_added: Optional[ACSChatThreadMemberProperties] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatThreadEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberAddedToThreadWithUser event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

  • time (datetime) – The time at which the user was added to the thread.

  • added_by (str) – The MRI of the user who added the user.

  • member_added (ACSChatThreadMemberProperties) – The details of the user who was added.

class azure.eventgrid.models.ACSChatMemberRemovedFromThreadWithUserEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, time: Optional[datetime.datetime] = None, removed_by: Optional[str] = None, member_removed: Optional[ACSChatThreadMemberProperties] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatThreadEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberRemovedFromThreadWithUser event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

  • time (datetime) – The time at which the user was removed to the thread.

  • removed_by (str) – The MRI of the user who removed the user.

  • member_removed (ACSChatThreadMemberProperties) – The details of the user who was removed.

class azure.eventgrid.models.ACSChatMessageDeletedEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, message_id: Optional[str] = None, sender_id: Optional[str] = None, sender_display_name: Optional[str] = None, compose_time: Optional[datetime.datetime] = None, type: Optional[str] = None, version: Optional[int] = None, delete_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatMessageEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageDeleted event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • message_id (str) – The chat message id.

  • sender_id (str) – The MRI of the sender.

  • sender_display_name (str) – The display name of the sender.

  • compose_time (datetime) – The original compose time of the message.

  • type (str) – The type of the message.

  • version (int) – The version of the message.

  • delete_time (datetime) – The time at which the message was deleted.

class azure.eventgrid.models.ACSChatMessageEditedEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, message_id: Optional[str] = None, sender_id: Optional[str] = None, sender_display_name: Optional[str] = None, compose_time: Optional[datetime.datetime] = None, type: Optional[str] = None, version: Optional[int] = None, message_body: Optional[str] = None, edit_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatMessageEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageEdited event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • message_id (str) – The chat message id.

  • sender_id (str) – The MRI of the sender.

  • sender_display_name (str) – The display name of the sender.

  • compose_time (datetime) – The original compose time of the message.

  • type (str) – The type of the message.

  • version (int) – The version of the message.

  • message_body (str) – The body of the chat message.

  • edit_time (datetime) – The time at which the message was edited.

class azure.eventgrid.models.ACSChatMessageEventBaseProperties(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, message_id: Optional[str] = None, sender_id: Optional[str] = None, sender_display_name: Optional[str] = None, compose_time: Optional[datetime.datetime] = None, type: Optional[str] = None, version: Optional[int] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatEventBaseProperties

Schema of common properties of all chat message events.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • message_id (str) – The chat message id.

  • sender_id (str) – The MRI of the sender.

  • sender_display_name (str) – The display name of the sender.

  • compose_time (datetime) – The original compose time of the message.

  • type (str) – The type of the message.

  • version (int) – The version of the message.

class azure.eventgrid.models.ACSChatMessageReceivedEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, message_id: Optional[str] = None, sender_id: Optional[str] = None, sender_display_name: Optional[str] = None, compose_time: Optional[datetime.datetime] = None, type: Optional[str] = None, version: Optional[int] = None, message_body: Optional[str] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatMessageEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageReceived event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • message_id (str) – The chat message id.

  • sender_id (str) – The MRI of the sender.

  • sender_display_name (str) – The display name of the sender.

  • compose_time (datetime) – The original compose time of the message.

  • type (str) – The type of the message.

  • version (int) – The version of the message.

  • message_body (str) – The body of the chat message.

class azure.eventgrid.models.ACSChatThreadCreatedWithUserEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, created_by: Optional[str] = None, properties: Optional[Dict[str, object]] = None, members: Optional[List[ACSChatThreadMemberProperties]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatThreadEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadCreatedWithUser event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

  • created_by (str) – The MRI of the creator of the thread.

  • properties (dict[str, object]) – The thread properties.

  • members (list[ACSChatThreadMemberProperties]) – The list of properties of users who are part of the thread.

class azure.eventgrid.models.ACSChatThreadEventBaseProperties(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatEventBaseProperties

Schema of common properties of all chat thread events.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

class azure.eventgrid.models.ACSChatThreadMemberProperties(*, display_name: Optional[str] = None, member_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the chat thread member.

Parameters
  • display_name (str) – The name of the user.

  • member_id (str) – The MRI of the user.

class azure.eventgrid.models.ACSChatThreadPropertiesUpdatedPerUserEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, edited_by: Optional[str] = None, edit_time: Optional[datetime.datetime] = None, properties: Optional[Dict[str, object]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatThreadEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

  • edited_by (str) – The MRI of the user who updated the thread properties.

  • edit_time (datetime) – The time at which the properties of the thread were updated.

  • properties (dict[str, object]) – The updated thread properties.

class azure.eventgrid.models.ACSChatThreadWithUserDeletedEventData(*, recipient_id: Optional[str] = None, transaction_id: Optional[str] = None, thread_id: Optional[str] = None, create_time: Optional[datetime.datetime] = None, version: Optional[int] = None, deleted_by: Optional[str] = None, delete_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSChatThreadEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadWithUserDeleted event.

Parameters
  • recipient_id (str) – The MRI of the target user.

  • transaction_id (str) – The transaction id will be used as co-relation vector.

  • thread_id (str) – The chat thread id.

  • create_time (datetime) – The original creation time of the thread.

  • version (int) – The version of the thread.

  • deleted_by (str) – The MRI of the user who deleted the thread.

  • delete_time (datetime) – The deletion time of the thread.

class azure.eventgrid.models.ACSSMSDeliveryAttemptProperties(*, timestamp: Optional[datetime.datetime] = None, segments_succeeded: Optional[int] = None, segments_failed: Optional[int] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema for details of a delivery attempt.

Parameters
  • timestamp (datetime) – TimeStamp when delivery was attempted.

  • segments_succeeded (int) – Number of segments that were successfully delivered.

  • segments_failed (int) – Number of segments whose delivery failed.

class azure.eventgrid.models.ACSSMSDeliveryReportReceivedEventData(*, message_id: Optional[str] = None, from_property: Optional[str] = None, to: Optional[str] = None, delivery_status: Optional[str] = None, delivery_status_details: Optional[str] = None, delivery_attempts: Optional[List[ACSSMSDeliveryAttemptProperties]] = None, received_timestamp: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSSMSEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSDeliveryReportReceived event.

Parameters
  • message_id (str) – The identity of the SMS message.

  • from_property (str) – The identity of SMS message sender.

  • to (str) – The identity of SMS message receiver.

  • delivery_status (str) – Status of Delivery.

  • delivery_status_details (str) – Details about Delivery Status.

  • delivery_attempts (list[ACSSMSDeliveryAttemptProperties]) – List of details of delivery attempts made.

  • received_timestamp (datetime) – The time at which the SMS delivery report was received.

class azure.eventgrid.models.ACSSMSEventBaseProperties(*, message_id: Optional[str] = None, from_property: Optional[str] = None, to: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of common properties of all SMS events.

Parameters
  • message_id (str) – The identity of the SMS message.

  • from_property (str) – The identity of SMS message sender.

  • to (str) – The identity of SMS message receiver.

class azure.eventgrid.models.ACSSMSReceivedEventData(*, message_id: Optional[str] = None, from_property: Optional[str] = None, to: Optional[str] = None, message: Optional[str] = None, received_timestamp: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ACSSMSEventBaseProperties

Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSReceived event.

Parameters
  • message_id (str) – The identity of the SMS message.

  • from_property (str) – The identity of SMS message sender.

  • to (str) – The identity of SMS message receiver.

  • message (str) – The SMS content.

  • received_timestamp (datetime) – The time at which the SMS was received.

class azure.eventgrid.models.AppAction(value)[source]

Bases: str, enum.Enum

Type of action of the operation.

CHANGED_APP_SETTINGS = 'ChangedAppSettings'

There was an operation to change app setting on the web app.

COMPLETED = 'Completed'

The job has completed.

FAILED = 'Failed'

The job has failed to complete.

RESTARTED = 'Restarted'

Web app was restarted.

STARTED = 'Started'

The job has started.

STOPPED = 'Stopped'

Web app was stopped.

class azure.eventgrid.models.AppConfigurationKeyValueDeletedEventData(*, key: Optional[str] = None, label: Optional[str] = None, etag: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueDeleted event.

Parameters
  • key (str) – The key used to identify the key-value that was deleted.

  • label (str) – The label, if any, used to identify the key-value that was deleted.

  • etag (str) – The etag representing the key-value that was deleted.

class azure.eventgrid.models.AppConfigurationKeyValueModifiedEventData(*, key: Optional[str] = None, label: Optional[str] = None, etag: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.AppConfiguration.KeyValueModified event.

Parameters
  • key (str) – The key used to identify the key-value that was modified.

  • label (str) – The label, if any, used to identify the key-value that was modified.

  • etag (str) – The etag representing the new state of the key-value.

class azure.eventgrid.models.AppEventTypeDetail(*, action: Optional[Union[str, AppAction]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Detail of action on the app.

Parameters

action (str or AppAction) – Type of action of the operation. Possible values include: “Restarted”, “Stopped”, “ChangedAppSettings”, “Started”, “Completed”, “Failed”.

class azure.eventgrid.models.AppServicePlanAction(value)[source]

Bases: str, enum.Enum

Type of action on the app service plan.

UPDATED = 'Updated'

App Service plan is being updated.

class azure.eventgrid.models.AppServicePlanEventTypeDetail(*, stamp_kind: Optional[Union[str, StampKind]] = None, action: Optional[Union[str, AppServicePlanAction]] = None, status: Optional[Union[str, AsyncStatus]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Detail of action on the app service plan.

Parameters
  • stamp_kind (str or StampKind) – Kind of environment where app service plan is. Possible values include: “Public”, “AseV1”, “AseV2”.

  • action (str or AppServicePlanAction) – Type of action on the app service plan. Possible values include: “Updated”.

  • status (str or AsyncStatus) – Asynchronous operation status of the operation on the app service plan. Possible values include: “Started”, “Completed”, “Failed”.

class azure.eventgrid.models.AsyncStatus(value)[source]

Bases: str, enum.Enum

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

COMPLETED = 'Completed'

Async operation has completed.

FAILED = 'Failed'

Async operation failed to complete.

STARTED = 'Started'

Async operation has started.

class azure.eventgrid.models.ContainerRegistryArtifactEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryArtifactEventTarget] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The content of the event request message.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryArtifactEventTarget) – The target of the event.

class azure.eventgrid.models.ContainerRegistryArtifactEventTarget(*, media_type: Optional[str] = None, size: Optional[int] = None, digest: Optional[str] = None, repository: Optional[str] = None, tag: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The target of the event.

Parameters
  • media_type (str) – The MIME type of the artifact.

  • size (long) – The size in bytes of the artifact.

  • digest (str) – The digest of the artifact.

  • repository (str) – The repository name of the artifact.

  • tag (str) – The tag of the artifact.

  • name (str) – The name of the artifact.

  • version (str) – The version of the artifact.

class azure.eventgrid.models.ContainerRegistryChartDeletedEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryArtifactEventTarget] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ContainerRegistryArtifactEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryArtifactEventTarget) – The target of the event.

class azure.eventgrid.models.ContainerRegistryChartPushedEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryArtifactEventTarget] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ContainerRegistryArtifactEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryArtifactEventTarget) – The target of the event.

class azure.eventgrid.models.ContainerRegistryEventActor(*, name: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The agent that initiated the event. For most situations, this could be from the authorization context of the request.

Parameters

name (str) – The subject or username associated with the request context that generated the event.

class azure.eventgrid.models.ContainerRegistryEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryEventTarget] = None, request: Optional[ContainerRegistryEventRequest] = None, actor: Optional[ContainerRegistryEventActor] = None, source: Optional[ContainerRegistryEventSource] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The content of the event request message.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryEventTarget) – The target of the event.

  • 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.

class azure.eventgrid.models.ContainerRegistryEventRequest(*, id: Optional[str] = None, addr: Optional[str] = None, host: Optional[str] = None, method: Optional[str] = None, useragent: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The request that generated the event.

Parameters
  • id (str) – The ID of the request that initiated the event.

  • 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 (str) – The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests.

  • method (str) – The request method that generated the event.

  • useragent (str) – The user agent header of the request.

class azure.eventgrid.models.ContainerRegistryEventSource(*, addr: Optional[str] = None, instance_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it.

Parameters
  • 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.

  • instance_id (str) – The running instance of an application. Changes after each restart.

class azure.eventgrid.models.ContainerRegistryEventTarget(*, media_type: Optional[str] = None, size: Optional[int] = None, digest: Optional[str] = None, length: Optional[int] = None, repository: Optional[str] = None, url: Optional[str] = None, tag: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The target of the event.

Parameters
  • media_type (str) – The MIME type of the referenced object.

  • size (long) – 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 (long) – The number of bytes of the content. Same as Size field.

  • repository (str) – The repository name.

  • url (str) – The direct URL to the content.

  • tag (str) – The tag name.

class azure.eventgrid.models.ContainerRegistryImageDeletedEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryEventTarget] = None, request: Optional[ContainerRegistryEventRequest] = None, actor: Optional[ContainerRegistryEventActor] = None, source: Optional[ContainerRegistryEventSource] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ContainerRegistryEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImageDeleted event.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryEventTarget) – The target of the event.

  • 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.

class azure.eventgrid.models.ContainerRegistryImagePushedEventData(*, id: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, action: Optional[str] = None, target: Optional[ContainerRegistryEventTarget] = None, request: Optional[ContainerRegistryEventRequest] = None, actor: Optional[ContainerRegistryEventActor] = None, source: Optional[ContainerRegistryEventSource] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.ContainerRegistryEventData

Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ImagePushed event.

Parameters
  • id (str) – The event ID.

  • timestamp (datetime) – The time at which the event occurred.

  • action (str) – The action that encompasses the provided event.

  • target (ContainerRegistryEventTarget) – The target of the event.

  • 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.

class azure.eventgrid.models.DeviceConnectionStateEventInfo(*, sequence_number: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Information about the device connection state event.

Parameters

sequence_number (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.

class azure.eventgrid.models.DeviceConnectionStateEventProperties(*, device_id: Optional[str] = None, module_id: Optional[str] = None, hub_name: Optional[str] = None, device_connection_state_event_info: Optional[DeviceConnectionStateEventInfo] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a device connection state event (DeviceConnected, DeviceDisconnected).

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • module_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.

class azure.eventgrid.models.DeviceLifeCycleEventProperties(*, device_id: Optional[str] = None, hub_name: Optional[str] = None, twin: Optional[DeviceTwinInfo] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a device life cycle event (DeviceCreated, DeviceDeleted).

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.

class azure.eventgrid.models.DeviceTelemetryEventProperties(*, body: Optional[object] = None, properties: Optional[Dict[str, str]] = None, system_properties: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a device telemetry event (DeviceTelemetry).

Parameters
  • body (object) – The content of the message from the device.

  • properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.

  • system_properties (dict[str, str]) – System properties help identify contents and source of the messages.

class azure.eventgrid.models.DeviceTwinInfo(*, authentication_type: Optional[str] = None, cloud_to_device_message_count: Optional[float] = None, connection_state: Optional[str] = None, device_id: Optional[str] = None, etag: Optional[str] = None, last_activity_time: Optional[str] = None, properties: Optional[DeviceTwinInfoProperties] = None, status: Optional[str] = None, status_update_time: Optional[str] = None, version: Optional[float] = None, x509_thumbprint: Optional[DeviceTwinInfoX509Thumbprint] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Information about the device twin, which is the cloud representation of application device metadata.

Parameters
  • authentication_type (str) – Authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority.

  • cloud_to_device_message_count (float) – Count of cloud to device messages sent to this device.

  • connection_state (str) – Whether the device is connected or disconnected.

  • device_id (str) – The unique identifier of the device twin.

  • etag (str) – A piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin.

  • last_activity_time (str) – The ISO8601 timestamp of the last activity.

  • properties (DeviceTwinInfoProperties) – Properties JSON element.

  • status (str) – Whether the device twin is enabled or disabled.

  • status_update_time (str) – The ISO8601 timestamp of the last device twin status update.

  • version (float) – An integer that is incremented by one each time the device twin is updated.

  • x509_thumbprint (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.

class azure.eventgrid.models.DeviceTwinInfoProperties(*, desired: Optional[DeviceTwinProperties] = None, reported: Optional[DeviceTwinProperties] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties JSON element.

Parameters
  • desired (DeviceTwinProperties) – A portion of the properties that can be written only by the application back- end, and read by the device.

  • reported (DeviceTwinProperties) – A portion of the properties that can be written only by the device, and read by the application back-end.

class azure.eventgrid.models.DeviceTwinInfoX509Thumbprint(*, primary_thumbprint: Optional[str] = None, secondary_thumbprint: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters
  • primary_thumbprint (str) – Primary thumbprint for the x509 certificate.

  • secondary_thumbprint (str) – Secondary thumbprint for the x509 certificate.

class azure.eventgrid.models.DeviceTwinMetadata(*, last_updated: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metadata information for the properties JSON document.

Parameters

last_updated (str) – The ISO8601 timestamp of the last time the properties were updated.

class azure.eventgrid.models.DeviceTwinProperties(*, metadata: Optional[DeviceTwinMetadata] = None, version: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A portion of the properties that can be written only by the application back-end, and read by the device.

Parameters
  • metadata (DeviceTwinMetadata) – Metadata information for the properties JSON document.

  • version (float) – Version of device twin properties.

class azure.eventgrid.models.EventHubCaptureFileCreatedEventData(*, fileurl: Optional[str] = None, file_type: Optional[str] = None, partition_id: Optional[str] = None, size_in_bytes: Optional[int] = None, event_count: Optional[int] = None, first_sequence_number: Optional[int] = None, last_sequence_number: Optional[int] = None, first_enqueue_time: Optional[datetime.datetime] = None, last_enqueue_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.EventHub.CaptureFileCreated event.

Parameters
  • fileurl (str) – The path to the capture file.

  • file_type (str) – The file type of the capture file.

  • partition_id (str) – The shard ID.

  • size_in_bytes (int) – The file size.

  • event_count (int) – The number of events in the file.

  • first_sequence_number (int) – The smallest sequence number from the queue.

  • last_sequence_number (int) – The last sequence number from the queue.

  • first_enqueue_time (datetime) – The first time from the queue.

  • last_enqueue_time (datetime) – The last time from the queue.

class azure.eventgrid.models.IotHubDeviceConnectedEventData(*, device_id: Optional[str] = None, module_id: Optional[str] = None, hub_name: Optional[str] = None, device_connection_state_event_info: Optional[DeviceConnectionStateEventInfo] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.DeviceConnectionStateEventProperties

Event data for Microsoft.Devices.DeviceConnected event.

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • module_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.

class azure.eventgrid.models.IotHubDeviceCreatedEventData(*, device_id: Optional[str] = None, hub_name: Optional[str] = None, twin: Optional[DeviceTwinInfo] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.DeviceLifeCycleEventProperties

Event data for Microsoft.Devices.DeviceCreated event.

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.

class azure.eventgrid.models.IotHubDeviceDeletedEventData(*, device_id: Optional[str] = None, hub_name: Optional[str] = None, twin: Optional[DeviceTwinInfo] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.DeviceLifeCycleEventProperties

Event data for Microsoft.Devices.DeviceDeleted event.

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • twin (DeviceTwinInfo) – Information about the device twin, which is the cloud representation of application device metadata.

class azure.eventgrid.models.IotHubDeviceDisconnectedEventData(*, device_id: Optional[str] = None, module_id: Optional[str] = None, hub_name: Optional[str] = None, device_connection_state_event_info: Optional[DeviceConnectionStateEventInfo] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.DeviceConnectionStateEventProperties

Event data for Microsoft.Devices.DeviceDisconnected event.

Parameters
  • device_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • module_id (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: - : . + % _ # * ? ! ( ) , = @ ; $ ‘.

  • hub_name (str) – Name of the IoT Hub where the device was created or deleted.

  • device_connection_state_event_info (DeviceConnectionStateEventInfo) – Information about the device connection state event.

class azure.eventgrid.models.IotHubDeviceTelemetryEventData(*, body: Optional[object] = None, properties: Optional[Dict[str, str]] = None, system_properties: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.DeviceTelemetryEventProperties

Event data for Microsoft.Devices.DeviceTelemetry event.

Parameters
  • body (object) – The content of the message from the device.

  • properties (dict[str, str]) – Application properties are user-defined strings that can be added to the message. These fields are optional.

  • system_properties (dict[str, str]) – System properties help identify contents and source of the messages.

class azure.eventgrid.models.KeyVaultAccessPolicyChangedEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an VaultAccessPolicyChanged event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultCertificateExpiredEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an CertificateExpired event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultCertificateNearExpiryEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an CertificateNearExpiry event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultCertificateNewVersionCreatedEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an CertificateNewVersionCreated event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultKeyExpiredEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an KeyExpired event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultKeyNearExpiryEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an KeyNearExpiry event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultKeyNewVersionCreatedEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an KeyNewVersionCreated event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultSecretExpiredEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an SecretExpired event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultSecretNearExpiryEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an SecretNearExpiry event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.KeyVaultSecretNewVersionCreatedEventData(*, id: Optional[str] = None, vault_name: Optional[str] = None, object_type: Optional[str] = None, object_name: Optional[str] = None, version: Optional[str] = None, nbf: Optional[float] = None, exp: Optional[float] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an SecretNewVersionCreated event.

Parameters
  • id (str) – The id of the object that triggered this event.

  • vault_name (str) – Key vault name of the object that triggered this event.

  • object_type (str) – The type of the object that triggered this event.

  • object_name (str) – The name of the object that triggered this event.

  • version (str) – The version of the object that triggered this event.

  • nbf (float) – Not before date of the object that triggered this event.

  • exp (float) – The expiration date of the object that triggered this event.

class azure.eventgrid.models.MachineLearningServicesDatasetDriftDetectedEventData(*, data_drift_id: Optional[str] = None, data_drift_name: Optional[str] = None, run_id: Optional[str] = None, base_dataset_id: Optional[str] = None, target_dataset_id: Optional[str] = None, drift_coefficient: Optional[float] = None, start_time: Optional[datetime.datetime] = None, end_time: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.DatasetDriftDetected event.

Parameters
  • data_drift_id (str) – The ID of the data drift monitor that triggered the event.

  • data_drift_name (str) – The name of the data drift monitor that triggered the event.

  • run_id (str) – The ID of the Run that detected data drift.

  • base_dataset_id (str) – The ID of the base Dataset used to detect drift.

  • target_dataset_id (str) – The ID of the target Dataset used to detect drift.

  • drift_coefficient (float) – The coefficient result that triggered the event.

  • start_time (datetime) – The start time of the target dataset time series that resulted in drift detection.

  • end_time (datetime) – The end time of the target dataset time series that resulted in drift detection.

class azure.eventgrid.models.MachineLearningServicesModelDeployedEventData(*, service_name: Optional[str] = None, service_compute_type: Optional[str] = None, model_ids: Optional[str] = None, service_tags: Optional[object] = None, service_properties: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelDeployed event.

Parameters
  • service_name (str) – The name of the deployed service.

  • service_compute_type (str) – The compute type (e.g. ACI, AKS) of the deployed service.

  • model_ids (str) – A common separated list of model IDs. The IDs of the models deployed in the service.

  • service_tags (object) – The tags of the deployed service.

  • service_properties (object) – The properties of the deployed service.

class azure.eventgrid.models.MachineLearningServicesModelRegisteredEventData(*, model_name: Optional[str] = None, model_version: Optional[str] = None, model_tags: Optional[object] = None, model_properties: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.ModelRegistered event.

Parameters
  • model_name (str) – The name of the model that was registered.

  • model_version (str) – The version of the model that was registered.

  • model_tags (object) – The tags of the model that was registered.

  • model_properties (object) – The properties of the model that was registered.

class azure.eventgrid.models.MachineLearningServicesRunCompletedEventData(*, experiment_id: Optional[str] = None, experiment_name: Optional[str] = None, run_id: Optional[str] = None, run_type: Optional[str] = None, run_tags: Optional[object] = None, run_properties: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.RunCompleted event.

Parameters
  • experiment_id (str) – The ID of the experiment that the run belongs to.

  • experiment_name (str) – The name of the experiment that the run belongs to.

  • run_id (str) – The ID of the Run that was completed.

  • run_type (str) – The Run Type of the completed Run.

  • run_tags (object) – The tags of the completed Run.

  • run_properties (object) – The properties of the completed Run.

class azure.eventgrid.models.MachineLearningServicesRunStatusChangedEventData(*, experiment_id: Optional[str] = None, experiment_name: Optional[str] = None, run_id: Optional[str] = None, run_type: Optional[str] = None, run_tags: Optional[object] = None, run_properties: Optional[object] = None, run_status: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.MachineLearningServices.RunStatusChanged event.

Parameters
  • experiment_id (str) – The ID of the experiment that the Machine Learning Run belongs to.

  • experiment_name (str) – The name of the experiment that the Machine Learning Run belongs to.

  • run_id (str) – The ID of the Machine Learning Run.

  • run_type (str) – The Run Type of the Machine Learning Run.

  • run_tags (object) – The tags of the Machine Learning Run.

  • run_properties (object) – The properties of the Machine Learning Run.

  • run_status (str) – The status of the Machine Learning Run.

class azure.eventgrid.models.MapsGeofenceEnteredEventData(*, expired_geofence_geometry_id: Optional[List[str]] = None, geometries: Optional[List[MapsGeofenceGeometry]] = None, invalid_period_geofence_geometry_id: Optional[List[str]] = None, is_event_published: Optional[bool] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MapsGeofenceEventProperties

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.

Parameters
  • expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

  • geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

  • invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

  • is_event_published (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.

class azure.eventgrid.models.MapsGeofenceEventProperties(*, expired_geofence_geometry_id: Optional[List[str]] = None, geometries: Optional[List[MapsGeofenceGeometry]] = None, invalid_period_geofence_geometry_id: Optional[List[str]] = None, is_event_published: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).

Parameters
  • expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

  • geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

  • invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

  • is_event_published (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.

class azure.eventgrid.models.MapsGeofenceExitedEventData(*, expired_geofence_geometry_id: Optional[List[str]] = None, geometries: Optional[List[MapsGeofenceGeometry]] = None, invalid_period_geofence_geometry_id: Optional[List[str]] = None, is_event_published: Optional[bool] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MapsGeofenceEventProperties

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.

Parameters
  • expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

  • geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

  • invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

  • is_event_published (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.

class azure.eventgrid.models.MapsGeofenceGeometry(*, device_id: Optional[str] = None, distance: Optional[float] = None, geometry_id: Optional[str] = None, nearest_lat: Optional[float] = None, nearest_lon: Optional[float] = None, ud_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The geofence geometry.

Parameters
  • device_id (str) – ID of the device.

  • distance (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.

  • geometry_id (str) – The unique ID for the geofence geometry.

  • nearest_lat (float) – Latitude of the nearest point of the geometry.

  • nearest_lon (float) – Longitude of the nearest point of the geometry.

  • ud_id (str) – The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.

class azure.eventgrid.models.MapsGeofenceResultEventData(*, expired_geofence_geometry_id: Optional[List[str]] = None, geometries: Optional[List[MapsGeofenceGeometry]] = None, invalid_period_geofence_geometry_id: Optional[List[str]] = None, is_event_published: Optional[bool] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MapsGeofenceEventProperties

Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.

Parameters
  • expired_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

  • geometries (list[MapsGeofenceGeometry]) – Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

  • invalid_period_geofence_geometry_id (list[str]) – Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

  • is_event_published (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.

class azure.eventgrid.models.MediaJobCanceledEventData(*, correlation_data: Optional[Dict[str, str]] = None, outputs: Optional[List[MediaJobOutput]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job canceled event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • correlation_data (dict[str, str]) – Gets the Job correlation data.

  • outputs (list[MediaJobOutput]) – Gets the Job outputs.

class azure.eventgrid.models.MediaJobCancelingEventData(*, correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job canceling event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters

correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobError(**kwargs)[source]

Bases: msrest.serialization.Model

Details of JobOutput errors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • code (str or MediaJobErrorCode) – Error code describing the error. Possible values include: “ServiceError”, “ServiceTransientError”, “DownloadNotAccessible”, “DownloadTransientError”, “UploadNotAccessible”, “UploadTransientError”, “ConfigurationUnsupported”, “ContentMalformed”, “ContentUnsupported”.

  • message (str) – A human-readable language-dependent representation of the error.

  • category (str or MediaJobErrorCategory) – Helps with categorization of errors. Possible values include: “Service”, “Download”, “Upload”, “Configuration”, “Content”.

  • retry (str or MediaJobRetry) – Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. Possible values include: “DoNotRetry”, “MayRetry”.

  • details (list[MediaJobErrorDetail]) – An array of details about specific errors that led to this reported error.

class azure.eventgrid.models.MediaJobErrorCategory(value)[source]

Bases: str, enum.Enum

Helps with categorization of errors.

CONFIGURATION = 'Configuration'

The error is configuration related.

CONTENT = 'Content'

The error is related to data in the input files.

DOWNLOAD = 'Download'

The error is download related.

SERVICE = 'Service'

The error is service related.

UPLOAD = 'Upload'

The error is upload related.

class azure.eventgrid.models.MediaJobErrorCode(value)[source]

Bases: str, enum.Enum

Error code describing the error.

CONFIGURATION_UNSUPPORTED = 'ConfigurationUnsupported'

There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration.

CONTENT_MALFORMED = 'ContentMalformed'

zero byte files, or corrupt/non-decodable files), check the input files.

Type

There was a problem with the input content (for example

CONTENT_UNSUPPORTED = 'ContentUnsupported'

There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files.

DOWNLOAD_NOT_ACCESSIBLE = 'DownloadNotAccessible'

While trying to download the input files, the files were not accessible, please check the availability of the source.

DOWNLOAD_TRANSIENT_ERROR = 'DownloadTransientError'

While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source.

SERVICE_ERROR = 'ServiceError'

Fatal service error, please contact support.

SERVICE_TRANSIENT_ERROR = 'ServiceTransientError'

Transient error, please retry, if retry is unsuccessful, please contact support.

UPLOAD_NOT_ACCESSIBLE = 'UploadNotAccessible'

While trying to upload the output files, the destination was not reachable, please check the availability of the destination.

UPLOAD_TRANSIENT_ERROR = 'UploadTransientError'

While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination.

class azure.eventgrid.models.MediaJobErrorDetail(**kwargs)[source]

Bases: msrest.serialization.Model

Details of JobOutput errors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • code (str) – Code describing the error detail.

  • message (str) – A human-readable representation of the error.

class azure.eventgrid.models.MediaJobErroredEventData(*, correlation_data: Optional[Dict[str, str]] = None, outputs: Optional[List[MediaJobOutput]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job error state event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • correlation_data (dict[str, str]) – Gets the Job correlation data.

  • outputs (list[MediaJobOutput]) – Gets the Job outputs.

class azure.eventgrid.models.MediaJobFinishedEventData(*, correlation_data: Optional[Dict[str, str]] = None, outputs: Optional[List[MediaJobOutput]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job finished event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • correlation_data (dict[str, str]) – Gets the Job correlation data.

  • outputs (list[MediaJobOutput]) – Gets the Job outputs.

class azure.eventgrid.models.MediaJobOutput(*, progress: int, state: Union[str, MediaJobState], error: Optional[MediaJobError] = None, label: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The event data for a Job output.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MediaJobOutputAsset.

All required parameters must be populated in order to send to Azure.

Parameters
  • odata_type (str) – The discriminator for derived types.Constant filled by server.

  • error (MediaJobError) – Gets the Job output error.

  • label (str) – Gets the Job output label.

  • progress (long) – Required. Gets the Job output progress.

  • state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

class azure.eventgrid.models.MediaJobOutputAsset(*, progress: int, state: Union[str, MediaJobState], error: Optional[MediaJobError] = None, label: Optional[str] = None, asset_name: Optional[str] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutput

The event data for a Job output asset.

All required parameters must be populated in order to send to Azure.

Parameters
  • odata_type (str) – The discriminator for derived types.Constant filled by server.

  • error (MediaJobError) – Gets the Job output error.

  • label (str) – Gets the Job output label.

  • progress (long) – Required. Gets the Job output progress.

  • state (str or MediaJobState) – Required. Gets the Job output state. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • asset_name (str) – Gets the Job output asset name.

class azure.eventgrid.models.MediaJobOutputCanceledEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output canceled event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputCancelingEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output canceling event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputErroredEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output error event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputFinishedEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output finished event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputProcessingEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output processing event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputProgressEventData(*, label: Optional[str] = None, progress: Optional[int] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Job Output Progress Event Data.

Parameters
  • label (str) – Gets the Job output label.

  • progress (long) – Gets the Job output progress.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputScheduledEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobOutputStateChangeEventData

Job output scheduled event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobOutputStateChangeEventData(*, output: Optional[MediaJobOutput] = None, job_correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters
  • output (MediaJobOutput) – Gets the output.

  • job_correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobProcessingEventData(*, correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job processing event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters

correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobRetry(value)[source]

Bases: str, enum.Enum

Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.

DO_NOT_RETRY = 'DoNotRetry'

Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected.

MAY_RETRY = 'MayRetry'

Issue may be resolved after waiting for a period of time and resubmitting the same Job.

class azure.eventgrid.models.MediaJobScheduledEventData(*, correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.eventgrid._generated.models._models_py3.MediaJobStateChangeEventData

Job scheduled event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters

correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaJobState(value)[source]

Bases: str, enum.Enum

The previous state of the Job.

CANCELED = 'Canceled'

The job was canceled. This is a final state for the job.

CANCELING = 'Canceling'

The job is in the process of being canceled. This is a transient state for the job.

ERROR = 'Error'

The job has encountered an error. This is a final state for the job.

FINISHED = 'Finished'

The job is finished. This is a final state for the job.

PROCESSING = 'Processing'

The job is processing. This is a transient state for the job.

QUEUED = 'Queued'

The job is in a queued state, waiting for resources to become available. This is a transient state.

SCHEDULED = 'Scheduled'

The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states.

class azure.eventgrid.models.MediaJobStateChangeEventData(*, correlation_data: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobStateChange event.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • previous_state (str or MediaJobState) – The previous state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

  • state (str or MediaJobState) – The new state of the Job. Possible values include: “Canceled”, “Canceling”, “Error”, “Finished”, “Processing”, “Queued”, “Scheduled”.

Parameters

correlation_data (dict[str, str]) – Gets the Job correlation data.

class azure.eventgrid.models.MediaLiveEventConnectionRejectedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Encoder connection rejected event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • ingest_url (str) – Gets the ingest URL provided by the live event.

  • stream_id (str) – Gets the stream Id.

  • encoder_ip (str) – Gets the remote IP.

  • encoder_port (str) – Gets the remote port.

  • result_code (str) – Gets the result code.

class azure.eventgrid.models.MediaLiveEventEncoderConnectedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Encoder connect event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • ingest_url (str) – Gets the ingest URL provided by the live event.

  • stream_id (str) – Gets the stream Id.

  • encoder_ip (str) – Gets the remote IP.

  • encoder_port (str) – Gets the remote port.

class azure.eventgrid.models.MediaLiveEventEncoderDisconnectedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Encoder disconnected event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • ingest_url (str) – Gets the ingest URL provided by the live event.

  • stream_id (str) – Gets the stream Id.

  • encoder_ip (str) – Gets the remote IP.

  • encoder_port (str) – Gets the remote port.

  • result_code (str) – Gets the result code.

class azure.eventgrid.models.MediaLiveEventIncomingDataChunkDroppedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Ingest fragment dropped event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • timestamp (str) – Gets the timestamp of the data chunk dropped.

  • track_type (str) – Gets the type of the track (Audio / Video).

  • bitrate (long) – Gets the bitrate of the track.

  • timescale (str) – Gets the timescale of the Timestamp.

  • result_code (str) – Gets the result code for fragment drop operation.

  • track_name (str) – Gets the name of the track for which fragment is dropped.

class azure.eventgrid.models.MediaLiveEventIncomingStreamReceivedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Encoder connect event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • ingest_url (str) – Gets the ingest URL provided by the live event.

  • track_type (str) – Gets the type of the track (Audio / Video).

  • track_name (str) – Gets the track name.

  • bitrate (long) – Gets the bitrate of the track.

  • encoder_ip (str) – Gets the remote IP.

  • encoder_port (str) – Gets the remote port.

  • timestamp (str) – Gets the first timestamp of the data chunk received.

  • duration (str) – Gets the duration of the first data chunk.

  • timescale (str) – Gets the timescale in which timestamp is represented.

class azure.eventgrid.models.MediaLiveEventIncomingStreamsOutOfSyncEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Incoming streams out of sync event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • min_last_timestamp (str) – Gets the minimum last timestamp received.

  • type_of_stream_with_min_last_timestamp (str) – Gets the type of stream with minimum last timestamp.

  • max_last_timestamp (str) – Gets the maximum timestamp among all the tracks (audio or video).

  • type_of_stream_with_max_last_timestamp (str) – Gets the type of stream with maximum last timestamp.

  • timescale_of_min_last_timestamp (str) – Gets the timescale in which “MinLastTimestamp” is represented.

  • timescale_of_max_last_timestamp (str) – Gets the timescale in which “MaxLastTimestamp” is represented.

class azure.eventgrid.models.MediaLiveEventIncomingVideoStreamsOutOfSyncEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Incoming video stream out of synch event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • first_timestamp (str) – Gets the first timestamp received for one of the quality levels.

  • first_duration (str) – Gets the duration of the data chunk with first timestamp.

  • second_timestamp (str) – Gets the timestamp received for some other quality levels.

  • second_duration (str) – Gets the duration of the data chunk with second timestamp.

  • timescale (str) – Gets the timescale in which both the timestamps and durations are represented.

class azure.eventgrid.models.MediaLiveEventIngestHeartbeatEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Ingest fragment dropped event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • track_type (str) – Gets the type of the track (Audio / Video).

  • track_name (str) – Gets the track name.

  • bitrate (long) – Gets the bitrate of the track.

  • incoming_bitrate (long) – Gets the incoming bitrate.

  • last_timestamp (str) – Gets the last timestamp.

  • timescale (str) – Gets the timescale of the last timestamp.

  • overlap_count (long) – Gets the fragment Overlap count.

  • discontinuity_count (long) – Gets the fragment Discontinuity count.

  • nonincreasing_count (long) – Gets Non increasing count.

  • unexpected_bitrate (bool) – Gets a value indicating whether unexpected bitrate is present or not.

  • state (str) – Gets the state of the live event.

  • healthy (bool) – Gets a value indicating whether preview is healthy or not.

class azure.eventgrid.models.MediaLiveEventTrackDiscontinuityDetectedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Ingest track discontinuity detected event data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • track_type (str) – Gets the type of the track (Audio / Video).

  • track_name (str) – Gets the track name.

  • bitrate (long) – Gets the bitrate.

  • previous_timestamp (str) – Gets the timestamp of the previous fragment.

  • new_timestamp (str) – Gets the timestamp of the current fragment.

  • timescale (str) – Gets the timescale in which both timestamps and discontinuity gap are represented.

  • discontinuity_gap (str) – Gets the discontinuity gap between PreviousTimestamp and NewTimestamp.

class azure.eventgrid.models.RedisExportRDBCompletedEventData(*, timestamp: Optional[datetime.datetime] = None, name: Optional[str] = None, status: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ExportRDBCompleted event.

Parameters
  • timestamp (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 azure.eventgrid.models.RedisImportRDBCompletedEventData(*, timestamp: Optional[datetime.datetime] = None, name: Optional[str] = None, status: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ImportRDBCompleted event.

Parameters
  • timestamp (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 azure.eventgrid.models.RedisPatchingCompletedEventData(*, timestamp: Optional[datetime.datetime] = None, name: Optional[str] = None, status: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Cache.PatchingCompleted event.

Parameters
  • timestamp (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 azure.eventgrid.models.RedisScalingCompletedEventData(*, timestamp: Optional[datetime.datetime] = None, name: Optional[str] = None, status: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Cache.ScalingCompleted event.

Parameters
  • timestamp (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 azure.eventgrid.models.ResourceActionCancelData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceActionCancel event. This is raised when a resource action operation is canceled.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceActionFailureData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionFailure event. This is raised when a resource action operation fails.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceActionSuccessData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceActionSuccess event. This is raised when a resource action operation succeeds.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceDeleteCancelData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Resources.ResourceDeleteCancel event. This is raised when a resource delete operation is canceled.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceDeleteFailureData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteFailure event. This is raised when a resource delete operation fails.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceDeleteSuccessData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.Resources.ResourceDeleteSuccess event. This is raised when a resource delete operation succeeds.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceWriteCancelData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceWriteFailureData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ResourceWriteSuccessData(*, tenant_id: Optional[str] = None, subscription_id: Optional[str] = None, resource_group: Optional[str] = None, resource_provider: Optional[str] = None, resource_uri: Optional[str] = None, operation_name: Optional[str] = None, status: Optional[str] = None, authorization: Optional[str] = None, claims: Optional[str] = None, correlation_id: Optional[str] = None, http_request: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters
  • tenant_id (str) – The tenant ID of the resource.

  • subscription_id (str) – The subscription ID of the resource.

  • resource_group (str) – The resource group of the resource.

  • resource_provider (str) – The resource provider performing the operation.

  • resource_uri (str) – The URI of the resource in the operation.

  • operation_name (str) – The operation that was performed.

  • status (str) – The status of the operation.

  • authorization (str) – The requested authorization for the operation.

  • claims (str) – The properties of the claims.

  • correlation_id (str) – An operation ID used for troubleshooting.

  • http_request (str) – The details of the operation.

class azure.eventgrid.models.ServiceBusActiveMessagesAvailableWithNoListenersEventData(*, namespace_name: Optional[str] = None, request_uri: Optional[str] = None, entity_type: Optional[str] = None, queue_name: Optional[str] = None, topic_name: Optional[str] = None, subscription_name: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.ActiveMessagesAvailableWithNoListeners event.

Parameters
  • namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.

  • request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.

  • entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.

  • queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.

  • topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.

  • subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.

class azure.eventgrid.models.ServiceBusDeadletterMessagesAvailableWithNoListenersEventData(*, namespace_name: Optional[str] = None, request_uri: Optional[str] = None, entity_type: Optional[str] = None, queue_name: Optional[str] = None, topic_name: Optional[str] = None, subscription_name: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.ServiceBus.DeadletterMessagesAvailableWithNoListenersEvent event.

Parameters
  • namespace_name (str) – The namespace name of the Microsoft.ServiceBus resource.

  • request_uri (str) – The endpoint of the Microsoft.ServiceBus resource.

  • entity_type (str) – The entity type of the Microsoft.ServiceBus resource. Could be one of ‘queue’ or ‘subscriber’.

  • queue_name (str) – The name of the Microsoft.ServiceBus queue. If the entity type is of type ‘subscriber’, then this value will be null.

  • topic_name (str) – The name of the Microsoft.ServiceBus topic. If the entity type is of type ‘queue’, then this value will be null.

  • subscription_name (str) – The name of the Microsoft.ServiceBus topic’s subscription. If the entity type is of type ‘queue’, then this value will be null.

class azure.eventgrid.models.SignalRServiceClientConnectionConnectedEventData(*, timestamp: Optional[datetime.datetime] = None, hub_name: Optional[str] = None, connection_id: Optional[str] = None, user_id: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionConnected event.

Parameters
  • timestamp (datetime) – The time at which the event occurred.

  • hub_name (str) – The hub of connected client connection.

  • connection_id (str) – The connection Id of connected client connection.

  • user_id (str) – The user Id of connected client connection.

class azure.eventgrid.models.SignalRServiceClientConnectionDisconnectedEventData(*, timestamp: Optional[datetime.datetime] = None, hub_name: Optional[str] = None, connection_id: Optional[str] = None, user_id: Optional[str] = None, error_message: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.SignalRService.ClientConnectionDisconnected event.

Parameters
  • timestamp (datetime) – The time at which the event occurred.

  • hub_name (str) – The hub of connected client connection.

  • connection_id (str) – The connection Id of connected client connection.

  • user_id (str) – The user Id of connected client connection.

  • error_message (str) – The message of error that cause the client connection disconnected.

class azure.eventgrid.models.StampKind(value)[source]

Bases: str, enum.Enum

Kind of environment where app service plan is.

ASE_V1 = 'AseV1'

App Service Plan is running on an App Service Environment V1.

ASE_V2 = 'AseV2'

App Service Plan is running on an App Service Environment V2.

PUBLIC = 'Public'

App Service Plan is running on a public stamp.

class azure.eventgrid.models.StorageBlobCreatedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, e_tag: Optional[str] = None, content_type: Optional[str] = None, content_length: Optional[int] = None, content_offset: Optional[int] = None, blob_type: Optional[str] = None, url: Optional[str] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobCreated event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.

  • e_tag (str) – The etag of the blob at the time this event was triggered.

  • content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.

  • content_length (long) – The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.

  • content_offset (long) – The offset of the blob in bytes.

  • blob_type (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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageBlobDeletedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, content_type: Optional[str] = None, blob_type: Optional[str] = None, url: Optional[str] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobDeleted event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (str) – The request id generated by the Storage service for the storage API operation that triggered this event.

  • content_type (str) – The content type of the blob. This is the same as what would be returned in the Content-Type header from the blob.

  • blob_type (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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageBlobRenamedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, source_url: Optional[str] = None, destination_url: Optional[str] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.BlobRenamed event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (str) – The request id generated by the storage service for the storage API operation that triggered this event.

  • source_url (str) – The path to the blob that was renamed.

  • destination_url (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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageDirectoryCreatedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, e_tag: Optional[str] = None, url: Optional[str] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryCreated event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (str) – The request id generated by the storage service for the storage API operation that triggered this event.

  • e_tag (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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageDirectoryDeletedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, url: Optional[str] = None, recursive: Optional[bool] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryDeleted event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (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 (bool) – 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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageDirectoryRenamedEventData(*, api: Optional[str] = None, client_request_id: Optional[str] = None, request_id: Optional[str] = None, source_url: Optional[str] = None, destination_url: Optional[str] = None, sequencer: Optional[str] = None, identity: Optional[str] = None, storage_diagnostics: Optional[object] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.DirectoryRenamed event.

Parameters
  • api (str) – The name of the API/operation that triggered this event.

  • client_request_id (str) – A request id provided by the client of the storage API operation that triggered this event.

  • request_id (str) – The request id generated by the storage service for the storage API operation that triggered this event.

  • source_url (str) – The path to the directory that was renamed.

  • destination_url (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.

  • storage_diagnostics (object) – For service use only. Diagnostic data occasionally included by the Azure Storage service. This property should be ignored by event consumers.

class azure.eventgrid.models.StorageLifecyclePolicyActionSummaryDetail(*, total_objects_count: Optional[int] = None, success_count: Optional[int] = None, error_list: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Execution statistics of a specific policy action in a Blob Management cycle.

Parameters
  • total_objects_count (long) – Total number of objects to be acted on by this action.

  • success_count (long) – Number of success operations of this action.

  • error_list (str) – Error messages of this action if any.

class azure.eventgrid.models.StorageLifecyclePolicyCompletedEventData(*, schedule_time: Optional[str] = None, delete_summary: Optional[StorageLifecyclePolicyActionSummaryDetail] = None, tier_to_cool_summary: Optional[StorageLifecyclePolicyActionSummaryDetail] = None, tier_to_archive_summary: Optional[StorageLifecyclePolicyActionSummaryDetail] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Storage.LifecyclePolicyCompleted event.

Parameters
  • schedule_time (str) – The time the policy task was scheduled.

  • delete_summary (StorageLifecyclePolicyActionSummaryDetail) – Execution statistics of a specific policy action in a Blob Management cycle.

  • tier_to_cool_summary (StorageLifecyclePolicyActionSummaryDetail) – Execution statistics of a specific policy action in a Blob Management cycle.

  • tier_to_archive_summary (StorageLifecyclePolicyActionSummaryDetail) – Execution statistics of a specific policy action in a Blob Management cycle.

class azure.eventgrid.models.SubscriptionDeletedEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionDeletedEvent.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

event_subscription_id (str) – The Azure resource ID of the deleted event subscription.

class azure.eventgrid.models.SubscriptionValidationEventData(**kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • validation_code (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).

  • validation_url (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).

class azure.eventgrid.models.SubscriptionValidationResponse(*, validation_response: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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.

Parameters

validation_response (str) – The validation response sent by the subscriber to Azure Event Grid to complete the validation of an event subscription.

class azure.eventgrid.models.WebAppServicePlanUpdatedEventData(*, app_service_plan_event_type_detail: Optional[AppServicePlanEventTypeDetail] = None, sku: Optional[WebAppServicePlanUpdatedEventDataSku] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.AppServicePlanUpdated event.

Parameters
  • app_service_plan_event_type_detail (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.

  • client_request_id (str) – The client request id generated by the app service for the app service plan API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the app service plan API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebAppServicePlanUpdatedEventDataSku(*, name: Optional[str] = None, tier: Optional[str] = None, size: Optional[str] = None, family: Optional[str] = None, capacity: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

sku of app service plan.

Parameters
  • 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 azure.eventgrid.models.WebAppUpdatedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.AppUpdated event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebBackupOperationCompletedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationCompleted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebBackupOperationFailedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationFailed event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebBackupOperationStartedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationStarted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebRestoreOperationCompletedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationCompleted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebRestoreOperationFailedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationFailed event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebRestoreOperationStartedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationStarted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebSlotSwapCompletedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapCompleted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebSlotSwapFailedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapFailed event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebSlotSwapStartedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapStarted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebSlotSwapWithPreviewCancelledEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapWithPreviewCancelled event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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 azure.eventgrid.models.WebSlotSwapWithPreviewStartedEventData(*, app_event_type_detail: Optional[AppEventTypeDetail] = None, name: Optional[str] = None, client_request_id: Optional[str] = None, correlation_request_id: Optional[str] = None, request_id: Optional[str] = None, address: Optional[str] = None, verb: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapWithPreviewStarted event.

Parameters
  • app_event_type_detail (AppEventTypeDetail) – Detail of action on the app.

  • name (str) – name of the web site that had this event.

  • client_request_id (str) – The client request id generated by the app service for the site API operation that triggered this event.

  • correlation_request_id (str) – The correlation request id generated by the app service for the site API operation that triggered this event.

  • request_id (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.