swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector EnvironmentSettings API
schemes:
- https
tags:
- name: EnvironmentSettings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings
  : get:
      tags:
      - EnvironmentSettings
      description: List environment setting in a given lab.
      operationId: microsoftAzureEnvironmentsettingsList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=publishingState)'''
        required: false
        type: string
      - name: $filter
        in: query
        description: The filter to apply to the operation.
        required: false
        type: string
      - name: $top
        in: query
        description: The maximum number of resources to return from the operation.
        required: false
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: The ordering expression for the results, using OData notation.
        required: false
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ResponseWithContinuation[EnvironmentSetting]'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/EnvironmentSetting'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}
  : get:
      tags:
      - EnvironmentSettings
      description: Get environment setting
      operationId: microsoftAzureEnvironmentsettingsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=publishingState)'''
        required: false
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EnvironmentSetting'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname
    put:
      tags:
      - EnvironmentSettings
      description: Create or replace an existing Environment Setting. This operation can take a while to complete
      operationId: microsoftAzureEnvironmentsettingsCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - name: environmentSetting
        in: body
        description: Represents settings of an environment, from which environment instances would be created
        required: true
        schema:
          $ref: '#/definitions/EnvironmentSetting'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EnvironmentSetting'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/EnvironmentSetting'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname
    delete:
      tags:
      - EnvironmentSettings
      description: Delete environment setting. This operation can take a while to complete
      operationId: microsoftAzureEnvironmentsettingsDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname
    patch:
      tags:
      - EnvironmentSettings
      description: Modify properties of environment setting.
      operationId: microsoftAzureEnvironmentsettingsUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - name: environmentSetting
        in: body
        description: Represents settings of an environment, from which environment instances would be created
        required: true
        schema:
          $ref: '#/definitions/EnvironmentSettingFragment'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/EnvironmentSetting'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/claimAny
  : post:
      tags:
      - EnvironmentSettings
      description: Claims a random environment for a user in an environment settings
      operationId: microsoftAzureEnvironmentsettingsClaimany
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Claimany
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/publish
  : post:
      tags:
      - EnvironmentSettings
      description: Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.
      operationId: microsoftAzureEnvironmentsettingsPublish
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - name: publishPayload
        in: body
        description: Payload for Publish operation on EnvironmentSetting.
        required: true
        schema:
          $ref: '#/definitions/PublishPayload'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Publish
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/start
  : post:
      tags:
      - EnvironmentSettings
      description: Starts a template by starting all resources inside the template. This operation can take a while to complete
      operationId: microsoftAzureEnvironmentsettingsStart
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Start
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/stop
  : post:
      tags:
      - EnvironmentSettings
      description: Starts a template by starting all resources inside the template. This operation can take a while to complete
      operationId: microsoftAzureEnvironmentsettingsStop
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labAccountName
        in: path
        description: The name of the lab Account.
        required: true
        type: string
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: environmentSettingName
        in: path
        description: The name of the environment Setting.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      security:
      - azure_auth:
        - user_impersonation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Labservices Labaccounts Labaccountname Labs Labname Environmentsettings Environmentsettingname Stop
