Share via

NamespaceTopicEventSubscriptionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:namespace_topic_event_subscriptions> attribute.

Constructor

NamespaceTopicEventSubscriptionsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update an event subscription of a namespace topic.

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

Delete an event subscription of a namespace topic.

Delete an existing event subscription of a namespace topic.
begin_update

Update event subscription of a namespace topic.

Update an existing event subscription of a namespace topic.
get

Get an event subscription of a namespace topic.

Get properties of an event subscription of a namespace topic.
get_delivery_attributes

Get delivery attributes for an event subscription of a namespace topic.

Get all delivery attributes for an event subscription of a namespace topic.
get_full_url

Get full URL of an event subscription of a namespace topic.

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

List event subscriptions of a namespace topic.

List event subscriptions that belong to a specific namespace topic.

begin_create_or_update

Create or update an event subscription of a namespace topic.

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

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

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_name
Required
str

Name of the namespace topic. Required.
event_subscription_name
Required
str

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

Event subscription properties containing the delivery mode, filter information, and others. Is either a Subscription type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Subscription]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete an event subscription of a namespace topic.

Delete an existing event subscription of a namespace topic.

async begin_delete(resource_group_name: str, namespace_name: str, 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.
namespace_name
Required
str

Name of the namespace. Required.
topic_name
Required
str

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

Update an existing event subscription of a namespace topic.

async begin_update(resource_group_name: str, namespace_name: str, topic_name: str, event_subscription_name: str, event_subscription_update_parameters: _models.SubscriptionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Subscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_name
Required
str

Name of the namespace topic. Required.
event_subscription_name
Required
str

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

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

Returns

Type Description
AsyncLROPoller[Subscription]

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

Exceptions

Type Description
HttpResponseError

get

Get an event subscription of a namespace topic.

Get properties of an event subscription of a namespace topic.

async get(resource_group_name: str, namespace_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> Subscription

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_name
Required
str

Name of the namespace topic. Required.
event_subscription_name
Required
str

Name of the event subscription to be found. Required.

Returns

Type Description
Subscription

Subscription or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_delivery_attributes

Get delivery attributes for an event subscription of a namespace topic.

Get all delivery attributes for an event subscription of a namespace topic.

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

Name of the namespace. Required.
topic_name
Required
str

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

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

async get_full_url(resource_group_name: str, namespace_name: str, topic_name: str, event_subscription_name: str, **kwargs: Any) -> SubscriptionFullUrl

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_name
Required
str

Name of the namespace topic. Required.
event_subscription_name
Required
str

Name of the event subscription. Required.

Returns

Type Description
SubscriptionFullUrl

SubscriptionFullUrl or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace_topic

List event subscriptions of a namespace topic.

List event subscriptions that belong to a specific namespace topic.

list_by_namespace_topic(resource_group_name: str, namespace_name: str, topic_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[Subscription]

Parameters

Name Description
resource_group_name
Required
str

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

Name of the namespace. Required.
topic_name
Required
str

Name of the namespace topic. Required.
filter
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.

Default value: None
top
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.

Default value: None

Returns

Type Description
AsyncItemPaged[Subscription]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv130\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>