swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MqttBridgeTopicMap API
schemes:
- https
tags:
- name: MqttBridgeTopicMap
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/mqttBridgeConnector/{mqttBridgeConnectorName}/topicMap
  : get:
      operationId: microsoftAzureMqttbridgetopicmapListbymqttbridgeconnectorresource
      tags:
      - MqttBridgeTopicMap
      description: List MqttBridgeTopicMapResource resources by MqttBridgeConnectorResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: mqttBridgeConnectorName
        in: path
        description: Name of MQ mqttBridgeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/MqttBridgeTopicMapResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MqttBridgeTopicMap_ListByMqttBridgeConnectorResource:
          $ref: ./examples/MqttBridgeTopicMap_ListByMqttBridgeConnectorResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Mqttbridgeconnector Mqttbridgeconnectorname Topicmap
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/mqttBridgeConnector/{mqttBridgeConnectorName}/topicMap/{topicMapName}
  : get:
      operationId: microsoftAzureMqttbridgetopicmapGet
      tags:
      - MqttBridgeTopicMap
      description: Get a MqttBridgeTopicMapResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: mqttBridgeConnectorName
        in: path
        description: Name of MQ mqttBridgeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ mqttBridgeTopicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/MqttBridgeTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MqttBridgeTopicMap_Get:
          $ref: ./examples/MqttBridgeTopicMap_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Mqttbridgeconnector Mqttbridgeconnectorname Topicmap Topicmapname
    put:
      operationId: microsoftAzureMqttbridgetopicmapCreateorupdate
      tags:
      - MqttBridgeTopicMap
      description: Create a MqttBridgeTopicMapResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: mqttBridgeConnectorName
        in: path
        description: Name of MQ mqttBridgeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ mqttBridgeTopicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/MqttBridgeTopicMapResource'
      responses:
        '200':
          description: Resource 'MqttBridgeTopicMapResource' update operation succeeded
          schema:
            $ref: '#/definitions/MqttBridgeTopicMapResource'
        '201':
          description: Resource 'MqttBridgeTopicMapResource' create operation succeeded
          schema:
            $ref: '#/definitions/MqttBridgeTopicMapResource'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MqttBridgeTopicMap_CreateOrUpdate:
          $ref: ./examples/MqttBridgeTopicMap_CreateOrUpdate_MaximumSet_Gen.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Mqttbridgeconnector Mqttbridgeconnectorname Topicmap Topicmapname
    patch:
      operationId: microsoftAzureMqttbridgetopicmapUpdate
      tags:
      - MqttBridgeTopicMap
      description: Update a MqttBridgeTopicMapResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: mqttBridgeConnectorName
        in: path
        description: Name of MQ mqttBridgeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ mqttBridgeTopicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/MqttBridgeTopicMapResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/MqttBridgeTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MqttBridgeTopicMap_Update:
          $ref: ./examples/MqttBridgeTopicMap_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Mqttbridgeconnector Mqttbridgeconnectorname Topicmap Topicmapname
    delete:
      operationId: microsoftAzureMqttbridgetopicmapDelete
      tags:
      - MqttBridgeTopicMap
      description: Delete a MqttBridgeTopicMapResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: mqttBridgeConnectorName
        in: path
        description: Name of MQ mqttBridgeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ mqttBridgeTopicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MqttBridgeTopicMap_Delete:
          $ref: ./examples/MqttBridgeTopicMap_Delete_MaximumSet_Gen.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Mqttbridgeconnector Mqttbridgeconnectorname Topicmap Topicmapname
