EventSubscriptionsOperations Class

EventSubscriptionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

EventSubscriptionsOperations

Constructor

EventSubscriptionsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Create or update an event subscription. Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.
begin_delete	Delete an event subscription. Delete an existing event subscription.
begin_update	Update an event subscription. Asynchronously updates an existing event subscription.
get	Get an event subscription. Get properties of an event subscription.
get_delivery_attributes	Get delivery attributes for an event subscription. Get all delivery attributes for an event subscription.
get_full_url	Get full URL of an event subscription. Get the full endpoint URL for an event subscription.
list_by_domain_topic	List all event subscriptions for a specific domain topic. List all event subscriptions that have been created for a specific domain topic.
list_by_resource	List all event subscriptions. List all event subscriptions that have been created for a specific resource.
list_global_by_resource_group	List all global event subscriptions under an Azure subscription and resource group. List all global event subscriptions under a specific Azure subscription and resource group.
list_global_by_resource_group_for_topic_type	List all global event subscriptions under a resource group for a topic type. List all global event subscriptions under a resource group for a specific topic type.
list_global_by_subscription	Get an aggregated list of all global event subscriptions under an Azure subscription. List all aggregated global event subscriptions under a specific Azure subscription.
list_global_by_subscription_for_topic_type	List all global event subscriptions for a topic type. List all global event subscriptions under an Azure subscription for a topic type.
list_regional_by_resource_group	List all regional event subscriptions under an Azure subscription and resource group. List all event subscriptions from the given location under a specific Azure subscription and resource group.
list_regional_by_resource_group_for_topic_type	List all regional event subscriptions under an Azure subscription and resource group for a topic type. List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.
list_regional_by_subscription	List all regional event subscriptions under an Azure subscription. List all event subscriptions from the given location under a specific Azure subscription.
list_regional_by_subscription_for_topic_type	List all regional event subscriptions under an Azure subscription for a topic type. List all event subscriptions from the given location under a specific Azure subscription and topic type.

begin_create_or_update

Create or update an event subscription.

Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.

begin_create_or_update(scope: str, event_subscription_name: str, event_subscription_info: azure.mgmt.eventgrid.models._models_py3.EventSubscription, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.EventSubscription]

Parameters

scope

str

Required

The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.

event_subscription_info

EventSubscription

Required

Event subscription properties containing the destination and filter information.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EventSubscription or the result of cls(response)

Return type

LROPoller[EventSubscription]

Exceptions

HttpResponseError

begin_delete

Delete an event subscription.

Delete an existing event subscription.

begin_delete(scope: str, event_subscription_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

scope

str

Required

The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Update an event subscription.

Asynchronously updates an existing event subscription.

begin_update(scope: str, event_subscription_name: str, event_subscription_update_parameters: azure.mgmt.eventgrid.models._models_py3.EventSubscriptionUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.eventgrid.models._models_py3.EventSubscription]

Parameters

scope

str

Required

The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription to be updated.

event_subscription_update_parameters

EventSubscriptionUpdateParameters

Required

Updated event subscription information.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EventSubscription or the result of cls(response)

Return type

LROPoller[EventSubscription]

Exceptions

HttpResponseError

get

Get an event subscription.

Get properties of an event subscription.

get(scope: str, event_subscription_name: str, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.EventSubscription

Parameters

scope

str

Required

The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription.

cls

callable

A custom type or function that will be passed the direct response

Returns

EventSubscription, or the result of cls(response)

Return type

EventSubscription

Exceptions

HttpResponseError

get_delivery_attributes

Get delivery attributes for an event subscription.

Get all delivery attributes for an event subscription.

get_delivery_attributes(scope: str, event_subscription_name: str, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.DeliveryAttributeListResult

Parameters

scope

str

Required

The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription.

cls

callable

A custom type or function that will be passed the direct response

Returns

DeliveryAttributeListResult, or the result of cls(response)

Return type

DeliveryAttributeListResult

Exceptions

HttpResponseError

get_full_url

Get full URL of an event subscription.

Get the full endpoint URL for an event subscription.

get_full_url(scope: str, event_subscription_name: str, **kwargs: Any) -> azure.mgmt.eventgrid.models._models_py3.EventSubscriptionFullUrl

Parameters

scope

str

Required

The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

event_subscription_name

str

Required

Name of the event subscription.

cls

callable

A custom type or function that will be passed the direct response

Returns

EventSubscriptionFullUrl, or the result of cls(response)

Return type

EventSubscriptionFullUrl

Exceptions

HttpResponseError

list_by_domain_topic

List all event subscriptions for a specific domain topic.

List all event subscriptions that have been created for a specific domain topic.

list_by_domain_topic(resource_group_name: str, domain_name: str, topic_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

domain_name

str

Required

Name of the top level domain.

topic_name

str

Required

Name of the domain topic.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_by_resource

List all event subscriptions.

List all event subscriptions that have been created for a specific resource.

list_by_resource(resource_group_name: str, provider_namespace: str, resource_type_name: str, resource_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

provider_namespace

str

Required

Namespace of the provider of the topic.

resource_type_name

str

Required

Name of the resource type.

resource_name

str

Required

Name of the resource.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_global_by_resource_group

List all global event subscriptions under an Azure subscription and resource group.

List all global event subscriptions under a specific Azure subscription and resource group.

list_global_by_resource_group(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_global_by_resource_group_for_topic_type

List all global event subscriptions under a resource group for a topic type.

List all global event subscriptions under a resource group for a specific topic type.

list_global_by_resource_group_for_topic_type(resource_group_name: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

topic_type_name

str

Required

Name of the topic type.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_global_by_subscription

Get an aggregated list of all global event subscriptions under an Azure subscription.

List all aggregated global event subscriptions under a specific Azure subscription.

list_global_by_subscription(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_global_by_subscription_for_topic_type

List all global event subscriptions for a topic type.

List all global event subscriptions under an Azure subscription for a topic type.

list_global_by_subscription_for_topic_type(topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

topic_type_name

str

Required

Name of the topic type.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_regional_by_resource_group

List all regional event subscriptions under an Azure subscription and resource group.

List all event subscriptions from the given location under a specific Azure subscription and resource group.

list_regional_by_resource_group(resource_group_name: str, location: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

location

str

Required

Name of the location.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_regional_by_resource_group_for_topic_type

List all regional event subscriptions under an Azure subscription and resource group for a topic type.

List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.

list_regional_by_resource_group_for_topic_type(resource_group_name: str, location: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the user's subscription.

location

str

Required

Name of the location.

topic_type_name

str

Required

Name of the topic type.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_regional_by_subscription

List all regional event subscriptions under an Azure subscription.

List all event subscriptions from the given location under a specific Azure subscription.

list_regional_by_subscription(location: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

location

str

Required

Name of the location.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

list_regional_by_subscription_for_topic_type

List all regional event subscriptions under an Azure subscription for a topic type.

List all event subscriptions from the given location under a specific Azure subscription and topic type.

list_regional_by_subscription_for_topic_type(location: str, topic_type_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.eventgrid.models._models_py3.EventSubscriptionsListResult]

Parameters

location

str

Required

Name of the location.

topic_type_name

str

Required

Name of the topic type.

filter

str

Required

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.

top

int

Required

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EventSubscriptionsListResult or the result of cls(response)

Return type

ItemPaged[EventSubscriptionsListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>