TopicsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:topics> attribute.

Inheritance
builtins.object
TopicsOperations

Constructor

TopicsOperations(*args, **kwargs)

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.

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

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.

parameters
Required
SBTopic or IO

Parameters supplied to create a topic resource. Is either a SBTopic 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

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

Returns

Type Description

SBTopic or the result of cls(response)

Exceptions

Type Description
See also

create_or_update_authorization_rule

Creates an authorization rule for the specified topic.

create_or_update_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, parameters: _models.SBAuthorizationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SBAuthorizationRule

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.

authorization_rule_name
Required
str

The authorization rule name. Required.

parameters
Required

The shared access authorization rule. Is either a SBAuthorizationRule 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

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

Returns

Type Description

SBAuthorizationRule or the result of cls(response)

Exceptions

Type Description
See also

delete

Deletes a topic from the specified namespace and resource group.

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

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

delete_authorization_rule

Deletes a topic authorization rule.

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

authorization_rule_name
Required
str

The authorization rule name. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description
See also

get

Returns a description for the specified topic.

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

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

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

Returns

Type Description

SBTopic or the result of cls(response)

Exceptions

Type Description
See also

get_authorization_rule

Returns the specified authorization rule.

get_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> SBAuthorizationRule

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.

authorization_rule_name
Required
str

The authorization rule name. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

SBAuthorizationRule or the result of cls(response)

Exceptions

Type Description
See also

list_authorization_rules

Gets authorization rules for a topic.

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

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

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

Returns

Type Description

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

Exceptions

Type Description
See also

list_by_namespace

Gets all the topics in a namespace.

list_by_namespace(resource_group_name: str, namespace_name: str, skip: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[SBTopic]

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.

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

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

Returns

Type Description

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

Exceptions

Type Description
See also

list_keys

Gets the primary and secondary connection strings for the topic.

list_keys(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys

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.

authorization_rule_name
Required
str

The authorization rule name. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

AccessKeys or the result of cls(response)

Exceptions

Type Description
See also

regenerate_keys

Regenerates primary or secondary connection strings for the topic.

regenerate_keys(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, parameters: _models.RegenerateAccessKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AccessKeys

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.

authorization_rule_name
Required
str

The authorization rule name. Required.

parameters
Required

Parameters supplied to regenerate the authorization rule. Is either a RegenerateAccessKeyParameters 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

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

Returns

Type Description

AccessKeys or the result of cls(response)

Exceptions

Type Description
See also

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