Package com.azure.resourcemanager.devtestlabs.models

Interface Disks

public interface Disks
Resource collection API of Disks.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Disk> list(String resourceGroupName, String labName, String username)
      List disks in a given user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      Returns:
      the response of a list operation 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<Disk> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context)
      List disks in a given user profile.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      expand - Specify the $expand query. Example: 'properties($select=diskType)'.
      filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
      context - The context to associate with this operation.
      Returns:
      the response of a list operation 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<Disk> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context)
      Get disk.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      expand - Specify the $expand query. Example: 'properties($select=diskType)'.
      context - The context to associate with this operation.
      Returns:
      disk 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

      Disk get(String resourceGroupName, String labName, String username, String name)
      Get disk.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      Returns:
      disk.
      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 resourceGroupName, String labName, String username, String name)
      Delete disk. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      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 resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context)
      Delete disk. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      context - The context to associate with this operation.
      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.

    • attach

      void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties)
      Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      attachDiskProperties - Properties of the disk to attach.
      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.

    • attach

      void attach(String resourceGroupName, String labName, String username, String name, AttachDiskProperties attachDiskProperties, com.azure.core.util.Context context)
      Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      attachDiskProperties - Properties of the disk to attach.
      context - The context to associate with this operation.
      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.

    • detach

      void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties)
      Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      detachDiskProperties - Properties of the disk to detach.
      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.

    • detach

      void detach(String resourceGroupName, String labName, String username, String name, DetachDiskProperties detachDiskProperties, com.azure.core.util.Context context)
      Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.
      Parameters:
      resourceGroupName - The name of the resource group.
      labName - The name of the lab.
      username - The name of the user profile.
      name - The name of the disk.
      detachDiskProperties - Properties of the disk to detach.
      context - The context to associate with this operation.
      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.

    • getById

      Disk getById(String id)
      Get disk.
      Parameters:
      id - the resource ID.
      Returns:
      disk 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Disk> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context)
      Get disk.
      Parameters:
      id - the resource ID.
      expand - Specify the $expand query. Example: 'properties($select=diskType)'.
      context - The context to associate with this operation.
      Returns:
      disk 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.

    • deleteById

      void deleteById(String id)
      Delete disk. This operation can take a while to complete.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete disk. This operation can take a while to complete.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      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.

    • define

      Disk.DefinitionStages.Blank define(String name)
      Begins definition for a new Disk resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Disk definition.