TopicsOperations Class

TopicsOperations 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

TopicsOperations

Constructor

TopicsOperations(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 in the specified namespace.
create_or_update_authorization_rule	Creates an authorization rule for the specified topic.
delete	Deletes a topic from the specified namespace and resource group.
delete_authorization_rule	Deletes a topic authorization rule.
get	Returns a description for the specified topic.
get_authorization_rule	Returns the specified authorization rule.
list_authorization_rules	Gets authorization rules for a topic.
list_by_namespace	Gets all the topics in a namespace.
list_keys	Gets the primary and secondary connection strings for the topic.
regenerate_keys	Regenerates primary or secondary connection strings for the topic.

create_or_update

Creates a topic in the specified namespace.

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

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.

parameters

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

Required

Parameters supplied to create a topic resource.

cls

callable

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

Returns

SBTopic, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

create_or_update_authorization_rule

Creates an authorization rule for the specified topic.

async create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule

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.

authorization_rule_name

str

Required

The authorization rule name.

parameters

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

Required

The shared access authorization rule.

cls

callable

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

Returns

SBAuthorizationRule, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

delete

Deletes a topic from the specified namespace and resource group.

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

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

delete_authorization_rule

Deletes a topic authorization rule.

async delete_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_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.

authorization_rule_name

str

Required

The authorization rule 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 description for the specified topic.

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

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.

cls

callable

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

Returns

SBTopic, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

get_authorization_rule

Returns the specified authorization rule.

async get_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRule

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.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

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

Returns

SBAuthorizationRule, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

list_authorization_rules

Gets authorization rules for a topic.

list_authorization_rules(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.SBAuthorizationRuleListResult]

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.

cls

callable

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

Returns

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

Return type

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

Exceptions

HttpResponseError

list_by_namespace

Gets all the topics in a namespace.

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

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

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

Return type

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

Exceptions

HttpResponseError

list_keys

Gets the primary and secondary connection strings for the topic.

async list_keys(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeys

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.

authorization_rule_name

str

Required

The authorization rule name.

cls

callable

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

Returns

AccessKeys, or the result of cls(response)

Return type

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

Exceptions

HttpResponseError

regenerate_keys

Regenerates primary or secondary connection strings for the topic.

async regenerate_keys(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.RegenerateAccessKeyParameters, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.AccessKeys

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.

authorization_rule_name

str

Required

The authorization rule name.

parameters

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

Required

Parameters supplied to regenerate the authorization rule.

cls

callable

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

Returns

AccessKeys, or the result of cls(response)

Return type

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

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'>