azure.mgmt.eventgrid.models module¶
-
class
azure.mgmt.eventgrid.models.
Resource
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Definition of a Resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.eventgrid.models.
TrackedResource
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.resource_py3.Resource
Definition of a Tracked Resource.
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.
-
class
azure.mgmt.eventgrid.models.
Domain
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.tracked_resource_py3.TrackedResource
EventGrid Domain.
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.
- Variables
name (str) – Name of the resource.
provisioning_state (str or DomainProvisioningState) – Provisioning state of the domain. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’
endpoint (str) – Endpoint for the domain.
- Parameters
-
class
azure.mgmt.eventgrid.models.
DomainUpdateParameters
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the Domain update.
Bases:
msrest.serialization.Model
Shared access keys of the Domain.
-
class
azure.mgmt.eventgrid.models.
DomainRegenerateKeyRequest
(*, key_name: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Domain regenerate share access key request.
All required parameters must be populated in order to send to Azure.
- Parameters
key_name (str) – Required. Key name to regenerate key1 or key2.
-
class
azure.mgmt.eventgrid.models.
DomainTopic
(*, provisioning_state=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.resource_py3.Resource
Domain Topic.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
provisioning_state (str or DomainTopicProvisioningState) – Provisioning state of the domain topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionDestination
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Information about the destination for an event subscription.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebHookEventSubscriptionDestination, EventHubEventSubscriptionDestination, StorageQueueEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestination
All required parameters must be populated in order to send to Azure.
- Parameters
endpoint_type (str) – Required. Constant filled by server.
-
class
azure.mgmt.eventgrid.models.
AdvancedFilter
(*, key: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NumberInAdvancedFilter, NumberNotInAdvancedFilter, NumberLessThanAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, BoolEqualsAdvancedFilter, StringInAdvancedFilter, StringNotInAdvancedFilter, StringBeginsWithAdvancedFilter, StringEndsWithAdvancedFilter, StringContainsAdvancedFilter
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionFilter
(*, subject_begins_with: str = None, subject_ends_with: str = None, included_event_types=None, is_subject_case_sensitive: bool = False, advanced_filters=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Filter for the Event Subscription.
- Parameters
subject_begins_with (str) – An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.
subject_ends_with (str) – An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.
included_event_types (list[str]) – A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.
is_subject_case_sensitive (bool) – Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. Default value: False .
advanced_filters (list[AdvancedFilter]) – An array of advanced filters that are used for filtering event subscriptions.
-
class
azure.mgmt.eventgrid.models.
RetryPolicy
(*, max_delivery_attempts: int = None, event_time_to_live_in_minutes: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information about the retry policy for an event subscription.
-
class
azure.mgmt.eventgrid.models.
DeadLetterDestination
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: StorageBlobDeadLetterDestination
All required parameters must be populated in order to send to Azure.
- Parameters
endpoint_type (str) – Required. Constant filled by server.
-
class
azure.mgmt.eventgrid.models.
NumberInAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberIn Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StorageBlobDeadLetterDestination
(*, resource_id: str = None, blob_container_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.dead_letter_destination_py3.DeadLetterDestination
Information about the storage blob based dead letter destination.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
NumberNotInAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberNotIn Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
NumberLessThanAdvancedFilter
(*, key: str = None, value: float = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberLessThan Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
NumberGreaterThanAdvancedFilter
(*, key: str = None, value: float = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberGreaterThan Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
NumberLessThanOrEqualsAdvancedFilter
(*, key: str = None, value: float = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberLessThanOrEquals Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
NumberGreaterThanOrEqualsAdvancedFilter
(*, key: str = None, value: float = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
NumberGreaterThanOrEquals Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
BoolEqualsAdvancedFilter
(*, key: str = None, value: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
BoolEquals Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StringInAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
StringIn Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StringNotInAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
StringNotIn Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StringBeginsWithAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
StringBeginsWith Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StringEndsWithAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
StringEndsWith Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StringContainsAdvancedFilter
(*, key: str = None, values=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.advanced_filter_py3.AdvancedFilter
StringContains Advanced Filter.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
WebHookEventSubscriptionDestination
(*, endpoint_url: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.event_subscription_destination_py3.EventSubscriptionDestination
Information about the webhook destination for an event subscription.
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.
-
class
azure.mgmt.eventgrid.models.
EventHubEventSubscriptionDestination
(*, resource_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.event_subscription_destination_py3.EventSubscriptionDestination
Information about the event hub destination for an event subscription.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
StorageQueueEventSubscriptionDestination
(*, resource_id: str = None, queue_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.event_subscription_destination_py3.EventSubscriptionDestination
Information about the storage queue destination for an event subscription.
All required parameters must be populated in order to send to Azure.
- Parameters
endpoint_type (str) – Required. Constant filled by server.
resource_id (str) – The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.
queue_name (str) – The name of the Storage queue under a storage account that is the destination of an event subscription.
-
class
azure.mgmt.eventgrid.models.
HybridConnectionEventSubscriptionDestination
(*, resource_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.event_subscription_destination_py3.EventSubscriptionDestination
Information about the HybridConnection destination for an event subscription.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
ServiceBusQueueEventSubscriptionDestination
(*, resource_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.event_subscription_destination_py3.EventSubscriptionDestination
Information about the service bus destination for an event subscription.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.eventgrid.models.
EventSubscription
(*, destination=None, filter=None, labels=None, expiration_time_utc=None, retry_policy=None, dead_letter_destination=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.resource_py3.Resource
Event Subscription.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Name of the resource.
topic (str) – Name of the topic of the event subscription.
provisioning_state (str or EventSubscriptionProvisioningState) – Provisioning state of the event subscription. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’, ‘AwaitingManualAction’
- Parameters
destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription.
filter (EventSubscriptionFilter) – Information about the filter for the event subscription.
expiration_time_utc (datetime) – Expiration time of the event subscription.
retry_policy (RetryPolicy) – The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
dead_letter_destination (DeadLetterDestination) – The DeadLetter destination of the event subscription.
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionUpdateParameters
(*, destination=None, filter=None, labels=None, expiration_time_utc=None, retry_policy=None, dead_letter_destination=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the Event Subscription update.
- Parameters
destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription.
filter (EventSubscriptionFilter) – Information about the filter for the event subscription.
expiration_time_utc (datetime) – Information about the expiration time for the event subscription.
retry_policy (RetryPolicy) – The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events.
dead_letter_destination (DeadLetterDestination) – The DeadLetter destination of the event subscription.
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionFullUrl
(*, endpoint_url: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Full endpoint url of an event subscription.
- Parameters
endpoint_url (str) – The URL that represents the endpoint of the destination of an event subscription.
-
class
azure.mgmt.eventgrid.models.
OperationInfo
(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information about an operation.
-
class
azure.mgmt.eventgrid.models.
Operation
(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents an operation returned by the GetOperations request.
- Parameters
name (str) – Name of the operation
display (OperationInfo) – Display name of the operation
origin (str) – Origin of the operation
properties (object) – Properties of the operation
-
class
azure.mgmt.eventgrid.models.
Topic
(*, location: str, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.tracked_resource_py3.TrackedResource
EventGrid 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.
- Variables
name (str) – Name of the resource.
provisioning_state (str or TopicProvisioningState) – Provisioning state of the topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’
endpoint (str) – Endpoint for the topic.
- Parameters
-
class
azure.mgmt.eventgrid.models.
TopicUpdateParameters
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties of the Topic update.
Bases:
msrest.serialization.Model
Shared access keys of the Topic.
-
class
azure.mgmt.eventgrid.models.
TopicRegenerateKeyRequest
(*, key_name: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Topic regenerate share access key request.
All required parameters must be populated in order to send to Azure.
- Parameters
key_name (str) – Required. Key name to regenerate key1 or key2
-
class
azure.mgmt.eventgrid.models.
EventType
(*, display_name: str = None, description: str = None, schema_url: str = None, is_in_default_set: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.resource_py3.Resource
Event Type for a subject under a topic.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
-
class
azure.mgmt.eventgrid.models.
TopicTypeInfo
(*, provider: str = None, display_name: str = None, description: str = None, resource_region_type=None, provisioning_state=None, supported_locations=None, **kwargs)[source]¶ Bases:
azure.mgmt.eventgrid.models.resource_py3.Resource
Properties of a topic type info.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
- Parameters
provider (str) – Namespace of the provider of the topic type.
display_name (str) – Display Name for the topic type.
description (str) – Description of the topic type.
resource_region_type (str or ResourceRegionType) – Region type of the resource. Possible values include: ‘RegionalResource’, ‘GlobalResource’
provisioning_state (str or TopicTypeProvisioningState) – Provisioning state of the topic type. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’
supported_locations (list[str]) – List of locations supported by this topic type.
-
class
azure.mgmt.eventgrid.models.
DomainPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Domain
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
DomainTopicPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DomainTopic
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
EventSubscription
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
OperationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Operation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
TopicPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Topic
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
EventTypePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
EventType
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
TopicTypeInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
TopicTypeInfo
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.eventgrid.models.
DomainProvisioningState
[source]¶ -
An enumeration.
-
canceled
= 'Canceled'¶
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
succeeded
= 'Succeeded'¶
-
updating
= 'Updating'¶
-
-
class
azure.mgmt.eventgrid.models.
DomainTopicProvisioningState
[source]¶ -
An enumeration.
-
canceled
= 'Canceled'¶
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
succeeded
= 'Succeeded'¶
-
updating
= 'Updating'¶
-
-
class
azure.mgmt.eventgrid.models.
EventSubscriptionProvisioningState
[source]¶ -
An enumeration.
-
awaiting_manual_action
= 'AwaitingManualAction'¶
-
canceled
= 'Canceled'¶
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
succeeded
= 'Succeeded'¶
-
updating
= 'Updating'¶
-
-
class
azure.mgmt.eventgrid.models.
TopicProvisioningState
[source]¶ -
An enumeration.
-
canceled
= 'Canceled'¶
-
creating
= 'Creating'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
succeeded
= 'Succeeded'¶
-
updating
= 'Updating'¶
-