SystemTopicEventSubscriptionsOperations Class

SystemTopicEventSubscriptionsOperations 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

SystemTopicEventSubscriptionsOperations

Constructor

SystemTopicEventSubscriptionsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
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

Name	Description
models	Alias to model classes used in this operation group.

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.

begin_create_or_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_info: EventSubscription, **kwargs: Any) -> LROPoller[EventSubscription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
event_subscription_info Required	EventSubscription Event subscription properties containing the destination and filter information.

Keyword-Only Parameters

Name	Description
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

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

Delete an existing event subscription of a system topic.

begin_delete(resource_group_name: str, system_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.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.

Keyword-Only Parameters

Name	Description
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

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

Update an existing event subscription of a system topic.

begin_update(resource_group_name: str, system_topic_name: str, event_subscription_name: str, event_subscription_update_parameters: EventSubscriptionUpdateParameters, **kwargs: Any) -> LROPoller[EventSubscription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
event_subscription_update_parameters Required	EventSubscriptionUpdateParameters Updated event subscription information.

Keyword-Only Parameters

Name	Description
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

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 system topic.

Get an event subscription.

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.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

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.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

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.
system_topic_name Required	str Name of the system topic.
event_subscription_name Required	str Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> Iterable[EventSubscriptionsListResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group within the user's subscription.
system_topic_name Required	str Name of the system topic.
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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[EventSubscriptionsListResult]	An iterator like instance of either EventSubscriptionsListResult 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'>