swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Fleets API
schemes:
- https
tags:
- name: Fleets
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}:
    put:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsCreateorupdate
      summary: Microsoft Azure Creates Or Updates A Fleet
      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
      - $ref: '#/parameters/FleetNameParameter'
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/IfNoneMatchHeader'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/Fleet'
        description: The Fleet to create or update.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fleet'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Fleet'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        Creates or update a fleet resource:
          $ref: ./examples/Fleets_CreateOrUpdate.json
      description: Needs a more full description created.
    patch:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsUpdate
      summary: Microsoft Azure Patches A Fleet Resource
      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
      - $ref: '#/parameters/FleetNameParameter'
      - $ref: '#/parameters/IfMatchHeader'
      - name: parameters
        in: body
        schema:
          $ref: '#/definitions/FleetPatch'
        description: The properties of a Fleet to update.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fleet'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Patches a fleet resource:
          $ref: ./examples/Fleets_PatchTags.json
      description: Needs a more full description created.
    get:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsGet
      summary: Microsoft Azure Gets A Fleet
      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
      - $ref: '#/parameters/FleetNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Fleet'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Gets a fleet resource.:
          $ref: ./examples/Fleets_Get.json
      description: Needs a more full description created.
    delete:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsDelete
      summary: Microsoft Azure Deletes A Fleet
      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
      - $ref: '#/parameters/IfMatchHeader'
      - $ref: '#/parameters/FleetNameParameter'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Delete a fleet resource.:
          $ref: ./examples/Fleets_Delete.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets:
    get:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsListbyresourcegroup
      summary: Microsoft Azure Lists Fleets In The Specified Subscription And Resource Group
      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
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FleetListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List fleet resources in a given resource group:
          $ref: ./examples/Fleets_ListByResourceGroup.json
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets:
    get:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsList
      summary: Microsoft Azure Lists Fleets In The Specified Subscription
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FleetListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List fleet resources in a given subscription:
          $ref: ./examples/Fleets_ListBySub.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/listCredentials
  : post:
      tags:
      - Fleets
      operationId: microsoftAzureFleetsListcredentials
      summary: Microsoft Azure Lists The User Credentials Of A Fleet
      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
      - $ref: '#/parameters/FleetNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/FleetCredentialResults'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Fleet Credentials:
          $ref: ./examples/Fleets_ListCredentialsResult.json
      description: Needs a more full description created.
definitions:
  FleetCredentialResult:
    type: object
    properties:
      name:
        type: string
        readOnly: true
        description: The name of the credential.
      value:
        type: string
        format: byte
        readOnly: true
        description: Base64-encoded Kubernetes configuration file.
    description: The credential result response.
  FleetHubProfile:
    type: object
    description: The FleetHubProfile configures the fleet hub.
    properties:
      dnsPrefix:
        type: string
        x-ms-mutability:
        - read
        - create
        description: DNS prefix used to create the FQDN for the Fleet hub.
      fqdn:
        readOnly: true
        type: string
        description: The FQDN of the Fleet hub.
      kubernetesVersion:
        readOnly: true
        type: string
        description: The Kubernetes version of the Fleet hub.
  Fleet:
    type: object
    properties:
      etag:
        type: string
        readOnly: true
        description: Resource Etag.
      properties:
        description: Properties of a Fleet.
        $ref: '#/definitions/FleetProperties'
        x-ms-client-flatten: true
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
    description: The Fleet resource which contains multiple Kubernetes clusters as its members.
  FleetProperties:
    type: object
    description: Properties of a Fleet.
    properties:
      hubProfile:
        description: The FleetHubProfile configures the Fleet's hub.
        $ref: '#/definitions/FleetHubProfile'
      provisioningState:
        readOnly: true
        type: string
        x-ms-enum:
          name: FleetProvisioningState
          modelAsString: true
        enum:
        - Succeeded
        - Failed
        - Canceled
        - Creating
        - Deleting
        - Updating
        description: The provisioning state of the last accepted operation.
  FleetCredentialResults:
    type: object
    properties:
      kubeconfigs:
        type: array
        x-ms-identifiers:
        - name
        readOnly: true
        items:
          $ref: '#/definitions/FleetCredentialResult'
        description: Base64-encoded Kubernetes configuration file.
    description: The list credential result response.
  FleetPatch:
    type: object
    description: Properties of a Fleet that can be patched.
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
        description: Resource tags.
  FleetListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Fleet'
        description: The list of Fleets.
      nextLink:
        type: string
        description: The URL to get the next page of Fleets.
        readOnly: true
    description: The response from the List Fleets operation.
parameters:
  FleetNameParameter:
    name: fleetName
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 63
    pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
    description: The name of the Fleet resource.
    x-ms-parameter-location: method
  IfMatchHeader:
    name: If-Match
    in: header
    required: false
    type: string
    x-ms-client-name: IfMatch
    x-ms-parameter-location: method
    description: Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
  IfNoneMatchHeader:
    name: If-None-Match
    in: header
    required: false
    type: string
    x-ms-client-name: IfNoneMatch
    x-ms-parameter-location: method
    description: Set to '*' to allow a new resource to be created and prevent updating an existing resource. Other values will result in a 412 Pre-condition Failed response.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'