Package com.azure.resourcemanager.education.fluent

Interface StudentsClient

public interface StudentsClient
An instance of this class provides access to all the operations defined in StudentsClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    StudentDetailsInner
    createOrUpdate(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, StudentDetailsInner parameters)
    Create and add a new student to the specified lab or update the details of an existing student in a lab.
    com.azure.core.http.rest.Response<StudentDetailsInner>
    createOrUpdateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, StudentDetailsInner parameters, com.azure.core.util.Context context)
    Create and add a new student to the specified lab or update the details of an existing student in a lab.
    void
    delete(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias)
    Delete the specified student based on the student alias.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, com.azure.core.util.Context context)
    Delete the specified student based on the student alias.
    StudentDetailsInner
    get(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias)
    Get the details for a specific student in the specified lab by student alias.
    com.azure.core.http.rest.Response<StudentDetailsInner>
    getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, com.azure.core.util.Context context)
    Get the details for a specific student in the specified lab by student alias.
    com.azure.core.http.rest.PagedIterable<StudentDetailsInner>
    list(String billingAccountName, String billingProfileName, String invoiceSectionName)
    Get a list of details about students that are associated with the specified lab.
    com.azure.core.http.rest.PagedIterable<StudentDetailsInner>
    list(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeDeleted, com.azure.core.util.Context context)
    Get a list of details about students that are associated with the specified lab.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<StudentDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName)
      Get a list of details about students that are associated with the specified lab.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      Returns:
      a list of details about students that are associated with the specified lab as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<StudentDetailsInner> list(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeDeleted, com.azure.core.util.Context context)
      Get a list of details about students that are associated with the specified lab.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      includeDeleted - May be used to show deleted items.
      context - The context to associate with this operation.
      Returns:
      a list of details about students that are associated with the specified lab as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<StudentDetailsInner> getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, com.azure.core.util.Context context)
      Get the details for a specific student in the specified lab by student alias.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      context - The context to associate with this operation.
      Returns:
      the details for a specific student in the specified lab by student alias along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      StudentDetailsInner get(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias)
      Get the details for a specific student in the specified lab by student alias.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      Returns:
      the details for a specific student in the specified lab by student alias.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, com.azure.core.util.Context context)
      Delete the specified student based on the student alias.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias)
      Delete the specified student based on the student alias.
      Parameters:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<StudentDetailsInner> createOrUpdateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, StudentDetailsInner parameters, com.azure.core.util.Context context)
      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:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      parameters - Request parameters that are provided to update student properties.
      context - The context to associate with this operation.
      Returns:
      student details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      StudentDetailsInner createOrUpdate(String billingAccountName, String billingProfileName, String invoiceSectionName, String studentAlias, StudentDetailsInner parameters)
      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:
      billingAccountName - The ID that uniquely identifies a billing account.
      billingProfileName - The ID that uniquely identifies a billing profile.
      invoiceSectionName - The ID that uniquely identifies an invoice section.
      studentAlias - Student alias.
      parameters - Request parameters that are provided to update student properties.
      Returns:
      student details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.