swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector V1consumer API
  description: Consume records
schemes:
- https
tags:
- name: V1consumer
  description: Consume records
paths:
  /v1/consumer/topics/{topic}/partitions/{partition}/offsets/{offset}:
    get:
      tags:
      - V1consumer
      summary: Microsoft Azure Consume Records Using A Simple Consumer
      description: Consume records from one partition of a topic beginning with a specific offset. By default count is 1. It can read maximum of 6 megabytes of data at once
      operationId: microsoftAzureConsumerConsumetopicinpartitionwithoffset
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: topic
        in: path
        description: Topic to consume the records from
        required: true
        type: string
      - name: partition
        in: path
        description: Partition ID to consume the records from
        required: true
        type: integer
        format: int32
      - name: offset
        in: path
        description: Offset to start from
        required: true
        type: integer
        format: int64
      - name: count
        in: query
        description: Number of records to consume (optional). By default count is 1. It returns either count of records or 6 megabytes of data, which is smaller.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: successful operation
          schema:
            type: array
            items:
              $ref: '#/definitions/ConsumeRecord'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '500':
          description: Internal Server Error
definitions:
  ConsumeRecord:
    type: object
    properties:
      key:
        type: string
        description: Key for consumer record
        readOnly: true
      value:
        type: string
        description: Value for consumer record
        readOnly: true
      partition:
        type: integer
        format: int32
        description: Partition ID for consumer record
        readOnly: true
      offset:
        type: integer
        format: int64
        description: Offset for consumer record
        readOnly: true
      timestamp:
        type: integer
        format: int64
        description: Timestamp for consumer record
        readOnly: true
      timestampType:
        type: string
        description: Timestamp type for consumer record such as log append time or create time
        readOnly: true
    description: List of consumer records
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'