swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector KafkaConnectorTopicMap API
schemes:
- https
tags:
- name: KafkaConnectorTopicMap
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/kafkaConnector/{kafkaConnectorName}/topicMap
  : get:
      operationId: microsoftAzureKafkaconnectortopicmapListbykafkaconnectorresource
      tags:
      - KafkaConnectorTopicMap
      description: List KafkaTopicMapResource resources by KafkaConnectorResource
      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: kafkaConnectorName
        in: path
        description: Name of MQ kafkaConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/KafkaTopicMapResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        KafkaConnectorTopicMap_ListByKafkaConnectorResource:
          $ref: ./examples/KafkaConnectorTopicMap_ListByKafkaConnectorResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Kafkaconnector Kafkaconnectorname Topicmap
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/kafkaConnector/{kafkaConnectorName}/topicMap/{topicMapName}
  : get:
      operationId: microsoftAzureKafkaconnectortopicmapGet
      tags:
      - KafkaConnectorTopicMap
      description: Get a KafkaTopicMapResource
      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: kafkaConnectorName
        in: path
        description: Name of MQ kafkaConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ kafka/topicMap resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/KafkaTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        KafkaConnectorTopicMap_Get:
          $ref: ./examples/KafkaConnectorTopicMap_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Kafkaconnector Kafkaconnectorname Topicmap Topicmapname
    put:
      operationId: microsoftAzureKafkaconnectortopicmapCreateorupdate
      tags:
      - KafkaConnectorTopicMap
      description: Create a KafkaTopicMapResource
      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: kafkaConnectorName
        in: path
        description: Name of MQ kafkaConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ kafka/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/KafkaTopicMapResource'
      responses:
        '200':
          description: Resource 'KafkaTopicMapResource' update operation succeeded
          schema:
            $ref: '#/definitions/KafkaTopicMapResource'
        '201':
          description: Resource 'KafkaTopicMapResource' create operation succeeded
          schema:
            $ref: '#/definitions/KafkaTopicMapResource'
          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:
        KafkaConnectorTopicMap_CreateOrUpdate:
          $ref: ./examples/KafkaConnectorTopicMap_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 Kafkaconnector Kafkaconnectorname Topicmap Topicmapname
    patch:
      operationId: microsoftAzureKafkaconnectortopicmapUpdate
      tags:
      - KafkaConnectorTopicMap
      description: Update a KafkaTopicMapResource
      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: kafkaConnectorName
        in: path
        description: Name of MQ kafkaConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ kafka/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/KafkaTopicMapResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/KafkaTopicMapResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        KafkaConnectorTopicMap_Update:
          $ref: ./examples/KafkaConnectorTopicMap_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Kafkaconnector Kafkaconnectorname Topicmap Topicmapname
    delete:
      operationId: microsoftAzureKafkaconnectortopicmapDelete
      tags:
      - KafkaConnectorTopicMap
      description: Delete a KafkaTopicMapResource
      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: kafkaConnectorName
        in: path
        description: Name of MQ kafkaConnector resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: topicMapName
        in: path
        description: Name of MQ kafka/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:
        KafkaConnectorTopicMap_Delete:
          $ref: ./examples/KafkaConnectorTopicMap_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 Kafkaconnector Kafkaconnectorname Topicmap Topicmapname
