SubscriptionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:subscriptions> attribute.

Inheritance

builtins.object

SubscriptionsOperations

Constructor

SubscriptionsOperations(*args, **kwargs)

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.

create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, parameters: _models.SBSubscription, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SBSubscription

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.
parameters Required	SBSubscription or IO Parameters supplied to create a subscription resource. Is either a SBSubscription type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
SBSubscription	SBSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx

delete

Deletes a subscription from the specified topic.

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

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.

Keyword-Only Parameters

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

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx

get

Returns a subscription description for the specified topic.

get(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, **kwargs: Any) -> SBSubscription

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.

Keyword-Only Parameters

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

Returns

Type	Description
SBSubscription	SBSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx

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: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[SBSubscription]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
skip Required	int 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. Default value is None.
top Required	int May be used to limit the number of results to the most recent N usageDetails. 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[SBSubscription]	An iterator like instance of either SBSubscription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx

Attributes

models

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