azure.eventgrid.models module¶
-
class
azure.eventgrid.models.
StorageBlobCreatedEventData
(*, api: str = None, client_request_id: str = None, request_id: str = None, e_tag: str = None, content_type: str = None, content_length: int = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=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 object 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 (int) – The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.
- 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.
- 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: str = None, client_request_id: str = None, request_id: str = None, content_type: str = None, blob_type: str = None, url: str = None, sequencer: str = None, storage_diagnostics=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.
- 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.
EventHubCaptureFileCreatedEventData
(*, fileurl: str = None, file_type: str = None, partition_id: str = None, size_in_bytes: int = None, event_count: int = None, first_sequence_number: int = None, last_sequence_number: int = None, first_enqueue_time=None, last_enqueue_time=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.
ResourceWriteSuccessData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceWriteFailureData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceWriteCancelData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceDeleteSuccessData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceDeleteFailureData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceDeleteCancelData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceActionSuccessData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceActionFailureData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
ResourceActionCancelData
(*, tenant_id: str = None, subscription_id: str = None, resource_group: str = None, resource_provider: str = None, resource_uri: str = None, operation_name: str = None, status: str = None, authorization: str = None, claims: str = None, correlation_id: str = None, http_request: 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.
EventGridEvent
(*, id: str, subject: str, data, event_type: str, event_time, data_version: str, topic: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of an event published to an Event Grid topic.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Parameters: - id (str) – Required. An unique identifier for the event.
- topic (str) – The resource path of the event source.
- subject (str) – Required. A resource path relative to the topic path.
- data (object) – Required. Event data specific to the event type.
- event_type (str) – Required. The type of the event that occurred.
- event_time (datetime) – Required. The time (in UTC) the event was generated.
- data_version (str) – Required. The schema version of the data object.
Variables: metadata_version (str) – The schema version of the event metadata.
-
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: 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.
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.
IotHubDeviceCreatedEventData
(*, device_id: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.device_life_cycle_event_properties_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: str = None, hub_name: str = None, twin=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.device_life_cycle_event_properties_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.
IotHubDeviceConnectedEventData
(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.device_connection_state_event_properties_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.
IotHubDeviceDisconnectedEventData
(*, device_id: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.device_connection_state_event_properties_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.
DeviceTwinMetadata
(*, last_updated: 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=None, version: 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.
DeviceTwinInfoProperties
(*, desired=None, reported=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: str = None, secondary_thumbprint: 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.
DeviceTwinInfo
(*, authentication_type: str = None, cloud_to_device_message_count: float = None, connection_state: str = None, device_id: str = None, etag: str = None, last_activity_time: str = None, properties=None, status: str = None, status_update_time: str = None, version: float = None, x509_thumbprint=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.
DeviceLifeCycleEventProperties
(*, device_id: str = None, hub_name: str = None, twin=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.
DeviceConnectionStateEventInfo
(*, sequence_number: 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: str = None, module_id: str = None, hub_name: str = None, device_connection_state_event_info=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.
ContainerRegistryImagePushedEventData
(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.container_registry_event_data_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.
ContainerRegistryImageDeletedEventData
(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=None, **kwargs)[source]¶ Bases:
azure.eventgrid.models.container_registry_event_data_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.
ContainerRegistryEventTarget
(*, media_type: str = None, size: int = None, digest: str = None, length: int = None, repository: str = None, url: str = None, tag: 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.
ContainerRegistryEventRequest
(*, id: str = None, addr: str = None, host: str = None, method: str = None, useragent: 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.
ContainerRegistryEventActor
(*, name: 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.
ContainerRegistryEventSource
(*, addr: str = None, instance_id: 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.
ContainerRegistryEventData
(*, id: str = None, timestamp=None, action: str = None, target=None, request=None, actor=None, source=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.
ServiceBusActiveMessagesAvailableWithNoListenersEventData
(*, namespace_name: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: 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: str = None, request_uri: str = None, entity_type: str = None, queue_name: str = None, topic_name: str = None, subscription_name: 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.
MediaJobStateChangeEventData
(**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 JobState) – The previous state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
- state (str or JobState) – The new state of the Job. Possible values include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’
-
class
azure.eventgrid.models.
JobState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
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.
-