Azure Kubernetes Service

Azure Kubernetes Service Fleets API

The Fleets API from Azure Kubernetes Service — 4 operation(s) for fleets.

GitHub OpenAPI

Operations 7

GET /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets Fleets list by subscription #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets Fleets list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName} Fleets get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName} Fleets create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName} Fleets update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName} Fleets delete #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/listCredentials Fleets list credentials #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/aks/
📖
Authentication
https://learn.microsoft.com/en-us/azure/aks/concepts-identity
📖
RateLimits
https://learn.microsoft.com/en-us/azure/aks/quotas-skus-regions
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-portal
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/aks/managed-clusters
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-cli
📖
Documentation
https://learn.microsoft.com/en-us/azure/aks/create-node-pools
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/aks/agent-pools
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/aks/create-node-pools

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-kubernetes-service/openapi/microsoft-azure-kubernetes-service-fleets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-kubernetes-service/json-schema/microsoft-azure-kubernetes-service-fleet-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-kubernetes-service/json-schema/microsoft-azure-kubernetes-service-fleet-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-kubernetes-service/json-schema/microsoft-azure-kubernetes-service-fleet-list-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-kubernetes-service/json-schema/microsoft-azure-kubernetes-service-fleet-credential-results-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/microsoft-azure-kubernetes-service/json-ld/azure-kubernetes-service-context.jsonld
🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/kubernetes-service/
🔗
ChangeLog
https://github.com/Azure/AKS/blob/master/CHANGELOG.md
🔗
ReleaseNotes
https://learn.microsoft.com/en-us/azure/aks/release-tracker
🔗
SDKs
https://learn.microsoft.com/en-us/python/api/overview/azure/mgmt-containerservice-readme
🔗
SDKs
https://learn.microsoft.com/en-us/javascript/api/overview/azure/container-service
🔗
SDKs
https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.containerservice-readme
🔗
SDKs
https://learn.microsoft.com/en-us/java/api/overview/azure/resourcemanager-containerservice-readme
🔗
SDKs
https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-kubernetes-service:microsoft-azure-kubernetes-service-fleets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-kubernetes-service-fleets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ContainerServiceFleetClient Fleets API
  version: '2026-11-01'
  description: Azure Kubernetes Fleet Manager api client.
  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}/providers/Microsoft.ContainerService/fleets:
    get:
      operationId: Fleets_ListBySubscription
      tags:
      - Fleets
      description: Lists fleets in the specified subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipTokenQueryParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fleets list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets:
    get:
      operationId: Fleets_ListByResourceGroup
      tags:
      - Fleets
      description: Lists fleets in the specified subscription and resource group.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Fleets list by resource group
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}:
    get:
      operationId: Fleets_Get
      tags:
      - Fleets
      description: Gets a Fleet.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Fleets get
      x-summary-source: derived
    put:
      operationId: Fleets_CreateOrUpdate
      tags:
      - Fleets
      description: Creates or updates a Fleet.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: The request should only proceed if no entity matches this string.
        required: false
        x-ms-client-name: ifNoneMatch
        schema:
          type: string
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Resource 'Fleet' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
        '201':
          description: Resource 'Fleet' create operation succeeded
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Fleet'
        description: Resource create parameters.
        required: true
      summary: Fleets create or update
      x-summary-source: derived
    patch:
      operationId: Fleets_Update
      tags:
      - Fleets
      description: Update a Fleet
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fleet'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: original-uri
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FleetPatch'
        description: The resource properties to be updated.
        required: true
      summary: Fleets update
      x-summary-source: derived
    delete:
      operationId: Fleets_Delete
      tags:
      - Fleets
      description: Delete a Fleet
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: If-Match
        in: header
        description: The request should only proceed if an entity matches this string.
        required: false
        x-ms-client-name: ifMatch
        schema:
          type: string
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Fleets delete
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/listCredentials
  : post:
      operationId: Fleets_ListCredentials
      tags:
      - Fleets
      description: Lists the user credentials of a Fleet.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: fleetName
        in: path
        description: The name of the Fleet resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetCredentialResults'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Fleets list credentials
      x-summary-source: derived