definitions:
  VmStateDetails:
    description: Details about the state of the reference virtual machine.
    type: object
    properties:
      rdpAuthority:
        description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
        type: string
        readOnly: true
      sshAuthority:
        description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
        type: string
        readOnly: true
      powerState:
        description: The power state of the reference virtual machine.
        type: string
        readOnly: true
      lastKnownPowerState:
        description: Last known compute power state captured in DTL
        type: string
        readOnly: true
  ReferenceVm:
    description: Details of a Reference Vm
    required:
    - userName
    type: object
    properties:
      userName:
        description: The username of the virtual machine
        type: string
      password:
        description: The password of the virtual machine. This will be set to null in GET resource API
        type: string
      vmStateDetails:
        $ref: '#/definitions/VmStateDetails'
        description: The state details for the reference virtual machine.
        readOnly: true
      vmResourceId:
        description: VM resource Id for the environment
        type: string
        readOnly: true
  Resource:
    description: An Azure resource.
    type: object
    properties:
      id:
        description: The identifier of 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
      location:
        description: The location of the resource.
        type: string
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  ResponseWithContinuation[EnvironmentSetting]:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Results of the list operation.
        type: array
        items:
          $ref: '#/definitions/EnvironmentSetting'
      nextLink:
        description: Link for next set of results.
        type: string
  LatestOperationResult:
    description: Details of the status of an operation.
    type: object
    properties:
      status:
        description: The current status of the operation.
        type: string
        readOnly: true
      errorCode:
        description: Error code on failure.
        type: string
        readOnly: true
      errorMessage:
        description: The error message.
        type: string
        readOnly: true
      requestUri:
        description: Request URI of the operation.
        type: string
        readOnly: true
      httpMethod:
        description: The HttpMethod - PUT/POST/DELETE for the operation.
        type: string
        readOnly: true
      operationUrl:
        description: The URL to use to check long-running operation status
        type: string
        readOnly: true
  ResourceSettings:
    description: Represents resource specific settings
    required:
    - referenceVm
    type: object
    properties:
      id:
        description: The unique id of the resource setting
        type: string
        readOnly: true
      galleryImageResourceId:
        description: The resource id of the gallery image used for creating the virtual machine
        type: string
      imageName:
        description: The name of the image used to created the environment setting
        type: string
        readOnly: true
      size:
        description: The size of the virtual machine
        enum:
        - Basic
        - Standard
        - Performance
        type: string
        x-ms-enum:
          name: ManagedLabVmSize
          modelAsString: true
          values:
          - value: Basic
            description: The base VM size
          - value: Standard
            description: The standard or default VM size
          - value: Performance
            description: The most performant VM size
      cores:
        format: int32
        description: The translated compute cores of the virtual machine
        type: integer
        readOnly: true
      referenceVm:
        $ref: '#/definitions/ReferenceVm'
        description: Details specific to Reference Vm
  CloudError:
    description: Error from a REST request.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  PublishPayload:
    description: Payload for Publish operation on EnvironmentSetting.
    type: object
    properties:
      useExistingImage:
        description: Whether to use existing VM custom image when publishing.
        type: boolean
  ReferenceVmFragment:
    description: Details of a Reference Vm
    type: object
    properties:
      userName:
        description: The username of the virtual machine
        type: string
      password:
        description: The password of the virtual machine. This will be set to null in GET resource API
        type: string
  EnvironmentSetting:
    description: Represents settings of an environment, from which environment instances would be created
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/EnvironmentSettingProperties'
        description: The properties of the Environment Setting resource
        x-ms-client-flatten: true
  CloudErrorBody:
    description: Body of an error from a REST request.
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        description: Inner errors.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  EnvironmentSettingFragment:
    description: Represents settings of an environment, from which environment instances would be created
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/EnvironmentSettingPropertiesFragment'
        description: The properties of the Environment Setting resource
        x-ms-client-flatten: true
  EnvironmentSettingPropertiesFragment:
    description: Properties of an environment setting
    type: object
    properties:
      configurationState:
        description: Describes the user's progress in configuring their environment setting
        enum:
        - NotApplicable
        - Completed
        type: string
        x-ms-enum:
          name: ConfigurationState
          modelAsString: true
          values:
          - value: NotApplicable
            description: "User either hasn't started configuring their template\r\nor they haven't started the configuration process."
          - value: Completed
            description: User is finished modifying the template.
      description:
        description: Describes the environment and its resource settings
        type: string
      title:
        description: Brief title describing the environment and its resource settings
        type: string
      resourceSettings:
        $ref: '#/definitions/ResourceSettingsFragment'
        description: The resource specific settings
      provisioningState:
        description: The provisioning status of the resource.
        type: string
      uniqueIdentifier:
        description: The unique immutable identifier of a resource (Guid).
        type: string
  EnvironmentSettingProperties:
    description: Properties of an environment setting
    required:
    - resourceSettings
    type: object
    properties:
      publishingState:
        description: Describes the readiness of this environment setting
        enum:
        - Draft
        - Publishing
        - Published
        - PublishFailed
        - Scaling
        type: string
        readOnly: true
        x-ms-enum:
          name: PublishingState
          modelAsString: true
          values:
          - value: Draft
            description: Initial state of an environment setting.
          - value: Publishing
            description: Currently provisioning resources.
          - value: Published
            description: All resources are currently provisioned.
          - value: PublishFailed
            description: Failed to provision all the necessary resources.
          - value: Scaling
            description: Currently provisioning resources without recreating VM image.
      configurationState:
        description: Describes the user's progress in configuring their environment setting
        enum:
        - NotApplicable
        - Completed
        type: string
        x-ms-enum:
          name: ConfigurationState
          modelAsString: true
          values:
          - value: NotApplicable
            description: "User either hasn't started configuring their template\r\nor they haven't started the configuration process."
          - value: Completed
            description: User is finished modifying the template.
      description:
        description: Describes the environment and its resource settings
        type: string
      title:
        description: Brief title describing the environment and its resource settings
        type: string
      resourceSettings:
        $ref: '#/definitions/ResourceSettings'
        description: The resource specific settings
      lastChanged:
        format: date-time
        description: Time when the template VM was last changed.
        type: string
        readOnly: true
      lastPublished:
        format: date-time
        description: Time when the template VM was last sent for publishing.
        type: string
        readOnly: true
      provisioningState:
        description: The provisioning status of the resource.
        type: string
      uniqueIdentifier:
        description: The unique immutable identifier of a resource (Guid).
        type: string
      latestOperationResult:
        $ref: '#/definitions/LatestOperationResult'
        description: 'The details of the latest operation. ex: status, error'
        readOnly: true
  ResourceSettingsFragment:
    description: Represents resource specific settings
    type: object
    properties:
      galleryImageResourceId:
        description: The resource id of the gallery image used for creating the virtual machine
        type: string
      size:
        description: The size of the virtual machine
        enum:
        - Basic
        - Standard
        - Performance
        type: string
        x-ms-enum:
          name: ManagedLabVmSize
          modelAsString: true
          values:
          - value: Basic
            description: The base VM size
          - value: Standard
            description: The standard or default VM size
          - value: Performance
            description: The most performant VM size
      referenceVm:
        $ref: '#/definitions/ReferenceVmFragment'
        description: Details specific to Reference Vm
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  api-version:
    name: api-version
    in: query
    description: Client API version.
    required: true
    type: string
    default: '2018-10-15'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'