Azure Cosmos DB Fleets API

openapi: 3.2.0
info:
  title: Cosmos DB Fleets API
  version: '2026-07-15'
  description: Azure Cosmos DB Throughput Pool REST API
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Fleets
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets:
    get:
      operationId: Fleet_ListByResourceGroup
      tags:
      - Fleets
      description: Lists all the fleets under the specified subscription and resource group.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypesErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fleet list by resource group
      x-summary-source: derived
components:
  schemas:
    FleetResourceProperties:
      type: object
      description: Properties to update Azure Cosmos DB fleet resource.
      properties:
        provisioningState:
          $ref: '#/components/schemas/Status'
          description: A provisioning state of the Fleet.
          readOnly: true
    FleetListResult:
      type: object
      description: The response of a FleetResource list operation.
      properties:
        value:
          type: array
          description: The FleetResource items on this page
          items:
            $ref: '#/components/schemas/FleetResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    TypesErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    Status:
      type: string
      description: Enum to indicate current buildout status of the region.
      enum:
      - Uninitialized
      - Initializing
      - InternallyReady
      - Online
      - Deleting
      - Succeeded
      - Failed
      - Canceled
      - Updating
      - Creating
      x-ms-enum:
        name: Status
        modelAsString: true
        values:
        - name: Uninitialized
          value: Uninitialized
        - name: Initializing
          value: Initializing
        - name: InternallyReady
          value: InternallyReady
        - name: Online
          value: Online
        - name: Deleting
          value: Deleting
        - name: Succeeded
          value: Succeeded
        - name: Failed
          value: Failed
        - name: Canceled
          value: Canceled
        - name: Updating
          value: Updating
        - name: Creating
          value: Creating
    FleetResource:
      type: object
      description: An Azure Cosmos DB FleetResource.
      properties:
        properties:
          $ref: '#/components/schemas/FleetResourceProperties'
          description: Properties to update Azure Cosmos DB fleet resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.