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_all	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.SubscriptionCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SubscriptionResource

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	SubscriptionCreateOrUpdateParameters or IO Parameters supplied to create a subscription resource. Is either a SubscriptionCreateOrUpdateParameters 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
SubscriptionResource	SubscriptionResource 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) -> SubscriptionResource

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
SubscriptionResource	SubscriptionResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

list_all

List all the subscriptions under a specified topic.

list_all(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> Iterable[SubscriptionResource]

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.

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[SubscriptionResource]	An iterator like instance of either SubscriptionResource 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.v2015_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2015_08_01\\models\\__init__.py'>