TopicsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:topics> attribute.

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
parameters Required	SBTopic or SBTopic or IO[bytes] Parameters supplied to create a topic resource. Is either a SBTopic type or a IO[bytes] type. Required.

Returns

Type	Description
SBTopic	SBTopic. The SBTopic is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. 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	SBAuthorizationRule or SBAuthorizationRule or IO[bytes] The shared access authorization rule. Is either a SBAuthorizationRule type or a IO[bytes] type. Required.

Returns

Type	Description
SBAuthorizationRule	SBAuthorizationRule. The SBAuthorizationRule is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. 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.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.

Returns

Type	Description
SBTopic	SBTopic. The SBTopic is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. 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.

Returns

Type	Description
SBAuthorizationRule	SBAuthorizationRule. The SBAuthorizationRule is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_authorization_rules

Gets authorization rules for a topic.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.

Returns

Type	Description
ItemPaged[SBAuthorizationRule]	An iterator like instance of SBAuthorizationRule

Exceptions

Type	Description
HttpResponseError

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) -> ItemPaged[SBTopic]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str The namespace name. Required.

Keyword-Only Parameters

Name	Description
skip	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. Default value: None
top	int May be used to limit the number of results to the most recent N usageDetails. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[SBTopic]	An iterator like instance of SBTopic

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. 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.

Returns

Type	Description
AccessKeys	AccessKeys. The AccessKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

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 The name of the resource group. The name is case insensitive. 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	RegenerateAccessKeyParameters or RegenerateAccessKeyParameters or IO[bytes] Parameters supplied to regenerate the authorization rule. Is either a RegenerateAccessKeyParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AccessKeys	AccessKeys. The AccessKeys is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError