swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DataLakeConnectorTopicMap API
schemes:
- https
tags:
- name: DataLakeConnectorTopicMap
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/dataLakeConnector/{dataLakeConnectorName}/topicMap
  : get:
      operationId: microsoftAzureDatalakeconnectortopicmapListbydatalakeconnectorresource
      tags:
      - DataLakeConnectorTopicMap
      description: List DataLakeTopicMapResource resources by DataLakeConnectorResource
      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: dataLakeConnectorName
        in: path
        description: Name of MQ dataLakeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DataLakeTopicMapResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DataLakeConnectorTopicMap_ListByDataLakeConnectorResource:
          $ref: ./examples/DataLakeConnectorTopicMap_ListByDataLakeConnectorResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname Topicmap
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/dataLakeConnector/{dataLakeConnectorName}/topicMap/{topicMapName}
  : get:
      operationId: microsoftAzureDatalakeconnectortopicmapGet
      tags:
      - DataLakeConnectorTopicMap
      description: Get a DataLakeTopicMapResource
      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: dataLakeConnectorName
        in: path
        description: Name of MQ dataLakeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ dataLakeConnector/topicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DataLakeTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DataLakeConnectorTopicMap_Get:
          $ref: ./examples/DataLakeConnectorTopicMap_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname Topicmap Topicmapname
    put:
      operationId: microsoftAzureDatalakeconnectortopicmapCreateorupdate
      tags:
      - DataLakeConnectorTopicMap
      description: Create a DataLakeTopicMapResource
      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: dataLakeConnectorName
        in: path
        description: Name of MQ dataLakeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ dataLakeConnector/topicMap 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/DataLakeTopicMapResource'
      responses:
        '200':
          description: Resource 'DataLakeTopicMapResource' update operation succeeded
          schema:
            $ref: '#/definitions/DataLakeTopicMapResource'
        '201':
          description: Resource 'DataLakeTopicMapResource' create operation succeeded
          schema:
            $ref: '#/definitions/DataLakeTopicMapResource'
          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:
        DataLakeConnectorTopicMap_CreateOrUpdate:
          $ref: ./examples/DataLakeConnectorTopicMap_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 Datalakeconnector Datalakeconnectorname Topicmap Topicmapname
    patch:
      operationId: microsoftAzureDatalakeconnectortopicmapUpdate
      tags:
      - DataLakeConnectorTopicMap
      description: Update a DataLakeTopicMapResource
      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: dataLakeConnectorName
        in: path
        description: Name of MQ dataLakeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ dataLakeConnector/topicMap 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/DataLakeTopicMapResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DataLakeTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DataLakeConnectorTopicMap_Update:
          $ref: ./examples/DataLakeConnectorTopicMap_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Datalakeconnector Datalakeconnectorname Topicmap Topicmapname
    delete:
      operationId: microsoftAzureDatalakeconnectortopicmapDelete
      tags:
      - DataLakeConnectorTopicMap
      description: Delete a DataLakeTopicMapResource
      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: dataLakeConnectorName
        in: path
        description: Name of MQ dataLakeConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ dataLakeConnector/topicMap 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:
        DataLakeConnectorTopicMap_Delete:
          $ref: ./examples/DataLakeConnectorTopicMap_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 Datalakeconnector Datalakeconnectorname Topicmap Topicmapname
