Azure Service Bus Rules API

openapi: 3.2.0
info:
  title: ServiceBusManagementClient Rules API
  version: '2026-01-01'
  description: Azure Service Bus client
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Rules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules
  : get:
      operationId: Rules_ListBySubscriptions
      tags:
      - Rules
      description: List all the rules within given topic-subscription
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: $skip
        in: query
        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.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 1000
      - name: $top
        in: query
        description: May be used to limit the number of results to the most recent N usageDetails.
        required: false
        schema:
          type: integer
          format: int32
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Rules list by subscriptions
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}
  : get:
      operationId: Rules_Get
      tags:
      - Rules
      description: Retrieves the description for the specified rule.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: ruleName
        in: path
        description: The rule name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Rules get
      x-summary-source: derived
    put:
      operationId: Rules_CreateOrUpdate
      tags:
      - Rules
      description: Creates a new rule and updates an existing rule
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: ruleName
        in: path
        description: The rule name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Resource 'Rule' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rule'
        description: Parameters supplied to create a rule.
        required: true
      summary: Rules create or update
      x-summary-source: derived
    delete:
      operationId: Rules_Delete
      tags:
      - Rules
      description: Deletes an existing rule.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: namespaceName
        in: path
        description: The namespace name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 6
      - name: topicName
        in: path
        description: The topic name.
        required: true
        schema:
          type: string
          minLength: 1
      - name: subscriptionName
        in: path
        description: The subscription name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      - name: ruleName
        in: path
        description: The rule name.
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Rules delete
      x-summary-source: derived
components:
  schemas:
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          format: arm-id
          description: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    ErrorResponse:
      type: object
      description: The resource management error response.
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
          description: The error object.
    ErrorAdditionalInfo:
      type: object
      description: The resource management error additional info.
      properties:
        type:
          type: string
          description: The additional info type.
          readOnly: true
        info:
          description: The additional info.
          readOnly: true
    RuleListResult:
      type: object
      description: The response of a Rule list operation.
      properties:
        value:
          type: array
          description: The Rule items on this page
          items:
            $ref: '#/components/schemas/Rule'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SqlFilter:
      type: object
      description: Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
      properties:
        sqlExpression:
          type: string
          description: The SQL expression. e.g. MyProperty='ABC'
        compatibilityLevel:
          type: integer
          format: int32
          description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
        requiresPreprocessing:
          type: boolean
          description: Value that indicates whether the rule action requires preprocessing.
          default: true
    FilterType:
      type: string
      description: Rule filter types
      enum:
      - SqlFilter
      - CorrelationFilter
      x-ms-enum:
        name: FilterType
        modelAsString: false
    Rule:
      type: object
      description: Description of Rule Resource.
      properties:
        properties:
          $ref: '#/components/schemas/Ruleproperties'
          description: Properties of Rule resource
          x-ms-client-flatten: true
        location:
          type: string
          description: The geo-location where the resource lives
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    Ruleproperties:
      type: object
      description: Description of Rule Resource.
      properties:
        action:
          $ref: '#/components/schemas/Action'
          description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
        filterType:
          $ref: '#/components/schemas/FilterType'
          description: Filter type that is evaluated against a BrokeredMessage.
        sqlFilter:
          $ref: '#/components/schemas/SqlFilter'
          description: Properties of sqlFilter
        correlationFilter:
          $ref: '#/components/schemas/CorrelationFilter'
          description: Properties of correlationFilter
    ErrorResponseError:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorResponse'
          readOnly: true
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    Action:
      type: object
      description: Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
      properties:
        sqlExpression:
          type: string
          description: SQL expression. e.g. MyProperty='ABC'
        compatibilityLevel:
          type: integer
          format: int32
          description: This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20.
        requiresPreprocessing:
          type: boolean
          description: Value that indicates whether the rule action requires preprocessing.
          default: true
    CorrelationFilter:
      type: object
      description: Represents the correlation filter expression.
      properties:
        properties:
          type: object
          description: dictionary object for custom filters
          additionalProperties:
            type: string
        correlationId:
          type: string
          description: Identifier of the correlation.
        messageId:
          type: string
          description: Identifier of the message.
        to:
          type: string
          description: Address to send to.
        replyTo:
          type: string
          description: Address of the queue to reply to.
        label:
          type: string
          description: Application specific label.
        sessionId:
          type: string
          description: Session identifier.
        replyToSessionId:
          type: string
          description: Session identifier to reply to.
        contentType:
          type: string
          description: Content type of the message.
        requiresPreprocessing:
          type: boolean
          description: Value that indicates whether the rule action requires preprocessing.
          default: true
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.