swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Controllers API
schemes:
- https
tags:
- name: Controllers
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}:
    get:
      tags:
      - Controllers
      summary: Microsoft Azure Gets An Azure Dev Spaces Controller
      description: Gets the properties for an Azure Dev Spaces Controller.
      operationId: microsoftAzureControllersGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/NameParameter'
      responses:
        '200':
          description: The request was successful; response contains the Azure Dev Spaces Controller.
          schema:
            $ref: '#/definitions/Controller'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.)
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersGet:
          $ref: ./examples/ControllersGet_example.json
    put:
      tags:
      - Controllers
      summary: Microsoft Azure Creates An Azure Dev Spaces Controller
      description: Creates an Azure Dev Spaces Controller with the specified create parameters.
      operationId: microsoftAzureControllersCreate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/NameParameter'
      - name: controller
        in: body
        description: Controller create parameters.
        required: true
        schema:
          $ref: '#/definitions/Controller'
      responses:
        '200':
          description: The request was successful; response contains the created Azure Dev Spaces Controller .
          schema:
            $ref: '#/definitions/Controller'
        '201':
          description: The request was successful; Azure Dev Spaces Controller is being created.
          schema:
            $ref: '#/definitions/Controller'
        default:
          description: Error response describing the reason for operation failure. 400 - BadRequest(One or more creation parameters are invalid.), 409 - Conflict(Target container host is not in a supported state.)
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersCreate:
          $ref: ./examples/ControllersCreate_example.json
      x-ms-long-running-operation: true
    delete:
      tags:
      - Controllers
      summary: Microsoft Azure Deletes An Azure Dev Spaces Controller
      description: Deletes an existing Azure Dev Spaces Controller.
      operationId: microsoftAzureControllersDelete
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/NameParameter'
      responses:
        '200':
          description: The request was successful; the Azure Dev Spaces Controller is deleted.
        '202':
          description: The request was successful; Azure Dev Spaces Controller is being deleted.
        '204':
          description: The request was successful; Azure Dev Spaces Controller does not exist.
        default:
          description: Error response describing the reason for operation failure. 409 - Conflict(Azure Dev Spaces Controller is in a non-terminal state due to an ongoing operation.)
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersDelete:
          $ref: ./examples/ControllersDelete_example.json
      x-ms-long-running-operation: true
    patch:
      tags:
      - Controllers
      summary: Microsoft Azure Updates An Azure Dev Spaces Controller
      description: Updates the properties of an existing Azure Dev Spaces Controller with the specified update parameters.
      operationId: microsoftAzureControllersUpdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/NameParameter'
      - name: controllerUpdateParameters
        in: body
        description: Parameters for updating the Azure Dev Spaces Controller.
        required: true
        schema:
          $ref: '#/definitions/ControllerUpdateParameters'
      responses:
        '200':
          description: The request was successful; response contains the updated Azure Dev Spaces Controller .
          schema:
            $ref: '#/definitions/Controller'
        '201':
          description: The request was successful; Azure Dev Spaces Controller is being updated.
          schema:
            $ref: '#/definitions/Controller'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.), 400 - BadRequest(One or more update parameters are invalid.), 409 - Conflict(Target container host is not in a supported state.)
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersUpdate:
          $ref: ./examples/ControllersUpdate_example.json
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers:
    get:
      tags:
      - Controllers
      summary: Microsoft Azure Lists The Azure Dev Spaces Controllers In A Resource Group
      description: Lists all the Azure Dev Spaces Controllers with their properties in the specified resource group and subscription.
      operationId: microsoftAzureControllersListbyresourcegroup
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: The request was successful; response contains the list of Azure Dev Spaces Controllers in the resource group.
          schema:
            $ref: '#/definitions/ControllerList'
        default:
          description: Error response describing the reason for operation failure.
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersListByResourceGroup:
          $ref: ./examples/ControllersListByResourceGroup_example.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.DevSpaces/controllers:
    get:
      tags:
      - Controllers
      summary: Microsoft Azure Lists The Azure Dev Spaces Controllers In A Subscription
      description: Lists all the Azure Dev Spaces Controllers with their properties in the subscription.
      operationId: microsoftAzureControllersList
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request was successful; response contains the list of Azure Dev Spaces Controllers in the subscription.
          schema:
            $ref: '#/definitions/ControllerList'
        default:
          description: Error response describing the reason for operation failure.
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersList:
          $ref: ./examples/ControllersList_example.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevSpaces/controllers/{name}/listConnectionDetails
  : post:
      tags:
      - Controllers
      summary: Microsoft Azure Lists Connection Details For An Azure Dev Spaces Controller
      description: Lists connection details for the underlying container resources of an Azure Dev Spaces Controller.
      operationId: microsoftAzureControllersListconnectiondetails
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/NameParameter'
      - name: listConnectionDetailsParameters
        in: body
        description: Parameters for listing connection details of Azure Dev Spaces Controller.
        required: true
        schema:
          $ref: '#/definitions/ListConnectionDetailsParameters'
      responses:
        '200':
          description: The request was successful; response contains the list of connection details for the Azure Dev Spaces Controller .
          schema:
            $ref: '#/definitions/ControllerConnectionDetailsList'
        default:
          description: Error response describing the reason for operation failure. 404 - NotFound(Azure Dev Spaces Controller doesn't exist.)
          schema:
            $ref: '#/definitions/DevSpacesErrorResponse'
      x-ms-examples:
        ControllersListConnectionDetails:
          $ref: ./examples/ControllersListConnectionDetails_example.json
definitions:
  ControllerProperties:
    required:
    - targetContainerHostResourceId
    - targetContainerHostCredentialsBase64
    properties:
      provisioningState:
        description: Provisioning state of the Azure Dev Spaces Controller.
        enum:
        - Succeeded
        - Failed
        - Canceled
        - Updating
        - Creating
        - Deleting
        - Deleted
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      hostSuffix:
        description: DNS suffix for public endpoints running in the Azure Dev Spaces Controller.
        type: string
        readOnly: true
      dataPlaneFqdn:
        description: DNS name for accessing DataPlane services
        type: string
        readOnly: true
      targetContainerHostApiServerFqdn:
        description: DNS of the target container host's API server
        type: string
        readOnly: true
      targetContainerHostResourceId:
        description: Resource ID of the target container host
        type: string
        x-ms-mutability:
        - read
        - create
      targetContainerHostCredentialsBase64:
        description: Credentials of the target container host (base64).
        type: string
        x-ms-mutability:
        - create
  ControllerConnectionDetailsList:
    properties:
      connectionDetailsList:
        description: List of Azure Dev Spaces Controller connection details.
        type: array
        items:
          $ref: '#/definitions/ControllerConnectionDetails'
  Resource:
    description: An Azure resource.
    properties:
      id:
        description: Fully qualified resource Id for the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  OrchestratorSpecificConnectionDetails:
    description: Base class for types that supply values used to connect to container orchestrators
    properties:
      instanceType:
        description: Gets the Instance type.
        type: string
        readOnly: true
    discriminator: instanceType
  ListConnectionDetailsParameters:
    description: Parameters for listing connection details of an Azure Dev Spaces Controller.
    required:
    - targetContainerHostResourceId
    properties:
      targetContainerHostResourceId:
        description: Resource ID of the target container host mapped to the Azure Dev Spaces Controller.
        type: string
  ErrorDetails:
    properties:
      code:
        description: Status code for the error.
        type: string
        readOnly: true
      message:
        description: Error message describing the error in detail.
        type: string
        readOnly: true
      target:
        description: The target of the particular error.
        type: string
        readOnly: true
  ControllerConnectionDetails:
    properties:
      orchestratorSpecificConnectionDetails:
        $ref: '#/definitions/OrchestratorSpecificConnectionDetails'
  Sku:
    description: Model representing SKU for Azure Dev Spaces Controller.
    required:
    - name
    properties:
      name:
        description: The name of the SKU for Azure Dev Spaces Controller.
        enum:
        - S1
        type: string
        x-ms-enum:
          name: SkuName
          modelAsString: true
      tier:
        description: The tier of the SKU for Azure Dev Spaces Controller.
        enum:
        - Standard
        type: string
        x-ms-enum:
          name: SkuTier
          modelAsString: true
  TrackedResource:
    description: The resource model definition for a ARM tracked top level resource.
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      tags:
        description: Tags for the Azure resource.
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
      location:
        description: Region where the Azure resource is located.
        type: string
        x-ms-mutability:
        - read
        - create
  ControllerList:
    properties:
      value:
        description: List of Azure Dev Spaces Controllers.
        type: array
        items:
          $ref: '#/definitions/Controller'
      nextLink:
        description: The URI that can be used to request the next page for list of Azure Dev Spaces Controllers.
        type: string
        readOnly: true
  Controller:
    required:
    - properties
    - sku
    - location
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/ControllerProperties'
        x-ms-client-flatten: true
      sku:
        $ref: '#/definitions/Sku'
  DevSpacesErrorResponse:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    properties:
      error:
        $ref: '#/definitions/ErrorDetails'
        description: The details of the error.
  ControllerUpdateParametersProperties:
    properties:
      targetContainerHostCredentialsBase64:
        description: Credentials of the target container host (base64).
        type: string
  ControllerUpdateParameters:
    description: Parameters for updating an Azure Dev Spaces Controller.
    properties:
      tags:
        description: Tags for the Azure Dev Spaces Controller.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/ControllerUpdateParametersProperties'
        x-ms-client-flatten: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Client API version.
    required: true
    type: string
  NameParameter:
    name: name
    in: path
    description: Name of the resource.
    required: true
    type: string
    maxLength: 63
    minLength: 1
    pattern: ^[a-zA-Z0-9]([_-]*[a-zA-Z0-9])*$
    x-ms-parameter-location: method
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    description: Resource group to which the resource belongs.
    required: true
    type: string
    maxLength: 90
    minLength: 1
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'