Share via

TopicEventSubscriptionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:topic_event_subscriptions> attribute.

Inheritance
builtins.object
TopicEventSubscriptionsOperations

Constructor

TopicEventSubscriptionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update an event subscription to a topic.

Asynchronously creates a new event subscription or updates an existing event subscription.
begin_delete

Delete an event subscription for a topic.

Delete an existing event subscription for a topic.
begin_update

Update an event subscription for a topic.

Update an existing event subscription for a topic.
get

Get an event subscription of a topic.

Get properties of an event subscription of a topic.
get_delivery_attributes

Get delivery attributes for an event subscription for topic.

Get all delivery attributes for an event subscription for topic.
get_full_url

Get full URL of an event subscription for topic.

Get the full endpoint URL for an event subscription for topic.
list

List all event subscriptions for a specific topic.

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

begin_create_or_update

Create or update an event subscription to a topic.

Asynchronously creates a new event subscription or updates an existing event subscription.

begin_create_or_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_info: _models.EventSubscription, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EventSubscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the domain topic. Required.
event_subscription_name
Required
str

Name of the event subscription to be created. Event subscription names must be between 3 and 64 characters in length and use alphanumeric letters only. Required.
event_subscription_info
Required
EventSubscription or IO[bytes]

Event subscription properties containing the destination and filter information. Is either a EventSubscription type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[EventSubscription]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete an event subscription for a topic.

Delete an existing event subscription for a topic.

begin_delete(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the topic. Required.
event_subscription_name
Required
str

Name of the event subscription to be deleted. Required.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update an event subscription for a topic.

Update an existing event subscription for a topic.

begin_update(resource_group_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.EventSubscriptionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.EventSubscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the domain. Required.
event_subscription_name
Required
str

Name of the event subscription to be updated. Required.
event_subscription_update_parameters
Required
EventSubscriptionUpdateParameters or IO[bytes]

Updated event subscription information. Is either a EventSubscriptionUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[EventSubscription]

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

Exceptions

Type Description
HttpResponseError

get

Get an event subscription of a topic.

Get properties of an event subscription of a topic.

get(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> EventSubscription

Parameters

Name Description
resource_group_name
Required
str

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

Name of the topic. Required.
event_subscription_name
Required
str

Name of the event subscription to be found. Required.

Returns

Type Description
EventSubscription

EventSubscription or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_delivery_attributes

Get delivery attributes for an event subscription for topic.

Get all delivery attributes for an event subscription for topic.

get_delivery_attributes(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> DeliveryAttributeListResult

Parameters

Name Description
resource_group_name
Required
str

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

Name of the topic. Required.
event_subscription_name
Required
str

Name of the event subscription. Required.

Returns

Type Description
DeliveryAttributeListResult

DeliveryAttributeListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_full_url

Get full URL of an event subscription for topic.

Get the full endpoint URL for an event subscription for topic.

get_full_url(resource_group_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> EventSubscriptionFullUrl

Parameters

Name Description
resource_group_name
Required
str

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

Name of the domain topic. Required.
event_subscription_name
Required
str

Name of the event subscription. Required.

Returns

Type Description
EventSubscriptionFullUrl

EventSubscriptionFullUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List all event subscriptions for a specific topic.

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

list(resource_group_name: str, topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[EventSubscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the topic. Required.
filter
Required
str

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
Required
int

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.

Returns

Type Description
ItemPaged[EventSubscription]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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