Share via

SystemTopicEventSubscriptionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:system_topic_event_subscriptions> attribute.

Inheritance
builtins.object
SystemTopicEventSubscriptionsOperations

Constructor

SystemTopicEventSubscriptionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update an event subscription for a system topic.

Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
begin_delete

Delete an event subscription of a system topic.

Delete an existing event subscription of a system topic.
begin_update

Update event subscription of a system topic.

Update an existing event subscription of a system topic.
get

Get an event subscription of a system topic.

Get 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 of a system topic.

Get the full endpoint URL for an event subscription of a system topic.
list_by_system_topic

List event subscriptions of a system topic.

List event subscriptions that belong to a specific system topic.

begin_create_or_update

Create or update an event subscription for a system topic.

Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

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

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system 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
AsyncLROPoller[EventSubscription]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete an event subscription of a system topic.

Delete an existing event subscription of a system topic.

async begin_delete(resource_group_name: str, system_topic_name: str, event_subscription_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system topic. Required.
event_subscription_name
Required
str

Name of the event subscription to be deleted. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Update event subscription of a system topic.

Update an existing event subscription of a system topic.

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

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system topic. 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
AsyncLROPoller[EventSubscription]

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

Exceptions

Type Description
HttpResponseError

get

Get an event subscription of a system topic.

Get an event subscription.

async get(resource_group_name: str, system_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.
system_topic_name
Required
str

Name of the system 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.

Get all delivery attributes for an event subscription.

async get_delivery_attributes(resource_group_name: str, system_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.
system_topic_name
Required
str

Name of the system 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 of a system topic.

Get the full endpoint URL for an event subscription of a system topic.

async get_full_url(resource_group_name: str, system_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.
system_topic_name
Required
str

Name of the system 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_by_system_topic

List event subscriptions of a system topic.

List event subscriptions that belong to a specific system topic.

list_by_system_topic(resource_group_name: str, system_topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[EventSubscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the system 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
AsyncItemPaged[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'>