swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Students API
schemes:
- https
tags:
- name: Students
paths:
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students
  : get:
      tags:
      - Students
      x-ms-examples:
        StudentList:
          $ref: ./examples/StudentList.json
      operationId: microsoftAzureStudentsList
      description: Get a list of details about students that are associated with the specified lab.
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/IncludeDeletedParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Student details.
          schema:
            $ref: '#/definitions/StudentListResult'
        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 Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Students
  ? /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Education/labs/default/students/{studentAlias}
  : get:
      tags:
      - Students
      x-ms-examples:
        Student:
          $ref: ./examples/Student.json
      operationId: microsoftAzureStudentsGet
      description: Get the details for a specific student in the specified lab by student alias
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/studentAliasParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: student detail.
          schema:
            $ref: '#/definitions/StudentDetails'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Get Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Students Studentalias
    delete:
      tags:
      - Students
      x-ms-examples:
        DeleteLab:
          $ref: ./examples/DeleteStudent.json
      operationId: microsoftAzureStudentsDelete
      description: Delete the specified student based on the student alias.
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/studentAliasParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: student deleted
        '204':
          description: student does not exists
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Delete Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Students Studentalias
    put:
      tags:
      - Students
      x-ms-examples:
        Student:
          $ref: ./examples/CreateStudent.json
      operationId: microsoftAzureStudentsCreateorupdate
      description: Create and add a new student to the specified lab or update the details of an existing student in a lab. Note the student must have a valid tenant to accept the lab after they have been added to lab.
      parameters:
      - $ref: '#/parameters/BillingAccountNameParameter'
      - $ref: '#/parameters/BillingProfileNameParameter'
      - $ref: '#/parameters/InvoiceSectionNameParameter'
      - $ref: '#/parameters/studentAliasParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/StudentDetails'
        description: Request parameters that are provided to update student properties.
      responses:
        '200':
          description: Successfully updated student detail.
          schema:
            $ref: '#/definitions/StudentDetails'
        '201':
          description: Successfully created student detail.
          schema:
            $ref: '#/definitions/StudentDetails'
        default:
          description: Describes the error if the operation is not successful.
          schema:
            $ref: '#/definitions/ErrorResponseBody'
      summary: Microsoft Azure Put Providers Microsoft Billing Billingaccounts Billingaccountname Billingprofiles Billingprofilename Invoicesections Invoicesectionname Providers Microsoft Education Labs Default Students Studentalias
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
  StudentListResult:
    description: List of students.
    type: object
    properties:
      value:
        description: The list of students.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/StudentDetails'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
  StudentDetails:
    description: Student details.
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      properties:
        $ref: '#/definitions/StudentProperties'
        description: Get student response 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
  StudentProperties:
    description: Student detail properties
    type: object
    required:
    - firstName
    - lastName
    - email
    - role
    - budget
    - expirationDate
    properties:
      firstName:
        type: string
        description: First Name
      lastName:
        type: string
        description: Last Name
      email:
        type: string
        description: Student Email
        x-ms-mutability:
        - create
        - read
      role:
        type: string
        enum:
        - Student
        - Admin
        x-ms-enum:
          name: Student role
          modelAsString: true
        description: Student Role
      budget:
        $ref: '#/definitions/Amount'
        description: Student Budget
      subscriptionId:
        type: string
        description: Subscription Id
        readOnly: true
      expirationDate:
        type: string
        format: date-time
        description: Date this student is set to expire from the lab.
      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: Date student was added to the lab
        readOnly: true
      subscriptionAlias:
        type: string
        description: Subscription alias
      subscriptionInviteLastSentDate:
        type: string
        format: date-time
        description: subscription invite last sent date
  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'
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
  BillingProfileNameParameter:
    name: billingProfileName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing profile.
  IncludeDeletedParameter:
    name: includeDeleted
    x-ms-parameter-location: method
    in: query
    type: boolean
    description: May be used to show deleted items.
  studentAliasParameter:
    name: studentAlias
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: Student alias.
  BillingAccountNameParameter:
    name: billingAccountName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies a billing account.
  InvoiceSectionNameParameter:
    name: invoiceSectionName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    description: The ID that uniquely identifies an invoice section.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'