TopicsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:topics> attribute.
- Inheritance
-
builtins.objectTopicsOperations
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.
async create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, parameters: _models.TopicCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TopicResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
parameters
Required
|
Parameters supplied to create a topic resource. Is either a TopicCreateOrUpdateParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
TopicResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: _models.SharedAccessAuthorizationRuleCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SharedAccessAuthorizationRuleResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
|
parameters
Required
|
The shared access authorization rule. Is either a SharedAccessAuthorizationRuleCreateOrUpdateParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
SharedAccessAuthorizationRuleResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a topic from the specified namespace and resource group.
async delete(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Returns a description for the specified topic.
async get(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> TopicResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
Returns
| Type | Description |
|---|---|
|
TopicResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: Any) -> SharedAccessAuthorizationRuleResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Returns
| Type | Description |
|---|---|
|
SharedAccessAuthorizationRuleResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_all
Gets all the topics in a namespace.
list_all(resource_group_name: str, namespace_name: str, **kwargs: Any) -> AsyncIterable[TopicResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either TopicResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_authorization_rules
Gets authorization rules for a topic.
list_authorization_rules(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> AsyncIterable[SharedAccessAuthorizationRuleResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either SharedAccessAuthorizationRuleResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: Any) -> ResourceListKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Returns
| Type | Description |
|---|---|
|
ResourceListKeys or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
post_authorization_rule
Returns the specified authorization rule.
async post_authorization_rule(resource_group_name: str, namespace_name: str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> SharedAccessAuthorizationRuleResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
Returns
| Type | Description |
|---|---|
|
SharedAccessAuthorizationRuleResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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: _models.RegenerateKeysParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceListKeysParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
authorization_rule_name
Required
|
The authorization rule name. Required. |
|
parameters
Required
|
Parameters supplied to regenerate the authorization rule. Is either a RegenerateKeysParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
ResourceListKeys or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python