components:
  parameters:
    SkipTokenQueryParameter:
      name: $skipToken
      in: query
      description: The page-continuation token to use with a paged version of this API.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: skipToken
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        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
    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
    TopQueryParameter:
      name: $top
      in: query
      description: The number of result items to return.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: top
      schema:
        type: integer
        format: int32
  schemas:
    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'
    APIServerAccessProfile:
      type: object
      description: Access profile for the Fleet hub API server.
      properties:
        enablePrivateCluster:
          type: boolean
          description: Whether to create the Fleet hub as a private cluster or not.
          x-ms-mutability:
          - read
          - create
        enableVnetIntegration:
          type: boolean
          description: Whether to enable apiserver vnet integration for the Fleet hub or not.
          x-ms-mutability:
          - read
          - create
        subnetId:
          $ref: '#/components/schemas/SubnetResourceId'
          description: The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
          x-ms-mutability:
          - read
          - create
    FleetCredentialResults:
      type: object
      description: The Credential results response.
      properties:
        kubeconfigs:
          type: array
          description: Array of base64-encoded Kubernetes configuration files.
          items:
            $ref: '#/components/schemas/FleetCredentialResult'
          readOnly: true
          x-ms-identifiers:
          - name
    ManagedServiceIdentity:
      type: object
      description: Managed service identity (system assigned and/or user assigned identities)
      properties:
        principalId:
          type: string
          format: uuid
          description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
          readOnly: true
        tenantId:
          type: string
          format: uuid
          description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
          readOnly: true
        type:
          $ref: '#/components/schemas/ManagedServiceIdentityType'
        userAssignedIdentities:
          $ref: '#/components/schemas/UserAssignedIdentities'
      required:
      - type
    FleetCredentialResult:
      type: object
      description: One credential result item.
      properties:
        name:
          type: string
          description: The name of the credential.
          readOnly: true
        value:
          type: string
          format: byte
          description: Base64-encoded Kubernetes configuration file.
          readOnly: true
    FleetListResult:
      type: object
      description: The response of a Fleet list operation.
      properties:
        value:
          type: array
          description: The Fleet items on this page
          items:
            $ref: '#/components/schemas/Fleet'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    FleetProvisioningState:
      type: string
      description: The provisioning state of the last accepted operation.
      enum:
      - Succeeded
      - Failed
      - Canceled
      - Creating
      - Updating
      - Deleting
      x-ms-enum:
        name: FleetProvisioningState
        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: Creating
          value: Creating
          description: The provisioning state of a fleet being created.
        - name: Updating
          value: Updating
          description: The provisioning state of a fleet being updated.
        - name: Deleting
          value: Deleting
          description: The provisioning state of a fleet being deleted.
      readOnly: true
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          x-ms-identifiers:
          - message
          - target
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
          x-ms-identifiers: []
    ErrorResponse:
      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.
    FleetStatus:
      type: object
      description: Status information for the fleet.
      properties:
        lastOperationId:
          type: string
          description: The last operation ID for the fleet.
          readOnly: true
        lastOperationError:
          $ref: '#/components/schemas/ErrorDetail'
          description: The last operation error for the fleet.
          readOnly: true
    SubnetResourceId:
      type: string
      format: arm-id
      description: A type definition that refers the id to an Azure Resource Manager resource.
      x-ms-arm-id-details:
        allowedResources:
        - type: Microsoft.Network/virtualNetworks/subnets
    FleetProperties:
      type: object
      description: Fleet properties.
      properties:
        provisioningState:
          $ref: '#/components/schemas/FleetProvisioningState'
          description: The status of the last operation.
          readOnly: true
        hubProfile:
          $ref: '#/components/schemas/FleetHubProfile'
          description: The FleetHubProfile configures the Fleet's hub.
        status:
          $ref: '#/components/schemas/FleetStatus'
          description: Status information for the fleet.
          readOnly: true
    FleetPatch:
      type: object
      description: Properties of a Fleet that can be patched.
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
          description: Managed identity.
    FleetHubProfile:
      type: object
      description: The FleetHubProfile configures the fleet hub.
      properties:
        dnsPrefix:
          type: string
          description: DNS prefix used to create the FQDN for the Fleet hub.
          minLength: 1
          maxLength: 54
          pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$
          x-ms-mutability:
          - read
          - create
        apiServerAccessProfile:
          $ref: '#/components/schemas/APIServerAccessProfile'
          description: The access profile for the Fleet hub API server.
          x-ms-mutability:
          - read
          - create
        agentProfile:
          $ref: '#/components/schemas/AgentProfile'
          description: The agent profile for the Fleet hub.
          x-ms-mutability:
          - read
          - create
        fqdn:
          type: string
          description: The FQDN of the Fleet hub.
          readOnly: true
        kubernetesVersion:
          type: string
          description: The Kubernetes version of the Fleet hub.
          readOnly: true
        portalFqdn:
          type: string
          description: The Azure Portal FQDN of the Fleet hub.
          readOnly: true
    Fleet:
      type: object
      description: The Fleet resource.
      properties:
        properties:
          $ref: '#/components/schemas/FleetProperties'
          description: The resource-specific properties for this resource.
          x-ms-client-flatten: true
        eTag:
          type: string
          description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
          readOnly: true
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
          description: Managed identity.
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    AgentProfile:
      type: object
      description: Agent profile for the Fleet hub.
      properties:
        subnetId:
          $ref: '#/components/schemas/SubnetResourceId'
          description: The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
          x-ms-mutability:
          - read
          - create
        vmSize:
          type: string
          description: The virtual machine size of the Fleet hub.
          x-ms-mutability:
          - read
          - create
  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.