definitions:
  KafkaToMqttRoutes:
    type: object
    description: Kafka to Mqtt route properties
    properties:
      consumerGroupId:
        type: string
        description: The consumer group id to use.
      kafkaTopic:
        type: string
        description: The kafka topic to pull from.
      mqttTopic:
        type: string
        description: The mqtt topic to publish to.
      name:
        type: string
        description: The name of the route.
      qos:
        type: integer
        format: int32
        description: The qos to use for mqtt.
        default: 1
        minimum: 0
        maximum: 1
    required:
    - kafkaTopic
    - mqttTopic
    - name
  KafkaAcks:
    type: string
    description: Kafka Acks enum properties
    enum:
    - zero
    - one
    - all
    x-ms-enum:
      name: KafkaAcks
      modelAsString: true
      values:
      - name: zero
        value: zero
        description: Kafka acks zero.
      - name: one
        value: one
        description: Kafka acks one.
      - name: all
        value: all
        description: Kafka acks all.
  KafkaTopicMapResourceListResult:
    type: object
    description: The response of a KafkaTopicMapResource list operation.
    properties:
      value:
        type: array
        description: The KafkaTopicMapResource items on this page
        items:
          $ref: '#/definitions/KafkaTopicMapResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  KafkaTopicMapResource:
    type: object
    description: MQ kafkaConnector/topicMap resource
    properties:
      properties:
        $ref: '#/definitions/KafkaTopicMapProperties'
        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
  KafkaTopicMapProperties:
    type: object
    description: KafkaTopicMap Properties
    properties:
      batching:
        $ref: '#/definitions/KafkaTopicMapBatching'
        description: The batching settings for kafka messages.
      compression:
        type: string
        description: The compression to use for kafka messages.
        default: none
        enum:
        - none
        - gzip
        - snappy
        - lz4
        x-ms-enum:
          name: KafkaMessageCompressionType
          modelAsString: true
          values:
          - name: none
            value: none
            description: No Kafka message compression.
          - name: gzip
            value: gzip
            description: Gzip Kafka message compression.
          - name: snappy
            value: snappy
            description: Snappy Kafka message compression.
          - name: lz4
            value: lz4
            description: Lz4 Kafka message compression.
      copyMqttProperties:
        type: string
        description: The flag to copy Mqtt properties.
      kafkaConnectorRef:
        type: string
        description: The kafkaConnector CRD it refers to.
      partitionKeyProperty:
        type: string
        description: The partition to use for Kafka.
      partitionStrategy:
        type: string
        description: The partition strategy to use for Kafka.
        default: default
        enum:
        - default
        - static
        - topic
        - property
        x-ms-enum:
          name: KafkaPartitionStrategy
          modelAsString: true
          values:
          - name: default
            value: default
            description: Default partition strategy.
          - name: static
            value: static
            description: Static partition strategy.
          - name: topic
            value: topic
            description: Topic partition strategy.
          - name: property
            value: property
            description: Property partition strategy.
      routes:
        type: array
        description: The route details for Kafka connector.
        items:
          $ref: '#/definitions/KafkaRoutes'
        x-ms-identifiers: []
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - kafkaConnectorRef
    - routes
  KafkaRoutes:
    type: object
    description: Kafka Routes properties. NOTE - Enum only one method is allowed to be passed.
    properties:
      kafkaToMqtt:
        $ref: '#/definitions/KafkaToMqttRoutes'
        description: Kafka to Mqtt route.
      mqttToKafka:
        $ref: '#/definitions/MqttToKafkaRoutes'
        description: Mqtt to Kafka route.
  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.
  MqttToKafkaRoutes:
    type: object
    description: Mqtt to Kafka route properties
    properties:
      kafkaAcks:
        $ref: '#/definitions/KafkaAcks'
        description: The kafka acks to use.
      kafkaTopic:
        type: string
        description: The kafka topic to publish to.
      mqttTopic:
        type: string
        description: The mqtt topic to pull from.
      name:
        type: string
        description: The name of the route.
      qos:
        type: integer
        format: int32
        description: The qos to use for mqtt.
        default: 1
        minimum: 0
        maximum: 1
      sharedSubscription:
        $ref: '#/definitions/KafkaSharedSubscriptionProperties'
        description: The properties for shared subscription.
    required:
    - kafkaAcks
    - kafkaTopic
    - mqttTopic
    - name
  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
  KafkaSharedSubscriptionProperties:
    type: object
    description: Kafka Shared Subscription properties
    properties:
      groupMinimumShareNumber:
        type: integer
        format: int32
        description: The minimum number to use in a group for subscription.
        minimum: 0
        maximum: 255
      groupName:
        type: string
        description: The name of the shared subscription.
    required:
    - groupMinimumShareNumber
    - groupName
  KafkaTopicMapBatching:
    type: object
    description: Kafka TopicMap Batching properties
    properties:
      enabled:
        type: boolean
        description: The setting to enable or disable batching.
        default: false
      latencyMs:
        type: integer
        format: int32
        description: The latency of message batching.
        default: 5
        minimum: 0
        maximum: 65535
      maxBytes:
        type: integer
        format: int64
        description: The maximum bytes to send in a batch.
        default: 1000000
        minimum: 0
        maximum: 4294967295
      maxMessages:
        type: integer
        format: int64
        description: The maximum messages to send in a batch.
        default: 100000
        minimum: 0
        maximum: 4294967295
  KafkaTopicMapResourceUpdate:
    type: object
    description: The type used for update operations of the KafkaTopicMapResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/KafkaTopicMapResourceUpdateProperties'
        x-ms-client-flatten: true
  KafkaTopicMapResourceUpdateProperties:
    type: object
    description: The updatable properties of the KafkaTopicMapResource.
    properties:
      batching:
        $ref: '#/definitions/KafkaTopicMapBatching'
        description: The batching settings for kafka messages.
      compression:
        type: string
        description: The compression to use for kafka messages.
        default: none
        enum:
        - none
        - gzip
        - snappy
        - lz4
        x-ms-enum:
          name: KafkaMessageCompressionType
          modelAsString: true
          values:
          - name: none
            value: none
            description: No Kafka message compression.
          - name: gzip
            value: gzip
            description: Gzip Kafka message compression.
          - name: snappy
            value: snappy
            description: Snappy Kafka message compression.
          - name: lz4
            value: lz4
            description: Lz4 Kafka message compression.
      copyMqttProperties:
        type: string
        description: The flag to copy Mqtt properties.
      kafkaConnectorRef:
        type: string
        description: The kafkaConnector CRD it refers to.
      partitionKeyProperty:
        type: string
        description: The partition to use for Kafka.
      partitionStrategy:
        type: string
        description: The partition strategy to use for Kafka.
        default: default
        enum:
        - default
        - static
        - topic
        - property
        x-ms-enum:
          name: KafkaPartitionStrategy
          modelAsString: true
          values:
          - name: default
            value: default
            description: Default partition strategy.
          - name: static
            value: static
            description: Static partition strategy.
          - name: topic
            value: topic
            description: Topic partition strategy.
          - name: property
            value: property
            description: Property partition strategy.
      routes:
        type: array
        description: The route details for Kafka connector.
        items:
          $ref: '#/definitions/KafkaRoutes'
        x-ms-identifiers: []
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'