azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations
name: RulesOperations
fullName: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations
module: azure.mgmt.servicebus.v2021_06_01_preview.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_06_01_preview.ServiceBusManagementClient>'s\n\
  >\n> <xref:rules> attribute.\n>"
constructor:
  syntax: RulesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.create_or_update
  name: create_or_update
  summary: Creates a new rule and updates an existing rule.
  signature: 'create_or_update(resource_group_name: str, namespace_name: str, topic_name:
    str, subscription_name: str, rule_name: str, parameters: _models.Rule, *, content_type:
    str = ''application/json'', **kwargs: Any) -> _models.Rule'
  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: subscription_name
    description: The subscription name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: rule_name
    description: The rule name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to create a rule. Is either a Rule type or a
      IO type.

      Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.servicebus.v2021_06_01_preview.models.Rule>
    - <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: Rule or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_06_01_preview.models.Rule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.delete
  name: delete
  summary: Deletes an existing rule.
  signature: 'delete(resource_group_name: str, namespace_name: str, topic_name: str,
    subscription_name: str, 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: subscription_name
    description: The subscription name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: rule_name
    description: The 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
- uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.get
  name: get
  summary: Retrieves the description for the specified rule.
  signature: 'get(resource_group_name: str, namespace_name: str, topic_name: str,
    subscription_name: str, rule_name: str, **kwargs: Any) -> Rule'
  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: subscription_name
    description: The subscription name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: rule_name
    description: The 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: Rule or the result of cls(response)
    types:
    - <xref:azure.mgmt.servicebus.v2021_06_01_preview.models.Rule>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.list_by_subscriptions
  name: list_by_subscriptions
  summary: List all the rules within given topic-subscription.
  signature: 'list_by_subscriptions(resource_group_name: str, namespace_name: str,
    topic_name: str, subscription_name: str, skip: int | None = None, top: int | None
    = None, **kwargs: Any) -> Iterable[Rule]'
  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: subscription_name
    description: The subscription 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 Rule or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.servicebus.v2021_06_01_preview.models.Rule>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.servicebus.v2021_06_01_preview.operations.RulesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.servicebus.v2021_06_01_preview.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2021_06_01_preview\\models\\__init__.py'>