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_all	Gets all the topics in a namespace.
list_authorization_rules	Gets authorization rules for a topic.
list_keys	Gets the primary and secondary connection strings for the topic.
post_authorization_rule	Returns the specified authorization rule.
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.TopicCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TopicResource

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	TopicCreateOrUpdateParameters or IO Parameters supplied to create a topic resource. Is either a TopicCreateOrUpdateParameters 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
TopicResource	TopicResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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

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	SharedAccessAuthorizationRuleCreateOrUpdateParameters or IO The shared access authorization rule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters 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
SharedAccessAuthorizationRuleResource	SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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	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/mt639404.aspx

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	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/mt720681.aspx

get

Returns a description for the specified topic.

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

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

Exceptions

Type	Description
HttpResponseError

See also

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

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) -> SharedAccessAuthorizationRuleResource

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	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

list_all

Gets all the topics in a namespace.

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

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.

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[TopicResource]	An iterator like instance of either TopicResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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[SharedAccessAuthorizationRuleResource]

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[SharedAccessAuthorizationRuleResource]	An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

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

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) -> ResourceListKeys

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	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

post_authorization_rule

Returns the specified authorization rule.

post_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> SharedAccessAuthorizationRuleResource

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	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

See also

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

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

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	RegenerateKeysParameters or IO Parameters supplied to regenerate the authorization rule. Is either a RegenerateKeysParameters 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
ResourceListKeys	ResourceListKeys or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

See also

• https://msdn.microsoft.com/en-us/library/azure/mt720679.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'>