azure.mgmt.eventgrid.models module

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

Bases: msrest.serialization.Model

This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: NumberInAdvancedFilter, NumberNotInAdvancedFilter, NumberLessThanAdvancedFilter, NumberGreaterThanAdvancedFilter, NumberLessThanOrEqualsAdvancedFilter, NumberGreaterThanOrEqualsAdvancedFilter, BoolEqualsAdvancedFilter, StringInAdvancedFilter, StringNotInAdvancedFilter, StringBeginsWithAdvancedFilter, StringEndsWithAdvancedFilter, StringContainsAdvancedFilter

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

class azure.mgmt.eventgrid.models.AzureFunctionEventSubscriptionDestination(*, resource_id: str = None, max_events_per_batch: int = None, preferred_batch_size_in_kilobytes: int = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

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

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

BoolEquals Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

  • value (bool) – The boolean filter value.

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

Bases: msrest.serialization.Model

ConnectionState information.

Parameters

  • status (str or PersistedConnectionStatus) – Status of the connection. Possible values include: ‘Pending’, ‘Approved’, ‘Rejected’, ‘Disconnected’

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

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

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

Bases: msrest.serialization.Model

Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.

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

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

Parameters

endpoint_type (str) – Required. Constant filled by server.

class azure.mgmt.eventgrid.models.DeadLetterWithResourceIdentity(*, identity=None, dead_letter_destination=None, **kwargs)[source]

Bases: msrest.serialization.Model

Information about the deadletter destination with resource identity.

Parameters

  • 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.DeliveryWithResourceIdentity(*, identity=None, destination=None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters

  • 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=None, private_endpoint_connections=None, input_schema='EventGridSchema', input_schema_mapping=None, public_network_access=None, inbound_ip_rules=None, sku=None, identity=None, **kwargs)[source]

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

  • provisioning_state (str or DomainProvisioningState) – Provisioning state of the domain. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

  • endpoint (str) – Endpoint for the domain.

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

Parameters

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

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

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

  • input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the domain. Possible values include: ‘EventGridSchema’, ‘CustomEventSchema’, ‘CloudEventSchemaV1_0’. Default value: “EventGridSchema” .

  • 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” />. Possible values include: ‘Enabled’, ‘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.

  • sku (ResourceSku) – The Sku pricing tier for the domain.

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

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

Bases: msrest.serialization.Model

Domain regenerate share access key request.

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

Parameters

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

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

Bases: msrest.serialization.Model

Shared access keys of the Domain.

Parameters

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

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

class azure.mgmt.eventgrid.models.DomainTopic(*, provisioning_state=None, **kwargs)[source]

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

Parameters

provisioning_state (str or DomainTopicProvisioningState) – Provisioning state of the domain topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

class azure.mgmt.eventgrid.models.DomainUpdateParameters(*, tags=None, public_network_access=None, inbound_ip_rules=None, identity=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Domain update.

Parameters

  • tags (dict[str, str]) – Tags of the domains 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” />. Possible values include: ‘Enabled’, ‘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.

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

  • sku (ResourceSku) – The Sku pricing tier for the domain.

class azure.mgmt.eventgrid.models.EventChannel(*, source=None, destination=None, expiration_time_if_not_activated_utc=None, filter=None, partner_topic_friendly_description: str = None, **kwargs)[source]

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

Event Channel.

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

  • provisioning_state (str or EventChannelProvisioningState) – Provisioning state of the event channel. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

  • partner_topic_readiness_state (str or PartnerTopicReadinessState) – The readiness state of the corresponding partner topic. Possible values include: ‘NotActivatedByUserYet’, ‘ActivatedByUser’, ‘DeactivatedByUser’, ‘DeletedByUser’

Parameters

  • source (EventChannelSource) – Source of the event channel. This represents a unique resource in the partner’s resource model.

  • destination (EventChannelDestination) – Represents the destination of an event channel.

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

  • filter (EventChannelFilter) – Information about the filter for the event channel.

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

class azure.mgmt.eventgrid.models.EventChannelDestination(*, azure_subscription_id: str = None, resource_group: str = None, partner_topic_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the destination of an event channel.

Parameters

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

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

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

class azure.mgmt.eventgrid.models.EventChannelFilter(*, advanced_filters=None, **kwargs)[source]

Bases: msrest.serialization.Model

Filter for the Event Channel.

Parameters

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

class azure.mgmt.eventgrid.models.EventChannelSource(*, source: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the source of an event channel.

Parameters

source (str) – The identifier of the resource that’s the source of the events. This represents a unique resource in the partner’s resource model.

class azure.mgmt.eventgrid.models.EventHubEventSubscriptionDestination(*, resource_id: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

class azure.mgmt.eventgrid.models.EventSubscription(*, destination=None, delivery_with_resource_identity=None, filter=None, labels=None, expiration_time_utc=None, event_delivery_schema=None, retry_policy=None, dead_letter_destination=None, dead_letter_with_resource_identity=None, **kwargs)[source]

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

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

  • provisioning_state (str or EventSubscriptionProvisioningState) – Provisioning state of the event subscription. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’, ‘AwaitingManualAction’

Parameters

  • destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. 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. Possible values include: ‘EventGridSchema’, ‘CustomInputSchema’, ‘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)[source]

Bases: msrest.serialization.Model

Information about the destination for an event subscription.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WebHookEventSubscriptionDestination, EventHubEventSubscriptionDestination, StorageQueueEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination, ServiceBusQueueEventSubscriptionDestination, ServiceBusTopicEventSubscriptionDestination, AzureFunctionEventSubscriptionDestination

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

Parameters

endpoint_type (str) – Required. Constant filled by server.

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

Bases: msrest.serialization.Model

Filter for the Event Subscription.

Parameters

  • subject_begins_with (str) – An optional string to filter events for an event subscription based on a resource path prefix. The format of this depends on the publisher of the events. Wildcard characters are not supported in this path.

  • subject_ends_with (str) – An optional string to filter events for an event subscription based on a resource path suffix. Wildcard characters are not supported in this path.

  • included_event_types (list[str]) – A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.

  • is_subject_case_sensitive (bool) – Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter should be compared in a case sensitive manner. Default value: False .

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

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

Bases: msrest.serialization.Model

Full endpoint url of an event subscription.

Parameters

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

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

Bases: msrest.serialization.Model

The identity information with the event subscription.

Parameters

  • 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. Possible values include: ‘SystemAssigned’, ‘UserAssigned’

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

class azure.mgmt.eventgrid.models.EventSubscriptionUpdateParameters(*, destination=None, delivery_with_resource_identity=None, filter=None, labels=None, expiration_time_utc=None, event_delivery_schema=None, retry_policy=None, dead_letter_destination=None, dead_letter_with_resource_identity=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Event Subscription update.

Parameters

  • destination (EventSubscriptionDestination) – Information about the destination where events have to be delivered for the event subscription. 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. Possible values include: ‘EventGridSchema’, ‘CustomInputSchema’, ‘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.EventType(*, display_name: str = None, description: str = None, schema_url: str = None, is_in_default_set: bool = None, **kwargs)[source]

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

Parameters

  • 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.ExtensionTopic(*, description: str = None, system_topic: str = None, **kwargs)[source]

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

Parameters

  • 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: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

class azure.mgmt.eventgrid.models.IdentityInfo(*, type=None, principal_id: str = None, tenant_id: str = None, user_assigned_identities=None, **kwargs)[source]

Bases: msrest.serialization.Model

The identity information for the resource.

Parameters

  • 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. Possible values include: ‘None’, ‘SystemAssigned’, ‘UserAssigned’, ‘SystemAssigned, UserAssigned’

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

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

  • user_assigned_identities (dict[str, UserIdentityProperties]) – 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.InboundIpRule(*, ip_mask: str = None, action=None, **kwargs)[source]

Bases: msrest.serialization.Model

InboundIpRule.

Parameters

  • 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. Possible values include: ‘Allow’

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

Bases: msrest.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.

Parameters

input_schema_mapping_type (str) – Required. Constant filled by server.

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

Bases: msrest.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.

Parameters

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: str = None, default_value: str = None, **kwargs)[source]

Bases: msrest.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.

Parameters

  • 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=None, topic=None, event_time=None, event_type=None, subject=None, data_version=None, **kwargs)[source]

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.

Parameters

  • input_schema_mapping_type (str) – Required. Constant filled by server.

  • 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: str = None, value: float = None, **kwargs)[source]

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

NumberGreaterThan Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

  • value (float) – The filter value.

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

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

NumberGreaterThanOrEquals Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

  • value (float) – The filter value.

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

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

NumberIn Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

NumberLessThan Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

  • value (float) – The filter value.

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

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

NumberLessThanOrEquals Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

  • value (float) – The filter value.

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

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

NumberNotIn Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

class azure.mgmt.eventgrid.models.Operation(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents an operation returned by the GetOperations request.

Parameters

  • name (str) – Name of the operation

  • display (OperationInfo) – Display name of the operation

  • origin (str) – Origin of the operation

  • properties (object) – Properties of the operation

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

Bases: msrest.serialization.Model

Information about an operation.

Parameters

  • 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.PartnerNamespace(*, location: str, tags=None, partner_registration_fully_qualified_id: str = None, **kwargs)[source]

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

  • provisioning_state (str or PartnerNamespaceProvisioningState) – Provisioning state of the partner namespace. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

  • endpoint (str) – Endpoint for the partner namespace.

Parameters

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

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

  • partner_registration_fully_qualified_id (str) – 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}.

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

Bases: msrest.serialization.Model

PartnerNamespace regenerate shared access key request.

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

Parameters

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

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

Bases: msrest.serialization.Model

Shared access keys of the partner namespace.

Parameters

  • 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=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the PartnerNamespace update.

Parameters

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

class azure.mgmt.eventgrid.models.PartnerRegistration(*, location: str, tags=None, partner_name: str = None, partner_resource_type_name: str = None, partner_resource_type_display_name: str = None, partner_resource_type_description: str = None, long_description: str = None, partner_customer_service_number: str = None, partner_customer_service_extension: str = None, customer_service_uri: str = None, setup_uri: str = None, logo_uri: str = None, visibility_state=None, authorized_azure_subscription_ids=None, **kwargs)[source]

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

  • provisioning_state (str or PartnerRegistrationProvisioningState) – Provisioning state of the partner registration. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

Parameters

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

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

  • partner_name (str) – Official name of the partner name. For example: “Contoso”.

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

  • partner_resource_type_display_name (str) – Display name of the partner resource type.

  • partner_resource_type_description (str) – Short description of the partner resource type. The length of this description should not exceed 256 characters.

  • long_description (str) – Long description for the custom scenarios and integration to be displayed in the portal if needed. Length of this description should not exceed 2048 characters.

  • partner_customer_service_number (str) – The customer service number of the publisher. The expected phone format should start with a ‘+’ sign followed by the country code. The remaining digits are then followed. Only digits and spaces are allowed and its length cannot exceed 16 digits including country code. Examples of valid phone numbers are: +1 515 123 4567 and +966 7 5115 2471. Examples of invalid phone numbers are: +1 (515) 123-4567, 1 515 123 4567 and +966 121 5115 24 7 551 1234 43

  • partner_customer_service_extension (str) – The extension of the customer service number of the publisher. Only digits are allowed and number of digits should not exceed 10.

  • customer_service_uri (str) – The extension of the customer service URI of the publisher.

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

  • logo_uri (str) – URI of the logo.

  • visibility_state (str or PartnerRegistrationVisibilityState) – Visibility state of the partner registration. Possible values include: ‘Hidden’, ‘PublicPreview’, ‘GenerallyAvailable’

  • authorized_azure_subscription_ids (list[str]) – List of Azure subscription Ids that are authorized to create a partner namespace associated with this partner registration. This is an optional property. Creating partner namespaces is always permitted under the same Azure subscription as the one used for creating the partner registration.

class azure.mgmt.eventgrid.models.PartnerRegistrationEventTypesListResult(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Result of the List Partner Registration Event Types operation.

Parameters

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

  • next_link (str) – A link for the next page of partner registration event types.

class azure.mgmt.eventgrid.models.PartnerRegistrationUpdateParameters(*, tags=None, partner_topic_type_name: str = None, partner_topic_type_display_name: str = None, partner_topic_type_description: str = None, setup_uri: str = None, logo_uri: str = None, authorized_azure_subscription_ids=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Partner Registration update.

Parameters

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

  • partner_topic_type_name (str) – Name of the partner topic type.

  • partner_topic_type_display_name (str) – Display name of the partner topic type.

  • partner_topic_type_description (str) – Description of the partner topic type.

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

  • logo_uri (str) – URI of the partner logo.

  • authorized_azure_subscription_ids (list[str]) – List of IDs of Azure AD applications that are authorized to create a partner namespace associated with this partner registration. This is an optional property. Creating partner namespaces is always permitted under the same Azure subscription as the one used for creating the partner registration.

class azure.mgmt.eventgrid.models.PartnerTopic(*, location: str, tags=None, source: str = None, expiration_time_if_not_activated_utc=None, activation_state=None, partner_topic_friendly_description: str = None, **kwargs)[source]

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

EventGrid 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

  • provisioning_state (str or PartnerTopicProvisioningState) – Provisioning state of the partner topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

Parameters

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

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

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

  • 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. Possible values include: ‘NeverActivated’, ‘Activated’, ‘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.

class azure.mgmt.eventgrid.models.PartnerTopicType(*, partner_name: str = None, topic_type_name: str = None, display_name: str = None, description: str = None, setup_uri: str = None, authorization_state=None, **kwargs)[source]

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

Properties of a partner topic type.

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

Parameters

  • partner_name (str) – Official name of the partner.

  • topic_type_name (str) – Name of the partner topic type. This name should be unique among all partner topic types names.

  • display_name (str) – Display Name for the partner topic type.

  • description (str) – Description of the partner topic type.

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

  • authorization_state (str or PartnerTopicTypeAuthorizationState) – Status of whether the customer has authorized a partner to create partner topics in the customer’s subscription. Possible values include: ‘NotApplicable’, ‘NotAuthorized’, ‘Authorized’

class azure.mgmt.eventgrid.models.PartnerTopicTypesListResult(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Result of the List Partner Topic Types operation.

Parameters

value (list[PartnerTopicType]) – A collection of partner topic types.

class azure.mgmt.eventgrid.models.PartnerTopicUpdateParameters(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Partner Topic update.

Parameters

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

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

Bases: msrest.serialization.Model

PrivateEndpoint information.

Parameters

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

class azure.mgmt.eventgrid.models.PrivateEndpointConnection(*, private_endpoint=None, group_ids=None, private_link_service_connection_state=None, provisioning_state=None, **kwargs)[source]

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

Parameters

  • 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. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

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

Bases: msrest.serialization.Model

Information of the private link resource.

Parameters

  • group_id (str) –

  • display_name (str) –

  • required_members (list[str]) –

  • required_zone_names (list[str]) –

  • 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.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

Definition of a Resource.

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

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.ResourceSku(*, name=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes an EventGrid Resource Sku.

Parameters

name (str or Sku) – The Sku name of the resource. The possible values are: Basic or Premium. Possible values include: ‘Basic’, ‘Premium’

class azure.mgmt.eventgrid.models.RetryPolicy(*, max_delivery_attempts: int = None, event_time_to_live_in_minutes: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Information about the retry policy for an event subscription.

Parameters

  • 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: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

class azure.mgmt.eventgrid.models.ServiceBusTopicEventSubscriptionDestination(*, resource_id: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

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

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

  • 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: str = None, queue_name: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

  • resource_id (str) – The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.

  • queue_name (str) – The name of the Storage queue under a storage account that is the destination of an event subscription.

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

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

StringBeginsWith Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

StringContains Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

StringEndsWith Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

StringIn Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

StringNotIn Advanced Filter.

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

Parameters

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

  • operator_type (str) – Required. Constant filled by server.

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

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

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

  • provisioning_state (str or ResourceProvisioningState) – Provisioning state of the system topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

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

Parameters

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

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

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

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

class azure.mgmt.eventgrid.models.SystemTopicUpdateParameters(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the System Topic update.

Parameters

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

class azure.mgmt.eventgrid.models.Topic(*, location: str, tags=None, private_endpoint_connections=None, input_schema='EventGridSchema', input_schema_mapping=None, public_network_access=None, inbound_ip_rules=None, sku=None, identity=None, **kwargs)[source]

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

  • provisioning_state (str or TopicProvisioningState) – Provisioning state of the topic. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

  • endpoint (str) – Endpoint for the topic.

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

Parameters

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

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

  • private_endpoint_connections (list[PrivateEndpointConnection]) –

  • input_schema (str or InputSchema) – This determines the format that Event Grid should expect for incoming events published to the topic. Possible values include: ‘EventGridSchema’, ‘CustomEventSchema’, ‘CloudEventSchemaV1_0’. Default value: “EventGridSchema” .

  • 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” />. Possible values include: ‘Enabled’, ‘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.

  • sku (ResourceSku) – The Sku pricing tier for the topic.

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

class azure.mgmt.eventgrid.models.TopicRegenerateKeyRequest(*, key_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Topic regenerate share access key request.

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

Parameters

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

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

Bases: msrest.serialization.Model

Shared access keys of the Topic.

Parameters

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

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

class azure.mgmt.eventgrid.models.TopicTypeInfo(*, provider: str = None, display_name: str = None, description: str = None, resource_region_type=None, provisioning_state=None, supported_locations=None, source_resource_format: str = None, **kwargs)[source]

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

Parameters

  • provider (str) – Namespace of the provider of the topic type.

  • display_name (str) – Display Name for the topic type.

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

  • resource_region_type (str or ResourceRegionType) – Region type of the resource. Possible values include: ‘RegionalResource’, ‘GlobalResource’

  • provisioning_state (str or TopicTypeProvisioningState) – Provisioning state of the topic type. Possible values include: ‘Creating’, ‘Updating’, ‘Deleting’, ‘Succeeded’, ‘Canceled’, ‘Failed’

  • supported_locations (list[str]) – List of locations supported by this topic type.

  • source_resource_format (str) – Source resource format.

class azure.mgmt.eventgrid.models.TopicUpdateParameters(*, tags=None, identity=None, public_network_access=None, inbound_ip_rules=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Topic update.

Parameters

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

  • identity (IdentityInfo) – 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” />. Possible values include: ‘Enabled’, ‘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.

  • sku (ResourceSku) – The Sku pricing tier for the topic.

class azure.mgmt.eventgrid.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]

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

Parameters

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

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

class azure.mgmt.eventgrid.models.UserIdentityProperties(*, principal_id: str = None, client_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The information about the user identity.

Parameters

  • 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.WebHookEventSubscriptionDestination(*, endpoint_url: str = None, max_events_per_batch: int = None, preferred_batch_size_in_kilobytes: int = None, azure_active_directory_tenant_id: str = None, azure_active_directory_application_id_or_uri: str = None, **kwargs)[source]

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.

Parameters

  • endpoint_type (str) – Required. Constant filled by server.

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

Variables

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

class azure.mgmt.eventgrid.models.DomainPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Domain object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.DomainTopicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DomainTopic object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.EventChannelPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventChannel object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.EventSubscriptionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventSubscription object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PartnerNamespacePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PartnerNamespace object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PartnerRegistrationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PartnerRegistration object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PartnerTopicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PartnerTopic object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PrivateEndpointConnectionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PrivateEndpointConnection object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PrivateLinkResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PrivateLinkResource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.SystemTopicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SystemTopic object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.TopicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Topic object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.EventTypePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EventType object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.TopicTypeInfoPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of TopicTypeInfo object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.eventgrid.models.PersistedConnectionStatus[source]

Bases: str, enum.Enum

An enumeration.

approved = 'Approved'
disconnected = 'Disconnected'
pending = 'Pending'
rejected = 'Rejected'
class azure.mgmt.eventgrid.models.ResourceProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.DomainProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.InputSchema[source]

Bases: str, enum.Enum

An enumeration.

cloud_event_schema_v1_0 = 'CloudEventSchemaV1_0'
custom_event_schema = 'CustomEventSchema'
event_grid_schema = 'EventGridSchema'
class azure.mgmt.eventgrid.models.PublicNetworkAccess[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.eventgrid.models.IpActionType[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
class azure.mgmt.eventgrid.models.Sku[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
premium = 'Premium'
class azure.mgmt.eventgrid.models.IdentityType[source]

Bases: str, enum.Enum

An enumeration.

none = 'None'
system_assigned = 'SystemAssigned'
system_assigned_user_assigned = 'SystemAssigned, UserAssigned'
user_assigned = 'UserAssigned'
class azure.mgmt.eventgrid.models.DomainTopicProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.EventChannelProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.PartnerTopicReadinessState[source]

Bases: str, enum.Enum

An enumeration.

activated_by_user = 'ActivatedByUser'
deactivated_by_user = 'DeactivatedByUser'
deleted_by_user = 'DeletedByUser'
not_activated_by_user_yet = 'NotActivatedByUserYet'
class azure.mgmt.eventgrid.models.EventSubscriptionProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

awaiting_manual_action = 'AwaitingManualAction'
canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.EventSubscriptionIdentityType[source]

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'
user_assigned = 'UserAssigned'
class azure.mgmt.eventgrid.models.EventDeliverySchema[source]

Bases: str, enum.Enum

An enumeration.

cloud_event_schema_v1_0 = 'CloudEventSchemaV1_0'
custom_input_schema = 'CustomInputSchema'
event_grid_schema = 'EventGridSchema'
class azure.mgmt.eventgrid.models.PartnerNamespaceProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.PartnerRegistrationProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.PartnerRegistrationVisibilityState[source]

Bases: str, enum.Enum

An enumeration.

generally_available = 'GenerallyAvailable'
hidden = 'Hidden'
public_preview = 'PublicPreview'
class azure.mgmt.eventgrid.models.PartnerTopicProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.PartnerTopicActivationState[source]

Bases: str, enum.Enum

An enumeration.

activated = 'Activated'
deactivated = 'Deactivated'
never_activated = 'NeverActivated'
class azure.mgmt.eventgrid.models.PartnerTopicTypeAuthorizationState[source]

Bases: str, enum.Enum

An enumeration.

authorized = 'Authorized'
not_applicable = 'NotApplicable'
not_authorized = 'NotAuthorized'
class azure.mgmt.eventgrid.models.TopicProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.eventgrid.models.ResourceRegionType[source]

Bases: str, enum.Enum

An enumeration.

global_resource = 'GlobalResource'
regional_resource = 'RegionalResource'
class azure.mgmt.eventgrid.models.TopicTypeProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'