Interface DiskPools


public interface DiskPools
Resource collection API of DiskPools.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<DiskPool> list()
      Gets a list of Disk Pools in a subscription.
      Returns:
      a list of Disk Pools in a subscription as paginated response with PagedIterable.
      Throws:
      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<DiskPool> list(com.azure.core.util.Context context)
      Gets a list of Disk Pools in a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      a list of Disk Pools in a subscription 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DiskPool> listByResourceGroup(String resourceGroupName)
      Gets a list of DiskPools in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      a list of DiskPools in a resource group 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<DiskPool> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Gets a list of DiskPools in a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      context - The context to associate with this operation.
      Returns:
      a list of DiskPools in a resource group 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.
    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String diskPoolName)
      Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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 diskPoolName, com.azure.core.util.Context context)
      Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<DiskPool> getByResourceGroupWithResponse(String resourceGroupName, String diskPoolName, com.azure.core.util.Context context)
      Get a Disk pool.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      context - The context to associate with this operation.
      Returns:
      a Disk pool 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.
    • getByResourceGroup

      DiskPool getByResourceGroup(String resourceGroupName, String diskPoolName)
      Get a Disk pool.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      Returns:
      a Disk pool.
      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.
    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpoint> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String diskPoolName)
      Gets the network endpoints of all outbound dependencies of a Disk Pool.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      Returns:
      the network endpoints of all outbound dependencies of a Disk Pool 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.
    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpoint> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String diskPoolName, com.azure.core.util.Context context)
      Gets the network endpoints of all outbound dependencies of a Disk Pool.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      context - The context to associate with this operation.
      Returns:
      the network endpoints of all outbound dependencies of a Disk Pool 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.
    • start

      void start(String resourceGroupName, String diskPoolName)
      The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • start

      void start(String resourceGroupName, String diskPoolName, com.azure.core.util.Context context)
      The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • deallocate

      void deallocate(String resourceGroupName, String diskPoolName)
      Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • deallocate

      void deallocate(String resourceGroupName, String diskPoolName, com.azure.core.util.Context context)
      Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • upgrade

      void upgrade(String resourceGroupName, String diskPoolName)
      Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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.
    • upgrade

      void upgrade(String resourceGroupName, String diskPoolName, com.azure.core.util.Context context)
      Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      diskPoolName - The name of the Disk Pool.
      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

      DiskPool getById(String id)
      Get a Disk pool.
      Parameters:
      id - the resource ID.
      Returns:
      a Disk pool 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<DiskPool> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get a Disk pool.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a Disk pool 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 a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
      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 a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.
      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

      Begins definition for a new DiskPool resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new DiskPool definition.