swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector StudentLabs API
schemes:
- https
tags:
- name: StudentLabs
paths:
  /providers/Microsoft.Education/studentLabs:
    get:
      tags:
      - StudentLabs
      x-ms-examples:
        StudentLabList:
          $ref: ./examples/StudentLabList.json
      operationId: microsoftAzureStudentlabsListall
      description: Get a list of all labs associated with the caller of the API.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Lab details.
          schema:
            $ref: '#/definitions/StudentLabListResult'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Education Studentlabs
  /providers/Microsoft.Education/studentLabs/{studentLabName}:
    get:
      tags:
      - StudentLabs
      x-ms-examples:
        StudentLab:
          $ref: ./examples/StudentLab.json
      operationId: microsoftAzureStudentlabsGet
      description: Get the details for a specified lab associated with the student lab.
      parameters:
      - $ref: '#/parameters/StudentLabNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Lab details.
          schema:
            $ref: '#/definitions/StudentLabDetails'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Get Providers Microsoft Education Studentlabs Studentlabname
definitions:
  ErrorResponse:
    description: Describes the format of Error response.
    type: object
    properties:
      code:
        description: Error code
        type: string
      message:
        description: Error message indicating why the operation failed.
        type: string
  StudentLabListResult:
    description: List of labs.
    type: object
    properties:
      value:
        description: The list of labs.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/StudentLabDetails'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
  StudentLabDetails:
    description: Student lab details.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/StudentLabProperties'
        description: Student lab properties.
        x-ms-client-flatten: true
  Amount:
    description: The amount.
    type: object
    properties:
      currency:
        description: The type of currency being used for the value.
        type: string
      value:
        description: Amount value.
        type: number
  ErrorResponseBody:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        description: The details of the error.
        $ref: '#/definitions/ErrorResponse'
  StudentLabProperties:
    description: Student lab detail properties
    type: object
    properties:
      displayName:
        description: Student lab Display Name
        readOnly: true
        type: string
      description:
        type: string
        description: Detail description of this lab
        readOnly: true
      expirationDate:
        type: string
        format: date-time
        description: Date the lab will expire and by default will be the expiration date for each student in this lab
        readOnly: true
      role:
        type: string
        enum:
        - Student
        - Admin
        x-ms-enum:
          name: Student role
          modelAsString: true
        description: Student Role
        readOnly: true
      budget:
        $ref: '#/definitions/Amount'
        description: Student Budget
        readOnly: true
      subscriptionId:
        type: string
        description: Subscription Id
        readOnly: true
      status:
        type: string
        description: Student Lab Status
        enum:
        - Active
        - Disabled
        - Expired
        - Pending
        - Deleted
        x-ms-enum:
          name: Student Lab Status
          modelAsString: true
        readOnly: true
      effectiveDate:
        type: string
        format: date-time
        description: User Added Date
        readOnly: true
      labScope:
        type: string
        description: Lab Scope. /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default
        readOnly: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2021-12-01-preview
  StudentLabNameParameter:
    name: studentLabName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a student lab.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'