definitions:
  DataLakeTopicMapResourceListResult:
    type: object
    description: The response of a DataLakeTopicMapResource list operation.
    properties:
      value:
        type: array
        description: The DataLakeTopicMapResource items on this page
        items:
          $ref: '#/definitions/DataLakeTopicMapResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  DataLakeConnectorMapUpdate:
    type: object
    description: DataLake connector map route properties
    properties:
      allowedLatencySecs:
        type: integer
        format: int32
        description: Allowed latency for transferring data.
        minimum: 0
        maximum: 65535
      clientId:
        type: string
        description: Client Id to use.
      maxMessagesPerBatch:
        type: integer
        format: int64
        description: Maximum messages to send per Batch.
        minimum: 0
        maximum: 4294967295
      messagePayloadType:
        type: string
        description: Message payload type.
      mqttSourceTopic:
        type: string
        description: Mqtt source topic.
      qos:
        type: integer
        format: int32
        description: Quality of Service.
        default: 1
        minimum: 0
        maximum: 2
      table:
        $ref: '#/definitions/DeltaTableUpdate'
        description: Delta table properties to use.
  DataLakeTopicMapResource:
    type: object
    description: MQ dataLakeConnector/topicMap resource
    properties:
      properties:
        $ref: '#/definitions/DataLakeConnectorTopicMapProperties'
        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
  DataLakeConnectorTopicMapProperties:
    type: object
    description: MQ DataLakeConnector TopicMap Resource properties
    properties:
      dataLakeConnectorRef:
        type: string
        description: DataLake Connector CRD to use.
      mapping:
        $ref: '#/definitions/DataLakeConnectorMap'
        description: TopicMap for DataLake connector.
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - dataLakeConnectorRef
    - mapping
  DeltaTableUpdate:
    type: object
    description: Delta table properties
    properties:
      schema:
        type: array
        description: Schema list supported.
        items:
          $ref: '#/definitions/DeltaTableSchema'
        x-ms-identifiers: []
      tableName:
        type: string
        description: Delta table name.
      tablePath:
        type: string
        description: Delta table path.
  DataLakeTopicMapResourceUpdateProperties:
    type: object
    description: The updatable properties of the DataLakeTopicMapResource.
    properties:
      dataLakeConnectorRef:
        type: string
        description: DataLake Connector CRD to use.
      mapping:
        $ref: '#/definitions/DataLakeConnectorMapUpdate'
        description: TopicMap for DataLake connector.
  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.
  DataLakeConnectorMap:
    type: object
    description: DataLake connector map route properties
    properties:
      allowedLatencySecs:
        type: integer
        format: int32
        description: Allowed latency for transferring data.
        minimum: 0
        maximum: 65535
      clientId:
        type: string
        description: Client Id to use.
      maxMessagesPerBatch:
        type: integer
        format: int64
        description: Maximum messages to send per Batch.
        minimum: 0
        maximum: 4294967295
      messagePayloadType:
        type: string
        description: Message payload type.
      mqttSourceTopic:
        type: string
        description: Mqtt source topic.
      qos:
        type: integer
        format: int32
        description: Quality of Service.
        default: 1
        minimum: 0
        maximum: 2
      table:
        $ref: '#/definitions/DeltaTable'
        description: Delta table properties to use.
    required:
    - allowedLatencySecs
    - clientId
    - maxMessagesPerBatch
    - messagePayloadType
    - mqttSourceTopic
    - table
  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
  DataLakeTopicMapResourceUpdate:
    type: object
    description: The type used for update operations of the DataLakeTopicMapResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/DataLakeTopicMapResourceUpdateProperties'
        x-ms-client-flatten: true
  DeltaTable:
    type: object
    description: Delta table properties
    properties:
      schema:
        type: array
        description: Schema list supported.
        items:
          $ref: '#/definitions/DeltaTableSchema'
        x-ms-identifiers: []
      tableName:
        type: string
        description: Delta table name.
      tablePath:
        type: string
        description: Delta table path.
    required:
    - schema
    - tableName
  DeltaTableSchema:
    type: object
    description: Delta table schema properties
    properties:
      format:
        $ref: '#/definitions/DeltaTableFormatEnum'
        description: Delta table format supported.
      mapping:
        type: string
        description: Delta table schema mapping.
      name:
        type: string
        description: Delta table schema name.
      optional:
        type: boolean
        description: Delta table schema optional.
    required:
    - format
    - mapping
    - name
    - optional
  DeltaTableFormatEnum:
    type: string
    description: Delta table format properties
    enum:
    - boolean
    - int8
    - int16
    - int32
    - uInt8
    - uInt16
    - uInt32
    - uInt64
    - float16
    - float32
    - float64
    - date32
    - date64
    - binary
    - utf8
    x-ms-enum:
      name: DeltaTableFormatEnum
      modelAsString: true
      values:
      - name: boolean
        value: boolean
        description: Bool format
      - name: int8
        value: int8
        description: Signed integer 8
      - name: int16
        value: int16
        description: Signed integer 16
      - name: int32
        value: int32
        description: Signed integer 32
      - name: uInt8
        value: uInt8
        description: Unsigned integer 8
      - name: uInt16
        value: uInt16
        description: Unsigned integer 16
      - name: uInt32
        value: uInt32
        description: Unsigned integer 32
      - name: uInt64
        value: uInt64
        description: Unsigned integer 64
      - name: float16
        value: float16
        description: Float 16
      - name: float32
        value: float32
        description: Float 32
      - name: float64
        value: float64
        description: Float 64
      - name: date32
        value: date32
        description: Date 32
      - name: date64
        value: date64
        description: Date 64
      - name: binary
        value: binary
        description: Binary data
      - name: utf8
        value: utf8
        description: UTF8 format
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'