azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations
name: TopicsOperations
fullName: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations
module: azure.mgmt.servicebus.v2021_11_01.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.servicebus.v2021_11_01.aio.ServiceBusManagementClient>'s\n\
  >\n> <xref:topics> attribute.\n>"
constructor:
  syntax: TopicsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.create_or_update
  name: create_or_update
  summary: Creates a topic in the specified namespace.
  signature: 'async 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: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to create a topic resource. Is either a SBTopic
      type or

      a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SBTopic or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.create_or_update_authorization_rule
  name: create_or_update_authorization_rule
  summary: Creates an authorization rule for the specified topic.
  signature: 'async 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: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The shared access authorization rule. Is either a SBAuthorizationRule
      type

      or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SBAuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.delete
  name: delete
  summary: Deletes a topic from the specified namespace and resource group.
  signature: 'async delete(resource_group_name: str, namespace_name: str, topic_name:
    str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.delete_authorization_rule
  name: delete_authorization_rule
  summary: Deletes a topic authorization rule.
  signature: 'async delete_authorization_rule(resource_group_name: str, namespace_name:
    str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> None'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.get
  name: get
  summary: Returns a description for the specified topic.
  signature: 'async get(resource_group_name: str, namespace_name: str, topic_name:
    str, **kwargs: Any) -> SBTopic'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SBTopic or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.get_authorization_rule
  name: get_authorization_rule
  summary: Returns the specified authorization rule.
  signature: 'async get_authorization_rule(resource_group_name: str, namespace_name:
    str, topic_name: str, authorization_rule_name: str, **kwargs: Any) -> SBAuthorizationRule'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: SBAuthorizationRule or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_authorization_rules
  name: list_authorization_rules
  summary: Gets authorization rules for a topic.
  signature: 'list_authorization_rules(resource_group_name: str, namespace_name: str,
    topic_name: str, **kwargs: Any) -> AsyncIterable[SBAuthorizationRule]'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either SBAuthorizationRule or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.servicebus.v2021_11_01.models.SBAuthorizationRule>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_by_namespace
  name: list_by_namespace
  summary: Gets all the topics in a namespace.
  signature: 'list_by_namespace(resource_group_name: str, namespace_name: str, skip:
    int | None = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[SBTopic]'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: skip
    description: '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.'
    isRequired: true
    types:
    - <xref:int>
  - name: top
    description: 'May be used to limit the number of results to the most recent N
      usageDetails.

      Default value is None.'
    isRequired: true
    types:
    - <xref:int>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either SBTopic or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.servicebus.v2021_11_01.models.SBTopic>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.list_keys
  name: list_keys
  summary: Gets the primary and secondary connection strings for the topic.
  signature: 'async list_keys(resource_group_name: str, namespace_name: str, topic_name:
    str, authorization_rule_name: str, **kwargs: Any) -> AccessKeys'
  parameters:
  - name: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AccessKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.AccessKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx)\
    \ \n"
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.regenerate_keys
  name: regenerate_keys
  summary: Regenerates primary or secondary connection strings for the topic.
  signature: 'async 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: resource_group_name
    description: Name of the Resource group within the Azure subscription. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: namespace_name
    description: The namespace name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: topic_name
    description: The topic name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: authorization_rule_name
    description: The authorization rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to regenerate the authorization rule. Is either
      a

      RegenerateAccessKeyParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.RegenerateAccessKeyParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AccessKeys or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_11_01.models.AccessKeys>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
  seeAlsoContent: "\n\n  * [https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx](https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx)\
    \ \n"
attributes:
- uid: azure.mgmt.servicebus.v2021_11_01.aio.operations.TopicsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.servicebus.v2021_11_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2021_11_01\\models\\__init__.py'>