Package com.azure.resourcemanager.education.models

Interface Labs

public interface Labs
Resource collection API of Labs.

  • Method Summary

    Modifier and Type
    Method
    Description
    LabDetails
    createOrUpdate(String billingAccountName, String billingProfileName, String invoiceSectionName, LabDetailsInner parameters)
    Create a new lab or update a previously created lab.
    com.azure.core.http.rest.Response<LabDetails>
    createOrUpdateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, LabDetailsInner parameters, com.azure.core.util.Context context)
    Create a new lab or update a previously created lab.
    void
    delete(String billingAccountName, String billingProfileName, String invoiceSectionName)
    Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    com.azure.core.http.rest.Response<Void>
    deleteWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, com.azure.core.util.Context context)
    Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    LabDetails
    generateInviteCode(String billingAccountName, String billingProfileName, String invoiceSectionName, InviteCodeGenerateRequest parameters)
    Generate invite code for a lab.
    com.azure.core.http.rest.Response<LabDetails>
    generateInviteCodeWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, InviteCodeGenerateRequest parameters, Boolean onlyUpdateStudentCountParameter, com.azure.core.util.Context context)
    Generate invite code for a lab.
    LabDetails
    get(String billingAccountName, String billingProfileName, String invoiceSectionName)
    Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    com.azure.core.http.rest.Response<LabDetails>
    getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeBudget, com.azure.core.util.Context context)
    Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    com.azure.core.http.rest.PagedIterable<LabDetails>
    list(String billingAccountName, String billingProfileName, String invoiceSectionName)
    Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    com.azure.core.http.rest.PagedIterable<LabDetails>
    list(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeBudget, com.azure.core.util.Context context)
    Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
    com.azure.core.http.rest.PagedIterable<LabDetails>
    listAll(String billingAccountName, String billingProfileName)
    Get a list of labs associated with the provided billing account name and billing profile name.
    com.azure.core.http.rest.PagedIterable<LabDetails>
    listAll(String billingAccountName, String billingProfileName, Boolean includeBudget, Boolean includeDeleted, com.azure.core.util.Context context)
    Get a list of labs associated with the provided billing account name and billing profile name.

  • Method Details

    • listAll

      com.azure.core.http.rest.PagedIterable<LabDetails> listAll(String billingAccountName, String billingProfileName)
      Get a list of labs associated with the provided billing account name and billing profile name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      Returns:
      a list of labs associated with the provided billing account name and billing profile name 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.

    • listAll

      com.azure.core.http.rest.PagedIterable<LabDetails> listAll(String billingAccountName, String billingProfileName, Boolean includeBudget, Boolean includeDeleted, com.azure.core.util.Context context)
      Get a list of labs associated with the provided billing account name and billing profile name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      includeBudget - May be used to include budget information.
      includeDeleted - May be used to show deleted items.
      context - The context to associate with this operation.
      Returns:
      a list of labs associated with the provided billing account name and billing profile name 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<LabDetails> list(String billingAccountName, String billingProfileName, String invoiceSectionName)
      Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      Returns:
      the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name 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<LabDetails> list(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeBudget, com.azure.core.util.Context context)
      Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      includeBudget - May be used to include budget information.
      context - The context to associate with this operation.
      Returns:
      the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name 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.

    • get

      LabDetails get(String billingAccountName, String billingProfileName, String invoiceSectionName)
      Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      Returns:
      the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
      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<LabDetails> getWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, Boolean includeBudget, com.azure.core.util.Context context)
      Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      includeBudget - May be used to include budget information.
      context - The context to associate with this operation.
      Returns:
      the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name 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.

    • delete

      void delete(String billingAccountName, String billingProfileName, String invoiceSectionName)
      Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      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, com.azure.core.util.Context context)
      Delete a specific lab associated with the provided billing account name, billing profile name, and invoice section name. Note all students must be removed from the lab in order to delete the lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      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.

    • createOrUpdate

      LabDetails createOrUpdate(String billingAccountName, String billingProfileName, String invoiceSectionName, LabDetailsInner parameters)
      Create a new lab or update a previously created lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      parameters - Request parameters that are provided to create lab resource.
      Returns:
      lab 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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<LabDetails> createOrUpdateWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, LabDetailsInner parameters, com.azure.core.util.Context context)
      Create a new lab or update a previously created lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      parameters - Request parameters that are provided to create lab resource.
      context - The context to associate with this operation.
      Returns:
      lab 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.

    • generateInviteCode

      LabDetails generateInviteCode(String billingAccountName, String billingProfileName, String invoiceSectionName, InviteCodeGenerateRequest parameters)
      Generate invite code for a lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      parameters - Request parameters that are provided to generate invite code.
      Returns:
      lab 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.

    • generateInviteCodeWithResponse

      com.azure.core.http.rest.Response<LabDetails> generateInviteCodeWithResponse(String billingAccountName, String billingProfileName, String invoiceSectionName, InviteCodeGenerateRequest parameters, Boolean onlyUpdateStudentCountParameter, com.azure.core.util.Context context)
      Generate invite code for a lab.
      Parameters:
      billingAccountName - Billing account name.
      billingProfileName - Billing profile name.
      invoiceSectionName - Invoice section name.
      parameters - Request parameters that are provided to generate invite code.
      onlyUpdateStudentCountParameter - set this flag to true if you want to update student count without generating a new invite code.
      context - The context to associate with this operation.
      Returns:
      lab 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.