swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ThroughputPools API
schemes:
- https
tags:
- name: ThroughputPools
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools:
    get:
      tags:
      - ThroughputPools
      operationId: microsoftAzureThroughputpoolsListbyresourcegroup
      x-ms-examples:
        CosmosDB ThroughputPool List by Resource Group:
          $ref: ./examples/throughputPool/CosmosDBThroughputPoolList.json
      description: List all the ThroughputPools in a given resource group.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: The operation completed successfully.
          schema:
            $ref: '#/definitions/ThroughputPoolsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Documentdb Throughputpools
definitions:
  ProvisioningState:
    description: The provisioning state of the resource.
    type: string
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Updating
    x-ms-enum:
      name: status
      modelAsString: true
    readOnly: true
  ThroughputPoolsListResult:
    description: The List operation response, that contains the throughput pools and their properties.
    type: object
    properties:
      value:
        description: List of throughput pools and their properties.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/ThroughputPoolResource'
      nextLink:
        description: The link used to get the next page of results.
        type: string
        readOnly: true
  ThroughputPoolProperties:
    description: Properties to update Azure Cosmos DB throughput pool.
    type: object
    x-ms-mutability:
    - read
    - create
    - update
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: A provisioning state of the ThroughputPool.
      maxThroughput:
        type: integer
        format: int32
        description: Value for throughput to be shared among CosmosDB resources in the pool.
  ThroughputPoolResource:
    description: An Azure Cosmos DB Throughputpool.
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ThroughputPoolProperties'
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'