SubscriptionsOperations Class

SubscriptionsOperations async 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

SubscriptionsOperations

Constructor

SubscriptionsOperations(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

create_or_update	Creates a topic subscription.
delete	Deletes a subscription from the specified topic.
get	Returns a subscription description for the specified topic.
list_by_topic	List all the subscriptions under a specified topic.

create_or_update

Creates a topic subscription.

async create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBSubscription, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBSubscription

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

parameters

<xref:azure.mgmt.servicebus.models.SBSubscription>

Required

Parameters supplied to create a subscription resource.

cls

callable

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

Returns

SBSubscription, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBSubscription>

Exceptions

HttpResponseError

delete

Deletes a subscription from the specified topic.

async delete(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Returns a subscription description for the specified topic.

async get(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBSubscription

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

cls

callable

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

Returns

SBSubscription, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.SBSubscription>

Exceptions

HttpResponseError

list_by_topic

List all the subscriptions under a specified topic.

list_by_topic(resource_group_name: str, namespace_name: str, topic_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBSubscriptionListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

skip

int

default value: None

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

top

int

default value: None

May be used to limit the number of results to the most recent N usageDetails.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.SBSubscriptionListResult>]

Exceptions

HttpResponseError

Attributes

models

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