azure.mgmt.eventgrid.models module

class azure.mgmt.eventgrid.models.AdvancedFilter(*, key: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._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: BoolEqualsAdvancedFilter, IsNotNullAdvancedFilter, IsNullOrUndefinedAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, NumberInAdvancedFilter, NumberInRangeAdvancedFilter, NumberLessThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberNotInAdvancedFilter, NumberNotInRangeAdvancedFilter, StringBeginsWithAdvancedFilter, StringContainsAdvancedFilter, StringEndsWithAdvancedFilter, StringInAdvancedFilter, StringNotBeginsWithAdvancedFilter, StringNotContainsAdvancedFilter, StringNotEndsWithAdvancedFilter, StringNotInAdvancedFilter

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

Keyword Arguments

key (str) – The field/property in the event based on which you want to filter.

class azure.mgmt.eventgrid.models.AdvancedFilterOperatorType(value)

Bases: str, enum.Enum

The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.

BOOL_EQUALS = 'BoolEquals'

IS_NOT_NULL = 'IsNotNull'

IS_NULL_OR_UNDEFINED = 'IsNullOrUndefined'

NUMBER_GREATER_THAN = 'NumberGreaterThan'

NUMBER_GREATER_THAN_OR_EQUALS = 'NumberGreaterThanOrEquals'

NUMBER_IN = 'NumberIn'

NUMBER_IN_RANGE = 'NumberInRange'

NUMBER_LESS_THAN = 'NumberLessThan'

NUMBER_LESS_THAN_OR_EQUALS = 'NumberLessThanOrEquals'

NUMBER_NOT_IN = 'NumberNotIn'

NUMBER_NOT_IN_RANGE = 'NumberNotInRange'

STRING_BEGINS_WITH = 'StringBeginsWith'

STRING_CONTAINS = 'StringContains'

STRING_ENDS_WITH = 'StringEndsWith'

STRING_IN = 'StringIn'

STRING_NOT_BEGINS_WITH = 'StringNotBeginsWith'

STRING_NOT_CONTAINS = 'StringNotContains'

STRING_NOT_ENDS_WITH = 'StringNotEndsWith'

STRING_NOT_IN = 'StringNotIn'

class azure.mgmt.eventgrid.models.AzureFunctionEventSubscriptionDestination(*, resource_id: Optional[str] = None, max_events_per_batch: int = 1, preferred_batch_size_in_kilobytes: int = 64, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the azure function destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.

• max_events_per_batch (int) – Maximum number of events per batch.

• preferred_batch_size_in_kilobytes (int) – Preferred batch size in Kilobytes.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.

• max_events_per_batch (int) – Maximum number of events per batch.

• preferred_batch_size_in_kilobytes (int) – Preferred batch size in Kilobytes.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

class azure.mgmt.eventgrid.models.BoolEqualsAdvancedFilter(*, key: Optional[str] = None, value: Optional[bool] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

BoolEquals Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• value (bool) – The boolean filter value.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• value (bool) – The boolean filter value.

class azure.mgmt.eventgrid.models.Channel(*, channel_type: Optional[Union[str, _models.ChannelType]] = None, partner_topic_info: Optional[_models.PartnerTopicInfo] = None, message_for_activation: Optional[str] = None, provisioning_state: Optional[Union[str, _models.ChannelProvisioningState]] = None, readiness_state: Optional[Union[str, _models.ReadinessState]] = None, expiration_time_if_not_activated_utc: Optional[datetime.datetime] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Channel info.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to Channel resource.

• channel_type (str or ChannelType) – The type of the event channel which represents the direction flow of events. “PartnerTopic”

• partner_topic_info (PartnerTopicInfo) – This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.

• message_for_activation (str) – Context or helpful message that can be used during the approval process by the subscriber.

• provisioning_state (str or ChannelProvisioningState) – Provisioning state of the channel. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, “Failed”, and “IdleDueToMirroredPartnerTopicDeletion”.

• readiness_state (str or ReadinessState) – The readiness state of the corresponding partner topic. Known values are: “NeverActivated” and “Activated”.

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.

Keyword Arguments

• channel_type (str or ChannelType) – The type of the event channel which represents the direction flow of events. “PartnerTopic”

• partner_topic_info (PartnerTopicInfo) – This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel.

• message_for_activation (str) – Context or helpful message that can be used during the approval process by the subscriber.

• provisioning_state (str or ChannelProvisioningState) – Provisioning state of the channel. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, “Failed”, and “IdleDueToMirroredPartnerTopicDeletion”.

• readiness_state (str or ReadinessState) – The readiness state of the corresponding partner topic. Known values are: “NeverActivated” and “Activated”.

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, the channel and corresponding partner topic are deleted.

class azure.mgmt.eventgrid.models.ChannelProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the channel.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

IDLE_DUE_TO_MIRRORED_PARTNER_TOPIC_DELETION = 'IdleDueToMirroredPartnerTopicDeletion'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.ChannelType(value)

Bases: str, enum.Enum

The type of the event channel which represents the direction flow of events.

PARTNER_TOPIC = 'PartnerTopic'

class azure.mgmt.eventgrid.models.ChannelUpdateParameters(*, expiration_time_if_not_activated_utc: Optional[datetime.datetime] = None, partner_topic_info: Optional[_models.PartnerUpdateTopicInfo] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Channel update.

Variables

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the channel. If this timer expires while the corresponding partner topic or partner destination is never activated, the channel and corresponding partner topic or partner destination are deleted.

• partner_topic_info (PartnerUpdateTopicInfo) – Partner topic properties which can be updated if the channel is of type PartnerTopic.

Keyword Arguments

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the channel. If this timer expires while the corresponding partner topic or partner destination is never activated, the channel and corresponding partner topic or partner destination are deleted.

• partner_topic_info (PartnerUpdateTopicInfo) – Partner topic properties which can be updated if the channel is of type PartnerTopic.

class azure.mgmt.eventgrid.models.ChannelsListResult(*, value: Optional[List[_models.Channel]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Channels operation.

Variables

• value (list[Channel]) – A collection of Channels.

• next_link (str) – A link for the next page of channels.

Keyword Arguments

• value (list[Channel]) – A collection of Channels.

• next_link (str) – A link for the next page of channels.

class azure.mgmt.eventgrid.models.ConnectionState(*, status: Optional[Union[str, _models.PersistedConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

ConnectionState information.

Variables

• status (str or PersistedConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

• description (str) – Description of the connection state.

• actions_required (str) – Actions required (if any).

Keyword Arguments

• status (str or PersistedConnectionStatus) – Status of the connection. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

• description (str) – Description of the connection state.

• actions_required (str) – Actions required (if any).

class azure.mgmt.eventgrid.models.CreatedByType(value)

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.eventgrid.models.DataResidencyBoundary(value)

Bases: str, enum.Enum

Data Residency Boundary of the resource.

WITHIN_GEOPAIR = 'WithinGeopair'

WITHIN_REGION = 'WithinRegion'

class azure.mgmt.eventgrid.models.DeadLetterDestination(**kwargs)

Bases: azure.mgmt.eventgrid._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.

Variables

endpoint_type (str or DeadLetterEndPointType) – Type of the endpoint for the dead letter destination. Required. “StorageBlob”

class azure.mgmt.eventgrid.models.DeadLetterEndPointType(value)

Bases: str, enum.Enum

Type of the endpoint for the dead letter destination.

STORAGE_BLOB = 'StorageBlob'

class azure.mgmt.eventgrid.models.DeadLetterWithResourceIdentity(*, identity: Optional[_models.EventSubscriptionIdentity] = None, dead_letter_destination: Optional[_models.DeadLetterDestination] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about the deadletter destination with resource identity.

Variables

• identity (EventSubscriptionIdentity) – The identity to use when dead-lettering events.

• dead_letter_destination (DeadLetterDestination) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Keyword Arguments

• identity (EventSubscriptionIdentity) – The identity to use when dead-lettering events.

• dead_letter_destination (DeadLetterDestination) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

class azure.mgmt.eventgrid.models.DeliveryAttributeListResult(*, value: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the Get delivery attributes operation.

Variables

value (list[DeliveryAttributeMapping]) – A collection of DeliveryAttributeMapping.

Keyword Arguments

value (list[DeliveryAttributeMapping]) – A collection of DeliveryAttributeMapping.

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

Bases: azure.mgmt.eventgrid._serialization.Model

Delivery attribute mapping details.

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

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

Variables

• name (str) – Name of the delivery attribute or header.

• type (str or DeliveryAttributeMappingType) – Type of the delivery attribute or header name. Required. Known values are: “Static” and “Dynamic”.

Keyword Arguments

name (str) – Name of the delivery attribute or header.

class azure.mgmt.eventgrid.models.DeliveryAttributeMappingType(value)

Bases: str, enum.Enum

Type of the delivery attribute or header name.

DYNAMIC = 'Dynamic'

STATIC = 'Static'

class azure.mgmt.eventgrid.models.DeliveryWithResourceIdentity(*, identity: Optional[_models.EventSubscriptionIdentity] = None, destination: Optional[_models.EventSubscriptionDestination] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about the delivery for an event subscription with resource identity.

Variables

• identity (EventSubscriptionIdentity) – The identity to use when delivering events.

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

Keyword Arguments

• identity (EventSubscriptionIdentity) – The identity to use when delivering events.

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

class azure.mgmt.eventgrid.models.Domain(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, input_schema: Optional[Union[str, _models.InputSchema]] = None, input_schema_mapping: Optional[_models.InputSchemaMapping] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: bool = False, auto_create_topic_with_first_subscription: bool = True, auto_delete_topic_with_last_subscription: bool = True, data_residency_boundary: Optional[Union[str, _models.DataResidencyBoundary]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• system_data (SystemData) – The system metadata relating to the Event Grid Domain resource.

• identity (IdentityInfo) – Identity information for the Event Grid Domain resource.

• private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.

• provisioning_state (str or DomainProvisioningState) – Provisioning state of the Event Grid Domain Resource. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• endpoint (str) – Endpoint for the Event Grid Domain Resource which is used for publishing the events.

• input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: “EventGridSchema”, “CustomEventSchema”, and “CloudEventSchemaV1_0”.

• input_schema_mapping (InputSchemaMapping) – Information about the InputSchemaMapping which specified the info about mapping event payload.

• metric_resource_id (str) – Metric resource id for the Event Grid Domain Resource.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.

• auto_create_topic_with_first_subscription (bool) – This Boolean is used to specify the creation mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.

• auto_delete_topic_with_last_subscription (bool) – This Boolean is used to specify the deletion mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.

• data_residency_boundary (str or DataResidencyBoundary) – Data Residency Boundary of the resource. Known values are: “WithinGeopair” and “WithinRegion”.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the Event Grid Domain resource.

• input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: “EventGridSchema”, “CustomEventSchema”, and “CloudEventSchemaV1_0”.

• input_schema_mapping (InputSchemaMapping) – Information about the InputSchemaMapping which specified the info about mapping event payload.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.

• auto_create_topic_with_first_subscription (bool) – This Boolean is used to specify the creation mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.

• auto_delete_topic_with_last_subscription (bool) – This Boolean is used to specify the deletion mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.

• data_residency_boundary (str or DataResidencyBoundary) – Data Residency Boundary of the resource. Known values are: “WithinGeopair” and “WithinRegion”.

class azure.mgmt.eventgrid.models.DomainProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the Event Grid Domain Resource.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.DomainRegenerateKeyRequest(*, key_name: str, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Domain regenerate share access key request.

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

Variables

key_name (str) – Key name to regenerate key1 or key2. Required.

Keyword Arguments

key_name (str) – Key name to regenerate key1 or key2. Required.

class azure.mgmt.eventgrid.models.DomainSharedAccessKeys(*, key1: Optional[str] = None, key2: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Shared access keys of the Domain.

Variables

• key1 (str) – Shared access key1 for the domain.

• key2 (str) – Shared access key2 for the domain.

Keyword Arguments

• key1 (str) – Shared access key1 for the domain.

• key2 (str) – Shared access key2 for the domain.

class azure.mgmt.eventgrid.models.DomainTopic(**kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Domain Topic.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to Domain Topic resource.

• provisioning_state (str or DomainTopicProvisioningState) – Provisioning state of the domain topic. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.eventgrid.models.DomainTopicProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the domain topic.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.DomainTopicsListResult(*, value: Optional[List[_models.DomainTopic]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Domain Topics operation.

Variables

• value (list[DomainTopic]) – A collection of Domain Topics.

• next_link (str) – A link for the next page of domain topics.

Keyword Arguments

• value (list[DomainTopic]) – A collection of Domain Topics.

• next_link (str) – A link for the next page of domain topics.

class azure.mgmt.eventgrid.models.DomainUpdateParameters(*, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: Optional[bool] = None, auto_create_topic_with_first_subscription: Optional[bool] = None, auto_delete_topic_with_last_subscription: Optional[bool] = None, data_residency_boundary: Optional[Union[str, _models.DataResidencyBoundary]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Domain update.

Variables

• tags (dict[str, str]) – Tags of the domains resource.

• identity (IdentityInfo) – Identity information for the resource.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.

• auto_create_topic_with_first_subscription (bool) – This Boolean is used to specify the creation mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.

• auto_delete_topic_with_last_subscription (bool) – This Boolean is used to specify the deletion mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.

• data_residency_boundary (str or DataResidencyBoundary) – The data residency boundary for the domain. Known values are: “WithinGeopair” and “WithinRegion”.

Keyword Arguments

• tags (dict[str, str]) – Tags of the domains resource.

• identity (IdentityInfo) – Identity information for the resource.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.

• auto_create_topic_with_first_subscription (bool) – This Boolean is used to specify the creation mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.

• auto_delete_topic_with_last_subscription (bool) – This Boolean is used to specify the deletion mechanism for ‘all’ the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.

• data_residency_boundary (str or DataResidencyBoundary) – The data residency boundary for the domain. Known values are: “WithinGeopair” and “WithinRegion”.

class azure.mgmt.eventgrid.models.DomainsListResult(*, value: Optional[List[_models.Domain]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Domains operation.

Variables

• value (list[Domain]) – A collection of Domains.

• next_link (str) – A link for the next page of domains.

Keyword Arguments

• value (list[Domain]) – A collection of Domains.

• next_link (str) – A link for the next page of domains.

class azure.mgmt.eventgrid.models.DynamicDeliveryAttributeMapping(*, name: Optional[str] = None, source_field: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeMapping

Dynamic delivery attribute mapping details.

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

Variables

• name (str) – Name of the delivery attribute or header.

• type (str or DeliveryAttributeMappingType) – Type of the delivery attribute or header name. Required. Known values are: “Static” and “Dynamic”.

• source_field (str) – JSON path in the event which contains attribute value.

Keyword Arguments

• name (str) – Name of the delivery attribute or header.

• source_field (str) – JSON path in the event which contains attribute value.

class azure.mgmt.eventgrid.models.EndpointType(value)

Bases: str, enum.Enum

Type of the endpoint for the event subscription destination.

AZURE_FUNCTION = 'AzureFunction'

EVENT_HUB = 'EventHub'

HYBRID_CONNECTION = 'HybridConnection'

SERVICE_BUS_QUEUE = 'ServiceBusQueue'

SERVICE_BUS_TOPIC = 'ServiceBusTopic'

STORAGE_QUEUE = 'StorageQueue'

WEB_HOOK = 'WebHook'

class azure.mgmt.eventgrid.models.EventDefinitionKind(value)

Bases: str, enum.Enum

The kind of event type used.

INLINE = 'Inline'

class azure.mgmt.eventgrid.models.EventDeliverySchema(value)

Bases: str, enum.Enum

The event delivery schema for the event subscription.

CLOUD_EVENT_SCHEMA_V1_0 = 'CloudEventSchemaV1_0'

CUSTOM_INPUT_SCHEMA = 'CustomInputSchema'

EVENT_GRID_SCHEMA = 'EventGridSchema'

class azure.mgmt.eventgrid.models.EventHubEventSubscriptionDestination(*, resource_id: Optional[str] = None, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the event hub destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• resource_id (str) – The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• resource_id (str) – The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

class azure.mgmt.eventgrid.models.EventSubscription(*, destination: Optional[_models.EventSubscriptionDestination] = None, delivery_with_resource_identity: Optional[_models.DeliveryWithResourceIdentity] = None, filter: Optional[_models.EventSubscriptionFilter] = None, labels: Optional[List[str]] = None, expiration_time_utc: Optional[datetime.datetime] = None, event_delivery_schema: Optional[Union[str, _models.EventDeliverySchema]] = None, retry_policy: Optional[_models.RetryPolicy] = None, dead_letter_destination: Optional[_models.DeadLetterDestination] = None, dead_letter_with_resource_identity: Optional[_models.DeadLetterWithResourceIdentity] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Event Subscription.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to Event Subscription resource.

• topic (str) – Name of the topic of the event subscription.

• provisioning_state (str or EventSubscriptionProvisioningState) – Provisioning state of the event subscription. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, “Failed”, and “AwaitingManualAction”.

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• delivery_with_resource_identity (DeliveryWithResourceIdentity) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

• filter (EventSubscriptionFilter) – Information about the filter for the event subscription.

• labels (list[str]) – List of user defined labels.

• expiration_time_utc (datetime) – Expiration time of the event subscription.

• event_delivery_schema (str or EventDeliverySchema) – The event delivery schema for the event subscription. Known values are: “EventGridSchema”, “CustomInputSchema”, and “CloudEventSchemaV1_0”.

• 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 dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• dead_letter_with_resource_identity (DeadLetterWithResourceIdentity) – The dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Keyword Arguments

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• delivery_with_resource_identity (DeliveryWithResourceIdentity) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

• filter (EventSubscriptionFilter) – Information about the filter for the event subscription.

• labels (list[str]) – List of user defined labels.

• expiration_time_utc (datetime) – Expiration time of the event subscription.

• event_delivery_schema (str or EventDeliverySchema) – The event delivery schema for the event subscription. Known values are: “EventGridSchema”, “CustomInputSchema”, and “CloudEventSchemaV1_0”.

• 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 dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• dead_letter_with_resource_identity (DeadLetterWithResourceIdentity) – The dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery / dead-lettering.

class azure.mgmt.eventgrid.models.EventSubscriptionDestination(**kwargs)

Bases: azure.mgmt.eventgrid._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: AzureFunctionEventSubscriptionDestination, EventHubEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestination, StorageQueueEventSubscriptionDestination, WebHookEventSubscriptionDestination

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

Variables

endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

class azure.mgmt.eventgrid.models.EventSubscriptionFilter(*, subject_begins_with: Optional[str] = None, subject_ends_with: Optional[str] = None, included_event_types: Optional[List[str]] = None, is_subject_case_sensitive: bool = False, enable_advanced_filtering_on_arrays: Optional[bool] = None, advanced_filters: Optional[List[_models.AdvancedFilter]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Filter for the Event Subscription.

Variables

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

• enable_advanced_filtering_on_arrays (bool) – Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

• advanced_filters (list[AdvancedFilter]) – An array of advanced filters that are used for filtering event subscriptions.

Keyword Arguments

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

• enable_advanced_filtering_on_arrays (bool) – Allows advanced filters to be evaluated against an array of values instead of expecting a singular value.

• advanced_filters (list[AdvancedFilter]) – An array of advanced filters that are used for filtering event subscriptions.

class azure.mgmt.eventgrid.models.EventSubscriptionFullUrl(*, endpoint_url: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Full endpoint url of an event subscription.

Variables

endpoint_url (str) – The URL that represents the endpoint of the destination of an event subscription.

Keyword Arguments

endpoint_url (str) – The URL that represents the endpoint of the destination of an event subscription.

class azure.mgmt.eventgrid.models.EventSubscriptionIdentity(*, type: Optional[Union[str, _models.EventSubscriptionIdentityType]] = None, user_assigned_identity: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

The identity information with the event subscription.

Variables

• type (str or EventSubscriptionIdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity. Known values are: “SystemAssigned” and “UserAssigned”.

• user_assigned_identity (str) – The user identity associated with the resource.

Keyword Arguments

• type (str or EventSubscriptionIdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity. Known values are: “SystemAssigned” and “UserAssigned”.

• user_assigned_identity (str) – The user identity associated with the resource.

class azure.mgmt.eventgrid.models.EventSubscriptionIdentityType(value)

Bases: str, enum.Enum

The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity.

SYSTEM_ASSIGNED = 'SystemAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.eventgrid.models.EventSubscriptionProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the event subscription.

AWAITING_MANUAL_ACTION = 'AwaitingManualAction'

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.EventSubscriptionUpdateParameters(*, destination: Optional[_models.EventSubscriptionDestination] = None, delivery_with_resource_identity: Optional[_models.DeliveryWithResourceIdentity] = None, filter: Optional[_models.EventSubscriptionFilter] = None, labels: Optional[List[str]] = None, expiration_time_utc: Optional[datetime.datetime] = None, event_delivery_schema: Optional[Union[str, _models.EventDeliverySchema]] = None, retry_policy: Optional[_models.RetryPolicy] = None, dead_letter_destination: Optional[_models.DeadLetterDestination] = None, dead_letter_with_resource_identity: Optional[_models.DeadLetterWithResourceIdentity] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Event Subscription update.

Variables

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• delivery_with_resource_identity (DeliveryWithResourceIdentity) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

• filter (EventSubscriptionFilter) – Information about the filter for the event subscription.

• labels (list[str]) – List of user defined labels.

• expiration_time_utc (datetime) – Information about the expiration time for the event subscription.

• event_delivery_schema (str or EventDeliverySchema) – The event delivery schema for the event subscription. Known values are: “EventGridSchema”, “CustomInputSchema”, and “CloudEventSchemaV1_0”.

• 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 dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• dead_letter_with_resource_identity (DeadLetterWithResourceIdentity) – The dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

Keyword Arguments

• destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• delivery_with_resource_identity (DeliveryWithResourceIdentity) – Information about the destination where events have to be delivered for the event subscription. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

• filter (EventSubscriptionFilter) – Information about the filter for the event subscription.

• labels (list[str]) – List of user defined labels.

• expiration_time_utc (datetime) – Information about the expiration time for the event subscription.

• event_delivery_schema (str or EventDeliverySchema) – The event delivery schema for the event subscription. Known values are: “EventGridSchema”, “CustomInputSchema”, and “CloudEventSchemaV1_0”.

• 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 dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses Azure Event Grid’s identity to acquire the authentication tokens being used during delivery / dead-lettering.

• dead_letter_with_resource_identity (DeadLetterWithResourceIdentity) – The dead letter destination of the event subscription. Any event that cannot be delivered to its’ destination is sent to the dead letter destination. Uses the managed identity setup on the parent resource (topic / domain) to acquire the authentication tokens being used during delivery / dead-lettering.

class azure.mgmt.eventgrid.models.EventSubscriptionsListResult(*, value: Optional[List[_models.EventSubscription]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List EventSubscriptions operation.

Variables

• value (list[EventSubscription]) – A collection of EventSubscriptions.

• next_link (str) – A link for the next page of event subscriptions.

Keyword Arguments

• value (list[EventSubscription]) – A collection of EventSubscriptions.

• next_link (str) – A link for the next page of event subscriptions.

class azure.mgmt.eventgrid.models.EventType(*, display_name: Optional[str] = None, description: Optional[str] = None, schema_url: Optional[str] = None, is_in_default_set: Optional[bool] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• display_name (str) – Display name of the event type.

• description (str) – Description of the event type.

• schema_url (str) – Url of the schema for this event type.

• is_in_default_set (bool) – IsInDefaultSet flag of the event type.

Keyword Arguments

• display_name (str) – Display name of the event type.

• description (str) – Description of the event type.

• schema_url (str) – Url of the schema for this event type.

• is_in_default_set (bool) – IsInDefaultSet flag of the event type.

class azure.mgmt.eventgrid.models.EventTypeInfo(*, kind: Optional[Union[str, _models.EventDefinitionKind]] = None, inline_event_types: Optional[Dict[str, _models.InlineEventProperties]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

The event type information for Channels.

Variables

• kind (str or EventDefinitionKind) – The kind of event type used. “Inline”

• inline_event_types (dict[str, InlineEventProperties]) – A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is “Contoso.OrderCreated”. The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.

Keyword Arguments

• kind (str or EventDefinitionKind) – The kind of event type used. “Inline”

• inline_event_types (dict[str, InlineEventProperties]) – A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. An example of a valid inline event name is “Contoso.OrderCreated”. The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type.

class azure.mgmt.eventgrid.models.EventTypesListResult(*, value: Optional[List[_models.EventType]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Event Types operation.

Variables

value (list[EventType]) – A collection of event types.

Keyword Arguments

value (list[EventType]) – A collection of event types.

class azure.mgmt.eventgrid.models.ExtensionTopic(*, description: Optional[str] = None, system_topic: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Event grid Extension Topic. This is used for getting Event Grid related metrics for Azure resources.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to Extension Topic resource.

• description (str) – Description of the extension topic.

• system_topic (str) – System topic resource id which is mapped to the source.

Keyword Arguments

• description (str) – Description of the extension topic.

• system_topic (str) – System topic resource id which is mapped to the source.

class azure.mgmt.eventgrid.models.HybridConnectionEventSubscriptionDestination(*, resource_id: Optional[str] = None, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the HybridConnection destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• resource_id (str) – The Azure Resource ID of an hybrid connection that is the destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• resource_id (str) – The Azure Resource ID of an hybrid connection that is the destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

class azure.mgmt.eventgrid.models.IdentityInfo(*, type: Optional[Union[str, _models.IdentityType]] = None, principal_id: Optional[str] = None, tenant_id: Optional[str] = None, user_assigned_identities: Optional[Dict[str, _models.UserIdentityProperties]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

The identity information for the resource.

Variables

• type (str or IdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

• principal_id (str) – The principal ID of resource identity.

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

• user_assigned_identities – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:

‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

This property is currently not used and reserved for future usage.

Keyword Arguments

• type (str or IdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

• principal_id (str) – The principal ID of resource identity.

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

• user_assigned_identities – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:

‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

This property is currently not used and reserved for future usage.

class azure.mgmt.eventgrid.models.IdentityType(value)

Bases: str, enum.Enum

The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identity.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.eventgrid.models.InboundIpRule(*, ip_mask: Optional[str] = None, action: Optional[Union[str, _models.IpActionType]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

InboundIpRule.

Variables

• ip_mask (str) – IP Address in CIDR notation e.g., 10.0.0.0/8.

• action (str or IpActionType) – Action to perform based on the match or no match of the IpMask. “Allow”

Keyword Arguments

• ip_mask (str) – IP Address in CIDR notation e.g., 10.0.0.0/8.

• action (str or IpActionType) – Action to perform based on the match or no match of the IpMask. “Allow”

class azure.mgmt.eventgrid.models.InlineEventProperties(*, description: Optional[str] = None, display_name: Optional[str] = None, documentation_url: Optional[str] = None, data_schema_url: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Additional information about every inline event.

Variables

• description (str) – The description for the inline event.

• display_name (str) – The displayName for the inline event.

• documentation_url (str) – The documentationUrl for the inline event.

• data_schema_url (str) – The dataSchemaUrl for the inline event.

Keyword Arguments

• description (str) – The description for the inline event.

• display_name (str) – The displayName for the inline event.

• documentation_url (str) – The documentationUrl for the inline event.

• data_schema_url (str) – The dataSchemaUrl for the inline event.

class azure.mgmt.eventgrid.models.InputSchema(value)

Bases: str, enum.Enum

This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.

CLOUD_EVENT_SCHEMA_V1_0 = 'CloudEventSchemaV1_0'

CUSTOM_EVENT_SCHEMA = 'CustomEventSchema'

EVENT_GRID_SCHEMA = 'EventGridSchema'

class azure.mgmt.eventgrid.models.InputSchemaMapping(**kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is ‘JsonInputSchemaMapping’.

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

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

Variables

input_schema_mapping_type (str or InputSchemaMappingType) – Type of the custom mapping. Required. “Json”

class azure.mgmt.eventgrid.models.InputSchemaMappingType(value)

Bases: str, enum.Enum

Type of the custom mapping.

JSON = 'Json'

class azure.mgmt.eventgrid.models.IpActionType(value)

Bases: str, enum.Enum

Action to perform based on the match or no match of the IpMask.

ALLOW = 'Allow'

class azure.mgmt.eventgrid.models.IsNotNullAdvancedFilter(*, key: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

IsNotNull Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

Keyword Arguments

key (str) – The field/property in the event based on which you want to filter.

class azure.mgmt.eventgrid.models.IsNullOrUndefinedAdvancedFilter(*, key: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

IsNullOrUndefined Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

Keyword Arguments

key (str) – The field/property in the event based on which you want to filter.

class azure.mgmt.eventgrid.models.JsonField(*, source_field: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘id’, ‘topic’ and ‘eventtime’ properties. This represents a field in the input event schema.

Variables

source_field (str) – Name of a field in the input event schema that’s to be used as the source of a mapping.

Keyword Arguments

source_field (str) – Name of a field in the input event schema that’s to be used as the source of a mapping.

class azure.mgmt.eventgrid.models.JsonFieldWithDefault(*, source_field: Optional[str] = None, default_value: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the ‘subject’, ‘eventtype’ and ‘dataversion’ properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.

ivar source_field

Name of a field in the input event schema that’s to be used as the source of a mapping.

vartype source_field

str

ivar default_value

The default value to be used for mapping when a SourceField is not provided or if there’s no property with the specified name in the published JSON event payload.

vartype default_value

str

Keyword Arguments

• source_field (str) – Name of a field in the input event schema that’s to be used as the source of a mapping.

• default_value (str) – The default value to be used for mapping when a SourceField is not provided or if there’s no property with the specified name in the published JSON event payload.

class azure.mgmt.eventgrid.models.JsonInputSchemaMapping(*, id: Optional[_models.JsonField] = None, topic: Optional[_models.JsonField] = None, event_time: Optional[_models.JsonField] = None, event_type: Optional[_models.JsonFieldWithDefault] = None, subject: Optional[_models.JsonFieldWithDefault] = None, data_version: Optional[_models.JsonFieldWithDefault] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.InputSchemaMapping

This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.

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

Variables

• input_schema_mapping_type (str or InputSchemaMappingType) – Type of the custom mapping. Required. “Json”

• id (JsonField) – The mapping information for the Id property of the Event Grid Event.

• topic (JsonField) – The mapping information for the Topic property of the Event Grid Event.

• event_time (JsonField) – The mapping information for the EventTime property of the Event Grid Event.

• event_type (JsonFieldWithDefault) – The mapping information for the EventType property of the Event Grid Event.

• subject (JsonFieldWithDefault) – The mapping information for the Subject property of the Event Grid Event.

• data_version (JsonFieldWithDefault) – The mapping information for the DataVersion property of the Event Grid Event.

Keyword Arguments

• id (JsonField) – The mapping information for the Id property of the Event Grid Event.

• topic (JsonField) – The mapping information for the Topic property of the Event Grid Event.

• event_time (JsonField) – The mapping information for the EventTime property of the Event Grid Event.

• event_type (JsonFieldWithDefault) – The mapping information for the EventType property of the Event Grid Event.

• subject (JsonFieldWithDefault) – The mapping information for the Subject property of the Event Grid Event.

• data_version (JsonFieldWithDefault) – The mapping information for the DataVersion property of the Event Grid Event.

class azure.mgmt.eventgrid.models.NumberGreaterThanAdvancedFilter(*, key: Optional[str] = None, value: Optional[float] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberGreaterThan Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

class azure.mgmt.eventgrid.models.NumberGreaterThanOrEqualsAdvancedFilter(*, key: Optional[str] = None, value: Optional[float] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberGreaterThanOrEquals Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

class azure.mgmt.eventgrid.models.NumberInAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[float]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberIn Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[float]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[float]) – The set of filter values.

class azure.mgmt.eventgrid.models.NumberInRangeAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[List[float]]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberInRange Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[list[float]]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[list[float]]) – The set of filter values.

class azure.mgmt.eventgrid.models.NumberLessThanAdvancedFilter(*, key: Optional[str] = None, value: Optional[float] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberLessThan Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

class azure.mgmt.eventgrid.models.NumberLessThanOrEqualsAdvancedFilter(*, key: Optional[str] = None, value: Optional[float] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberLessThanOrEquals Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• value (float) – The filter value.

class azure.mgmt.eventgrid.models.NumberNotInAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[float]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberNotIn Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[float]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[float]) – The set of filter values.

class azure.mgmt.eventgrid.models.NumberNotInRangeAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[List[float]]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

NumberNotInRange Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[list[float]]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[list[float]]) – The set of filter values.

class azure.mgmt.eventgrid.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationInfo] = None, origin: Optional[str] = None, is_data_action: Optional[bool] = None, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Represents an operation returned by the GetOperations request.

Variables

• name (str) – Name of the operation.

• display (OperationInfo) – Display name of the operation.

• origin (str) – Origin of the operation.

• is_data_action (bool) – This Boolean is used to determine if the operation is a data plane action or not.

• properties (JSON) – Properties of the operation.

Keyword Arguments

• name (str) – Name of the operation.

• display (OperationInfo) – Display name of the operation.

• origin (str) – Origin of the operation.

• is_data_action (bool) – This Boolean is used to determine if the operation is a data plane action or not.

• properties (JSON) – Properties of the operation.

class azure.mgmt.eventgrid.models.OperationInfo(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about an operation.

Variables

• provider (str) – Name of the provider.

• resource (str) – Name of the resource type.

• operation (str) – Name of the operation.

• description (str) – Description of the operation.

Keyword Arguments

• provider (str) – Name of the provider.

• resource (str) – Name of the resource type.

• operation (str) – Name of the operation.

• description (str) – Description of the operation.

class azure.mgmt.eventgrid.models.OperationsListResult(*, value: Optional[List[_models.Operation]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Operations operation.

Variables

value (list[Operation]) – A collection of operations.

Keyword Arguments

value (list[Operation]) – A collection of operations.

class azure.mgmt.eventgrid.models.Partner(*, partner_registration_immutable_id: Optional[str] = None, partner_name: Optional[str] = None, authorization_expiration_time_in_utc: Optional[datetime.datetime] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about the partner.

Variables

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration.

• partner_name (str) – The partner name.

• authorization_expiration_time_in_utc (datetime) – Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber’s context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.

Keyword Arguments

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration.

• partner_name (str) – The partner name.

• authorization_expiration_time_in_utc (datetime) – Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber’s context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified.

class azure.mgmt.eventgrid.models.PartnerAuthorization(*, default_maximum_expiration_time_in_days: Optional[int] = None, authorized_partners_list: Optional[List[_models.Partner]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

The partner authorization details.

Variables

• default_maximum_expiration_time_in_days (int) – Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.

• authorized_partners_list (list[Partner]) – The list of authorized partners.

Keyword Arguments

• default_maximum_expiration_time_in_days (int) – Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days.

• authorized_partners_list (list[Partner]) – The list of authorized partners.

class azure.mgmt.eventgrid.models.PartnerConfiguration(*, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, partner_authorization: Optional[_models.PartnerAuthorization] = None, provisioning_state: Optional[Union[str, _models.PartnerConfigurationProvisioningState]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Partner configuration information.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to partner configuration resource.

• location (str) – Location of the resource.

• tags (dict[str, str]) – Tags of the resource.

• partner_authorization (PartnerAuthorization) – The details of authorized partners.

• provisioning_state (str or PartnerConfigurationProvisioningState) – Provisioning state of the partner configuration. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

Keyword Arguments

• location (str) – Location of the resource.

• tags (dict[str, str]) – Tags of the resource.

• partner_authorization (PartnerAuthorization) – The details of authorized partners.

• provisioning_state (str or PartnerConfigurationProvisioningState) – Provisioning state of the partner configuration. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.eventgrid.models.PartnerConfigurationProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the partner configuration.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.PartnerConfigurationUpdateParameters(*, tags: Optional[Dict[str, str]] = None, default_maximum_expiration_time_in_days: Optional[int] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the partner configuration update.

Variables

• tags (dict[str, str]) – Tags of the partner configuration resource.

• default_maximum_expiration_time_in_days (int) – The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between 1 and 365 days.

Keyword Arguments

• tags (dict[str, str]) – Tags of the partner configuration resource.

• default_maximum_expiration_time_in_days (int) – The default time used to validate the maximum expiration time for each authorized partners in days. Allowed values ar between 1 and 365 days.

class azure.mgmt.eventgrid.models.PartnerConfigurationsListResult(*, value: Optional[List[_models.PartnerConfiguration]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List partner configurations operation.

Variables

• value (list[PartnerConfiguration]) – A collection of partner configurations.

• next_link (str) – A link for the next page of partner configurations.

Keyword Arguments

• value (list[PartnerConfiguration]) – A collection of partner configurations.

• next_link (str) – A link for the next page of partner configurations.

class azure.mgmt.eventgrid.models.PartnerDetails(*, description: Optional[str] = None, long_description: Optional[str] = None, setup_uri: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about the partner.

Variables

• description (str) – This is short description about the partner. The length of this description should not exceed 256 characters.

• long_description (str) – Long description for the partner’s scenarios and integration.Length of this description should not exceed 2048 characters.

• setup_uri (str) – URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source.

Keyword Arguments

• description (str) – This is short description about the partner. The length of this description should not exceed 256 characters.

• long_description (str) – Long description for the partner’s scenarios and integration.Length of this description should not exceed 2048 characters.

• setup_uri (str) – URI of the partner website that can be used by Azure customers to setup Event Grid integration on an event source.

class azure.mgmt.eventgrid.models.PartnerNamespace(*, location: str, tags: Optional[Dict[str, str]] = None, partner_registration_fully_qualified_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: bool = False, partner_topic_routing_mode: Union[str, _models.PartnerTopicRoutingMode] = 'SourceEventAttribute', **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.TrackedResource

EventGrid Partner Namespace.

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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• system_data (SystemData) – The system metadata relating to Partner Namespace resource.

• private_endpoint_connections (list[PrivateEndpointConnection]) –

• provisioning_state (str or PartnerNamespaceProvisioningState) – Provisioning state of the partner namespace. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• partner_registration_fully_qualified_id – The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. :vartype partner_registration_fully_qualified_id: str :ivar endpoint: Endpoint for the partner namespace. :vartype endpoint: str :ivar public_network_access: This determines if traffic is allowed over public network. By

default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

Variables

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.

• partner_topic_routing_mode (str or PartnerTopicRoutingMode) – This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. Known values are: “SourceEventAttribute” and “ChannelNameHeader”.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• partner_registration_fully_qualified_id – The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format:

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}. :paramtype partner_registration_fully_qualified_id: str :keyword public_network_access: This determines if traffic is allowed over public network. By

default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

Keyword Arguments

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.

• partner_topic_routing_mode (str or PartnerTopicRoutingMode) – This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. Known values are: “SourceEventAttribute” and “ChannelNameHeader”.

class azure.mgmt.eventgrid.models.PartnerNamespaceProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the partner namespace.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.PartnerNamespaceRegenerateKeyRequest(*, key_name: str, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

PartnerNamespace regenerate shared access key request.

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

Variables

key_name (str) – Key name to regenerate (key1 or key2). Required.

Keyword Arguments

key_name (str) – Key name to regenerate (key1 or key2). Required.

class azure.mgmt.eventgrid.models.PartnerNamespaceSharedAccessKeys(*, key1: Optional[str] = None, key2: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Shared access keys of the partner namespace.

Variables

• key1 (str) – Shared access key1 for the partner namespace.

• key2 (str) – Shared access key2 for the partner namespace.

Keyword Arguments

• key1 (str) – Shared access key1 for the partner namespace.

• key2 (str) – Shared access key2 for the partner namespace.

class azure.mgmt.eventgrid.models.PartnerNamespaceUpdateParameters(*, tags: Optional[Dict[str, str]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: Optional[bool] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Partner Namespace update.

Variables

• tags (dict[str, str]) – Tags of the Partner Namespace.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.

Keyword Arguments

• tags (dict[str, str]) – Tags of the Partner Namespace.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.

class azure.mgmt.eventgrid.models.PartnerNamespacesListResult(*, value: Optional[List[_models.PartnerNamespace]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Partner Namespaces operation.

Variables

• value (list[PartnerNamespace]) – A collection of partner namespaces.

• next_link (str) – A link for the next page of partner namespaces.

Keyword Arguments

• value (list[PartnerNamespace]) – A collection of partner namespaces.

• next_link (str) – A link for the next page of partner namespaces.

class azure.mgmt.eventgrid.models.PartnerRegistration(*, location: str, tags: Optional[Dict[str, str]] = None, partner_registration_immutable_id: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.TrackedResource

Information about a partner registration.

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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• system_data (SystemData) – The system metadata relating to Partner Registration resource.

• provisioning_state (str or PartnerRegistrationProvisioningState) – Provisioning state of the partner registration. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version.

class azure.mgmt.eventgrid.models.PartnerRegistrationProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the partner registration.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.PartnerRegistrationUpdateParameters(*, tags: Optional[Dict[str, str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Partner Registration update.

Variables

tags (dict[str, str]) – Tags of the partner registration resource.

Keyword Arguments

tags (dict[str, str]) – Tags of the partner registration resource.

class azure.mgmt.eventgrid.models.PartnerRegistrationsListResult(*, value: Optional[List[_models.PartnerRegistration]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Partner Registrations operation.

Variables

• value (list[PartnerRegistration]) – A collection of partner registrations.

• next_link (str) – A link for the next page of partner registrations.

Keyword Arguments

• value (list[PartnerRegistration]) – A collection of partner registrations.

• next_link (str) – A link for the next page of partner registrations.

class azure.mgmt.eventgrid.models.PartnerTopic(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, partner_registration_immutable_id: Optional[str] = None, source: Optional[str] = None, event_type_info: Optional[_models.EventTypeInfo] = None, expiration_time_if_not_activated_utc: Optional[datetime.datetime] = None, activation_state: Optional[Union[str, _models.PartnerTopicActivationState]] = None, partner_topic_friendly_description: Optional[str] = None, message_for_activation: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.TrackedResource

Event Grid Partner 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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• system_data (SystemData) – The system metadata relating to Partner Topic resource.

• identity (IdentityInfo) – Identity information for the Partner Topic resource.

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration.

• source (str) – Source associated with this partner topic. This represents a unique partner resource.

• event_type_info (EventTypeInfo) – Event Type information from the corresponding event channel.

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.

• provisioning_state (str or PartnerTopicProvisioningState) – Provisioning state of the partner topic. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, “Failed”, and “IdleDueToMirroredChannelResourceDeletion”.

• activation_state (str or PartnerTopicActivationState) – Activation state of the partner topic. Known values are: “NeverActivated”, “Activated”, and “Deactivated”.

• partner_topic_friendly_description (str) – Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

• message_for_activation (str) – Context or helpful message that can be used during the approval process by the subscriber.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the Partner Topic resource.

• partner_registration_immutable_id (str) – The immutableId of the corresponding partner registration.

• source (str) – Source associated with this partner topic. This represents a unique partner resource.

• event_type_info (EventTypeInfo) – Event Type information from the corresponding event channel.

• expiration_time_if_not_activated_utc (datetime) – Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.

• activation_state (str or PartnerTopicActivationState) – Activation state of the partner topic. Known values are: “NeverActivated”, “Activated”, and “Deactivated”.

• partner_topic_friendly_description (str) – Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.

• message_for_activation (str) – Context or helpful message that can be used during the approval process by the subscriber.

class azure.mgmt.eventgrid.models.PartnerTopicActivationState(value)

Bases: str, enum.Enum

Activation state of the partner topic.

ACTIVATED = 'Activated'

DEACTIVATED = 'Deactivated'

NEVER_ACTIVATED = 'NeverActivated'

class azure.mgmt.eventgrid.models.PartnerTopicInfo(*, azure_subscription_id: Optional[str] = None, resource_group_name: Optional[str] = None, name: Optional[str] = None, event_type_info: Optional[_models.EventTypeInfo] = None, source: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the corresponding partner topic of a Channel.

Variables

• azure_subscription_id (str) – Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.

• resource_group_name (str) – Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.

• name (str) – Name of the partner topic associated with the channel.

• event_type_info (EventTypeInfo) – Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

• source (str) – The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.

Keyword Arguments

• azure_subscription_id (str) – Azure subscription ID of the subscriber. The partner topic associated with the channel will be created under this Azure subscription.

• resource_group_name (str) – Azure Resource Group of the subscriber. The partner topic associated with the channel will be created under this resource group.

• name (str) – Name of the partner topic associated with the channel.

• event_type_info (EventTypeInfo) – Event Type Information for the partner topic. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.

• source (str) – The source information is provided by the publisher to determine the scope or context from which the events are originating. This information can be used by the subscriber during the approval process of the created partner topic.

class azure.mgmt.eventgrid.models.PartnerTopicProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the partner topic.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

IDLE_DUE_TO_MIRRORED_CHANNEL_RESOURCE_DELETION = 'IdleDueToMirroredChannelResourceDeletion'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.PartnerTopicRoutingMode(value)

Bases: str, enum.Enum

This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.

CHANNEL_NAME_HEADER = 'ChannelNameHeader'

SOURCE_EVENT_ATTRIBUTE = 'SourceEventAttribute'

class azure.mgmt.eventgrid.models.PartnerTopicUpdateParameters(*, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Partner Topic update.

Variables

• tags (dict[str, str]) – Tags of the Partner Topic resource.

• identity (IdentityInfo) – Identity information for the Partner Topic resource.

Keyword Arguments

• tags (dict[str, str]) – Tags of the Partner Topic resource.

• identity (IdentityInfo) – Identity information for the Partner Topic resource.

class azure.mgmt.eventgrid.models.PartnerTopicsListResult(*, value: Optional[List[_models.PartnerTopic]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Partner Topics operation.

Variables

• value (list[PartnerTopic]) – A collection of partner topics.

• next_link (str) – A link for the next page of partner topics.

Keyword Arguments

• value (list[PartnerTopic]) – A collection of partner topics.

• next_link (str) – A link for the next page of partner topics.

class azure.mgmt.eventgrid.models.PartnerUpdateTopicInfo(*, event_type_info: Optional[_models.EventTypeInfo] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Update properties for the corresponding partner topic of a channel.

Variables

event_type_info (EventTypeInfo) – Event type info for the partner topic.

Keyword Arguments

event_type_info (EventTypeInfo) – Event type info for the partner topic.

class azure.mgmt.eventgrid.models.PersistedConnectionStatus(value)

Bases: str, enum.Enum

Status of the connection.

APPROVED = 'Approved'

DISCONNECTED = 'Disconnected'

PENDING = 'Pending'

REJECTED = 'Rejected'

class azure.mgmt.eventgrid.models.PrivateEndpoint(*, id: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

PrivateEndpoint information.

Variables

id (str) – The ARM identifier for Private Endpoint.

Keyword Arguments

id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.eventgrid.models.PrivateEndpointConnection(*, private_endpoint: Optional[_models.PrivateEndpoint] = None, group_ids: Optional[List[str]] = None, private_link_service_connection_state: Optional[_models.ConnectionState] = None, provisioning_state: Optional[Union[str, _models.ResourceProvisioningState]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

PrivateEndpointConnection.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.

• group_ids (list[str]) – GroupIds from the private link service resource.

• private_link_service_connection_state (ConnectionState) – Details about the state of the connection.

• provisioning_state (str or ResourceProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

Keyword Arguments

• private_endpoint (PrivateEndpoint) – The Private Endpoint resource for this Connection.

• group_ids (list[str]) – GroupIds from the private link service resource.

• private_link_service_connection_state (ConnectionState) – Details about the state of the connection.

• provisioning_state (str or ResourceProvisioningState) – Provisioning state of the Private Endpoint Connection. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.eventgrid.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the list of all private endpoint connections operation.

Variables

• value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.

• next_link (str) – A link for the next page of private endpoint connection resources.

Keyword Arguments

• value (list[PrivateEndpointConnection]) – A collection of private endpoint connection resources.

• next_link (str) – A link for the next page of private endpoint connection resources.

class azure.mgmt.eventgrid.models.PrivateEndpointConnectionsParentType(value)

Bases: str, enum.Enum

PrivateEndpointConnectionsParentType.

DOMAINS = 'domains'

PARTNER_NAMESPACES = 'partnerNamespaces'

TOPICS = 'topics'

class azure.mgmt.eventgrid.models.PrivateLinkResource(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, group_id: Optional[str] = None, display_name: Optional[str] = None, required_members: Optional[List[str]] = None, required_zone_names: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information of the private link resource.

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• group_id (str) –

• display_name (str) –

• required_members (list[str]) –

• required_zone_names (list[str]) –

Keyword Arguments

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• group_id (str) –

• display_name (str) –

• required_members (list[str]) –

• required_zone_names (list[str]) –

class azure.mgmt.eventgrid.models.PrivateLinkResourcesListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List private link resources operation.

Variables

• value (list[PrivateLinkResource]) – A collection of private link resources.

• next_link (str) – A link for the next page of private link resources.

Keyword Arguments

• value (list[PrivateLinkResource]) – A collection of private link resources.

• next_link (str) – A link for the next page of private link resources.

class azure.mgmt.eventgrid.models.PublicNetworkAccess(value)

Bases: str, enum.Enum

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.eventgrid.models.ReadinessState(value)

Bases: str, enum.Enum

The readiness state of the corresponding partner topic.

ACTIVATED = 'Activated'

NEVER_ACTIVATED = 'NeverActivated'

class azure.mgmt.eventgrid.models.Resource(**kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Definition of a Resource.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

class azure.mgmt.eventgrid.models.ResourceProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the Private Endpoint Connection.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.ResourceRegionType(value)

Bases: str, enum.Enum

Region type of the resource.

GLOBAL_RESOURCE = 'GlobalResource'

REGIONAL_RESOURCE = 'RegionalResource'

class azure.mgmt.eventgrid.models.RetryPolicy(*, max_delivery_attempts: int = 30, event_time_to_live_in_minutes: int = 1440, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Information about the retry policy for an event subscription.

Variables

• max_delivery_attempts (int) – Maximum number of delivery retry attempts for events.

• event_time_to_live_in_minutes (int) – Time To Live (in minutes) for events.

Keyword Arguments

• max_delivery_attempts (int) – Maximum number of delivery retry attempts for events.

• event_time_to_live_in_minutes (int) – Time To Live (in minutes) for events.

class azure.mgmt.eventgrid.models.ServiceBusQueueEventSubscriptionDestination(*, resource_id: Optional[str] = None, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the service bus destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

class azure.mgmt.eventgrid.models.ServiceBusTopicEventSubscriptionDestination(*, resource_id: Optional[str] = None, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the service bus topic destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• resource_id (str) – The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

class azure.mgmt.eventgrid.models.StaticDeliveryAttributeMapping(*, name: Optional[str] = None, value: Optional[str] = None, is_secret: bool = False, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeMapping

Static delivery attribute mapping details.

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

Variables

• name (str) – Name of the delivery attribute or header.

• type (str or DeliveryAttributeMappingType) – Type of the delivery attribute or header name. Required. Known values are: “Static” and “Dynamic”.

• value (str) – Value of the delivery attribute.

• is_secret (bool) – Boolean flag to tell if the attribute contains sensitive information .

Keyword Arguments

• name (str) – Name of the delivery attribute or header.

• value (str) – Value of the delivery attribute.

• is_secret (bool) – Boolean flag to tell if the attribute contains sensitive information .

class azure.mgmt.eventgrid.models.StorageBlobDeadLetterDestination(*, resource_id: Optional[str] = None, blob_container_name: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.DeadLetterDestination

Information about the storage blob based dead letter destination.

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

Variables

• endpoint_type (str or DeadLetterEndPointType) – Type of the endpoint for the dead letter destination. Required. “StorageBlob”

• resource_id (str) – The Azure Resource ID of the storage account that is the destination of the deadletter events.

• blob_container_name (str) – The name of the Storage blob container that is the destination of the deadletter events.

Keyword Arguments

• resource_id (str) – The Azure Resource ID of the storage account that is the destination of the deadletter events.

• blob_container_name (str) – The name of the Storage blob container that is the destination of the deadletter events.

class azure.mgmt.eventgrid.models.StorageQueueEventSubscriptionDestination(*, resource_id: Optional[str] = None, queue_name: Optional[str] = None, queue_message_time_to_live_in_seconds: Optional[int] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionDestination

Information about the storage queue destination for an event subscription.

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

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

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

• queue_message_time_to_live_in_seconds (int) – Storage queue message time to live in seconds.

Keyword Arguments

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

• queue_message_time_to_live_in_seconds (int) – Storage queue message time to live in seconds.

class azure.mgmt.eventgrid.models.StringBeginsWithAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringBeginsWith Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringContainsAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringContains Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringEndsWithAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringEndsWith Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringInAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringIn Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringNotBeginsWithAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringNotBeginsWith Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringNotContainsAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringNotContains Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringNotEndsWithAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringNotEndsWith Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.StringNotInAdvancedFilter(*, key: Optional[str] = None, values: Optional[List[str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.AdvancedFilter

StringNotIn Advanced Filter.

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

Variables

• operator_type (str or AdvancedFilterOperatorType) – The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. Required. Known values are: “NumberIn”, “NumberNotIn”, “NumberLessThan”, “NumberGreaterThan”, “NumberLessThanOrEquals”, “NumberGreaterThanOrEquals”, “BoolEquals”, “StringIn”, “StringNotIn”, “StringBeginsWith”, “StringEndsWith”, “StringContains”, “NumberInRange”, “NumberNotInRange”, “StringNotBeginsWith”, “StringNotEndsWith”, “StringNotContains”, “IsNullOrUndefined”, and “IsNotNull”.

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

Keyword Arguments

• key (str) – The field/property in the event based on which you want to filter.

• values (list[str]) – The set of filter values.

class azure.mgmt.eventgrid.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.eventgrid.models.SystemTopic(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, source: Optional[str] = None, topic_type: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.TrackedResource

EventGrid System 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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the resource.

• system_data (SystemData) – The system metadata relating to System Topic resource.

• provisioning_state (str or ResourceProvisioningState) – Provisioning state of the system topic. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• source (str) – Source for the system topic.

• topic_type (str) – TopicType for the system topic.

• metric_resource_id (str) – Metric resource id for the system topic.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the resource.

• source (str) – Source for the system topic.

• topic_type (str) – TopicType for the system topic.

class azure.mgmt.eventgrid.models.SystemTopicUpdateParameters(*, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the System Topic update.

Variables

• tags (dict[str, str]) – Tags of the system topic.

• identity (IdentityInfo) – Resource identity information.

Keyword Arguments

• tags (dict[str, str]) – Tags of the system topic.

• identity (IdentityInfo) – Resource identity information.

class azure.mgmt.eventgrid.models.SystemTopicsListResult(*, value: Optional[List[_models.SystemTopic]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List System topics operation.

Variables

• value (list[SystemTopic]) – A collection of system Topics.

• next_link (str) – A link for the next page of topics.

Keyword Arguments

• value (list[SystemTopic]) – A collection of system Topics.

• next_link (str) – A link for the next page of topics.

class azure.mgmt.eventgrid.models.Topic(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, input_schema: Optional[Union[str, _models.InputSchema]] = None, input_schema_mapping: Optional[_models.InputSchemaMapping] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: bool = False, data_residency_boundary: Optional[Union[str, _models.DataResidencyBoundary]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_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

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the resource.

• system_data (SystemData) – The system metadata relating to Topic resource.

• private_endpoint_connections (list[PrivateEndpointConnection]) –

• provisioning_state (str or TopicProvisioningState) – Provisioning state of the topic. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• endpoint (str) – Endpoint for the topic.

• input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the topic. Known values are: “EventGridSchema”, “CustomEventSchema”, and “CloudEventSchemaV1_0”.

• input_schema_mapping (InputSchemaMapping) – This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

• metric_resource_id (str) – Metric resource id for the topic.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.

• data_residency_boundary (str or DataResidencyBoundary) – Data Residency Boundary of the resource. Known values are: “WithinGeopair” and “WithinRegion”.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

• identity (IdentityInfo) – Identity information for the resource.

• input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the topic. Known values are: “EventGridSchema”, “CustomEventSchema”, and “CloudEventSchemaV1_0”.

• input_schema_mapping (InputSchemaMapping) – This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.

• data_residency_boundary (str or DataResidencyBoundary) – Data Residency Boundary of the resource. Known values are: “WithinGeopair” and “WithinRegion”.

class azure.mgmt.eventgrid.models.TopicProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the topic.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.TopicRegenerateKeyRequest(*, key_name: str, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Topic regenerate share access key request.

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

Variables

key_name (str) – Key name to regenerate key1 or key2. Required.

Keyword Arguments

key_name (str) – Key name to regenerate key1 or key2. Required.

class azure.mgmt.eventgrid.models.TopicSharedAccessKeys(*, key1: Optional[str] = None, key2: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Shared access keys of the Topic.

Variables

• key1 (str) – Shared access key1 for the topic.

• key2 (str) – Shared access key2 for the topic.

Keyword Arguments

• key1 (str) – Shared access key1 for the topic.

• key2 (str) – Shared access key2 for the topic.

class azure.mgmt.eventgrid.models.TopicTypeInfo(*, provider: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, resource_region_type: Optional[Union[str, _models.ResourceRegionType]] = None, provisioning_state: Optional[Union[str, _models.TopicTypeProvisioningState]] = None, supported_locations: Optional[List[str]] = None, source_resource_format: Optional[str] = None, supported_scopes_for_source: Optional[List[Union[str, _models.TopicTypeSourceScope]]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Properties of a topic type info.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• 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. Known values are: “RegionalResource” and “GlobalResource”.

• provisioning_state (str or TopicTypeProvisioningState) – Provisioning state of the topic type. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• supported_locations (list[str]) – List of locations supported by this topic type.

• source_resource_format (str) – Source resource format.

• supported_scopes_for_source (list[str or TopicTypeSourceScope]) – Supported source scopes.

Keyword Arguments

• 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. Known values are: “RegionalResource” and “GlobalResource”.

• provisioning_state (str or TopicTypeProvisioningState) – Provisioning state of the topic type. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

• supported_locations (list[str]) – List of locations supported by this topic type.

• source_resource_format (str) – Source resource format.

• supported_scopes_for_source (list[str or TopicTypeSourceScope]) – Supported source scopes.

class azure.mgmt.eventgrid.models.TopicTypeProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the topic type.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.TopicTypeSourceScope(value)

Bases: str, enum.Enum

TopicTypeSourceScope.

AZURE_SUBSCRIPTION = 'AzureSubscription'

MANAGEMENT_GROUP = 'ManagementGroup'

RESOURCE = 'Resource'

RESOURCE_GROUP = 'ResourceGroup'

class azure.mgmt.eventgrid.models.TopicTypesListResult(*, value: Optional[List[_models.TopicTypeInfo]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Topic Types operation.

Variables

value (list[TopicTypeInfo]) – A collection of topic types.

Keyword Arguments

value (list[TopicTypeInfo]) – A collection of topic types.

class azure.mgmt.eventgrid.models.TopicUpdateParameters(*, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityInfo] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[_models.InboundIpRule]] = None, disable_local_auth: Optional[bool] = None, data_residency_boundary: Optional[Union[str, _models.DataResidencyBoundary]] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Properties of the Topic update.

Variables

• tags (dict[str, str]) – Tags of the Topic resource.

• identity (IdentityInfo) – Topic resource identity information.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.

• data_residency_boundary (str or DataResidencyBoundary) – The data residency boundary for the topic. Known values are: “WithinGeopair” and “WithinRegion”.

Keyword Arguments

• tags (dict[str, str]) – Tags of the Topic resource.

• identity (IdentityInfo) – Topic resource identity information.

• public_network_access (str or PublicNetworkAccess) – This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicUpdateParameterProperties.InboundIpRules" />. Known values are: “Enabled” and “Disabled”.

• inbound_ip_rules (list[InboundIpRule]) – This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

• disable_local_auth (bool) – This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the topic.

• data_residency_boundary (str or DataResidencyBoundary) – The data residency boundary for the topic. Known values are: “WithinGeopair” and “WithinRegion”.

class azure.mgmt.eventgrid.models.TopicsListResult(*, value: Optional[List[_models.Topic]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List Topics operation.

Variables

• value (list[Topic]) – A collection of Topics.

• next_link (str) – A link for the next page of topics.

Keyword Arguments

• value (list[Topic]) – A collection of Topics.

• next_link (str) – A link for the next page of topics.

class azure.mgmt.eventgrid.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_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.

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

Keyword Arguments

• location (str) – Location of the resource. Required.

• tags (dict[str, str]) – Tags of the resource.

class azure.mgmt.eventgrid.models.UserIdentityProperties(*, principal_id: Optional[str] = None, client_id: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

The information about the user identity.

Variables

• principal_id (str) – The principal id of user assigned identity.

• client_id (str) – The client id of user assigned identity.

Keyword Arguments

• principal_id (str) – The principal id of user assigned identity.

• client_id (str) – The client id of user assigned identity.

class azure.mgmt.eventgrid.models.VerifiedPartner(*, partner_registration_immutable_id: Optional[str] = None, organization_name: Optional[str] = None, partner_display_name: Optional[str] = None, partner_topic_details: Optional[_models.PartnerDetails] = None, provisioning_state: Optional[Union[str, _models.VerifiedPartnerProvisioningState]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_py3.Resource

Verified partner information.

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

Variables

• id (str) – Fully qualified identifier of the resource.

• name (str) – Name of the resource.

• type (str) – Type of the resource.

• system_data (SystemData) – The system metadata relating to Verified Partner resource.

• partner_registration_immutable_id (str) – ImmutableId of the corresponding partner registration.

• organization_name (str) – Official name of the Partner.

• partner_display_name (str) – Display name of the verified partner.

• partner_topic_details (PartnerDetails) – Details of the partner topic scenario.

• provisioning_state (str or VerifiedPartnerProvisioningState) – Provisioning state of the verified partner. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

Keyword Arguments

• partner_registration_immutable_id (str) – ImmutableId of the corresponding partner registration.

• organization_name (str) – Official name of the Partner.

• partner_display_name (str) – Display name of the verified partner.

• partner_topic_details (PartnerDetails) – Details of the partner topic scenario.

• provisioning_state (str or VerifiedPartnerProvisioningState) – Provisioning state of the verified partner. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Canceled”, and “Failed”.

class azure.mgmt.eventgrid.models.VerifiedPartnerProvisioningState(value)

Bases: str, enum.Enum

Provisioning state of the verified partner.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.eventgrid.models.VerifiedPartnersListResult(*, value: Optional[List[_models.VerifiedPartner]] = None, next_link: Optional[str] = None, **kwargs)

Bases: azure.mgmt.eventgrid._serialization.Model

Result of the List verified partners operation.

Variables

• value (list[VerifiedPartner]) – A collection of verified partners.

• next_link (str) – A link for the next page of verified partners if any.

Keyword Arguments

• value (list[VerifiedPartner]) – A collection of verified partners.

• next_link (str) – A link for the next page of verified partners if any.

class azure.mgmt.eventgrid.models.WebHookEventSubscriptionDestination(*, endpoint_url: Optional[str] = None, max_events_per_batch: int = 1, preferred_batch_size_in_kilobytes: int = 64, azure_active_directory_tenant_id: Optional[str] = None, azure_active_directory_application_id_or_uri: Optional[str] = None, delivery_attribute_mappings: Optional[List[_models.DeliveryAttributeMapping]] = None, **kwargs)

Bases: azure.mgmt.eventgrid.models._models_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.

Variables

• endpoint_type (str or EndpointType) – Type of the endpoint for the event subscription destination. Required. Known values are: “WebHook”, “EventHub”, “StorageQueue”, “HybridConnection”, “ServiceBusQueue”, “ServiceBusTopic”, and “AzureFunction”.

• endpoint_url (str) – The URL that represents the endpoint of the destination of an event subscription.

• endpoint_base_url (str) – The base URL that represents the endpoint of the destination of an event subscription.

• max_events_per_batch (int) – Maximum number of events per batch.

• preferred_batch_size_in_kilobytes (int) – Preferred batch size in Kilobytes.

• azure_active_directory_tenant_id (str) – The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

• azure_active_directory_application_id_or_uri (str) – The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.

Keyword Arguments

• endpoint_url (str) – The URL that represents the endpoint of the destination of an event subscription.

• max_events_per_batch (int) – Maximum number of events per batch.

• preferred_batch_size_in_kilobytes (int) – Preferred batch size in Kilobytes.

• azure_active_directory_tenant_id (str) – The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

• azure_active_directory_application_id_or_uri (str) – The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

• delivery_attribute_mappings (list[DeliveryAttributeMapping]) – Delivery attribute details.