definitions:
  MqttBridgeRouteSharedSubscription:
    type: object
    description: MqttBridgeRoute Shared subscription properties
    properties:
      groupMinimumShareNumber:
        type: integer
        format: int32
        description: The group shared subscription minimum share number.
        minimum: 0
        maximum: 255
      groupName:
        type: string
        description: The group name for Shared subscription.
    required:
    - groupMinimumShareNumber
    - groupName
  MqttBridgeTopicMapProperties:
    type: object
    description: MqttBridgeTopicMap Properties
    properties:
      mqttBridgeConnectorRef:
        type: string
        description: The MqttBridgeConnector CRD it refers to.
      routes:
        type: array
        description: The route details for MqttBridge connector.
        items:
          $ref: '#/definitions/MqttBridgeRoutes'
        x-ms-identifiers: []
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - mqttBridgeConnectorRef
  MqttBridgeRouteDirection:
    type: string
    description: MqttBridgeRoute direction properties
    enum:
    - remote-to-local
    - local-to-remote
    x-ms-enum:
      name: MqttBridgeRouteDirection
      modelAsString: true
      values:
      - name: RemoteToLocal
        value: remote-to-local
        description: Remote to Local Broker.
      - name: LocalToRemote
        value: local-to-remote
        description: Local to Remote Broker.
  MqttBridgeTopicMapResourceListResult:
    type: object
    description: The response of a MqttBridgeTopicMapResource list operation.
    properties:
      value:
        type: array
        description: The MqttBridgeTopicMapResource items on this page
        items:
          $ref: '#/definitions/MqttBridgeTopicMapResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ExtendedLocationProperty:
    type: object
    description: ExtendedLocation properties
    properties:
      name:
        type: string
        description: The name of the extended location.
      type:
        $ref: '#/definitions/ExtendedLocationType'
        description: Type of ExtendedLocation.
    required:
    - name
    - type
  ProvisioningState:
    type: string
    description: The enum defining status of resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Provisioning
        value: Provisioning
        description: Resource is getting provisioned.
      - name: Updating
        value: Updating
        description: Resource is Updating.
      - name: Deleting
        value: Deleting
        description: Resource is Deleting.
      - name: Accepted
        value: Accepted
        description: Resource has been Accepted.
  ExtendedLocationType:
    type: string
    description: The enum defining type of ExtendedLocation accepted.
    enum:
    - CustomLocation
    x-ms-enum:
      name: ExtendedLocationType
      modelAsString: true
      values:
      - name: CustomLocation
        value: CustomLocation
        description: CustomLocation type
  MqttBridgeTopicMapResource:
    type: object
    description: MQ mqttBridgeTopicMap resource
    properties:
      properties:
        $ref: '#/definitions/MqttBridgeTopicMapProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      extendedLocation:
        $ref: '#/definitions/ExtendedLocationProperty'
        description: Extended Location
        x-ms-mutability:
        - read
        - create
    required:
    - extendedLocation
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  MqttBridgeTopicMapResourceUpdateProperties:
    type: object
    description: The updatable properties of the MqttBridgeTopicMapResource.
    properties:
      mqttBridgeConnectorRef:
        type: string
        description: The MqttBridgeConnector CRD it refers to.
      routes:
        type: array
        description: The route details for MqttBridge connector.
        items:
          $ref: '#/definitions/MqttBridgeRoutes'
        x-ms-identifiers: []
  MqttBridgeRoutes:
    type: object
    description: MqttBridgeTopicMap route properties
    properties:
      direction:
        $ref: '#/definitions/MqttBridgeRouteDirection'
        description: Direction of the route.
      name:
        type: string
        description: Name of the route.
      qos:
        type: integer
        format: int32
        description: Qos for MQTT connection.
        default: 1
        minimum: 0
        maximum: 2
      sharedSubscription:
        $ref: '#/definitions/MqttBridgeRouteSharedSubscription'
        description: Shared subscription topic details.
      source:
        type: string
        description: Source topic of the route.
      target:
        type: string
        description: Target topic of the route. Ignore if same as source
    required:
    - direction
    - name
    - source
  MqttBridgeTopicMapResourceUpdate:
    type: object
    description: The type used for update operations of the MqttBridgeTopicMapResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/MqttBridgeTopicMapResourceUpdateProperties'
        x-ms-client-flatten: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'