Package com.azure.resourcemanager.elasticsan.models

Interface Volumes

public interface Volumes
Resource collection API of Volumes.

  • Method Details

    • delete

      void delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)
      Delete an Volume.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      volumeName - The name of the Volume.
      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 elasticSanName, String volumeGroupName, String volumeName, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, DeleteType deleteType, com.azure.core.util.Context context)
      Delete an Volume.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      volumeName - The name of the Volume.
      xMsDeleteSnapshots - Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.
      xMsForceDelete - Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.
      deleteType - Optional. Specifies that the delete operation should be a permanent delete for the soft deleted volume. The value of deleteType can only be 'permanent'.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<Volume> getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, com.azure.core.util.Context context)
      Get an Volume.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      volumeName - The name of the Volume.
      context - The context to associate with this operation.
      Returns:
      an Volume 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

      Volume get(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)
      Get an Volume.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      volumeName - The name of the Volume.
      Returns:
      an Volume.
      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.

    • listByVolumeGroup

      com.azure.core.http.rest.PagedIterable<Volume> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)
      List Volumes in a VolumeGroup.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      Returns:
      list of Volumes 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.

    • listByVolumeGroup

      com.azure.core.http.rest.PagedIterable<Volume> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, XMsAccessSoftDeletedResources xMsAccessSoftDeletedResources, com.azure.core.util.Context context)
      List Volumes in a VolumeGroup.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      xMsAccessSoftDeletedResources - Optional, returns only soft deleted volumes if set to true. If set to false or if not specified, returns only active volumes.
      context - The context to associate with this operation.
      Returns:
      list of Volumes 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.

    • preBackup

      PreValidationResponse preBackup(String resourceGroupName, String elasticSanName, String volumeGroupName, VolumeNameList parameters)
      Validate whether a disk snapshot backup can be taken for list of volumes.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      parameters - Volume Name List (currently only one volume name in the list is supported. Server would return error if list is bigger).
      Returns:
      response object for pre validation api.
      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.

    • preBackup

      PreValidationResponse preBackup(String resourceGroupName, String elasticSanName, String volumeGroupName, VolumeNameList parameters, com.azure.core.util.Context context)
      Validate whether a disk snapshot backup can be taken for list of volumes.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      parameters - Volume Name List (currently only one volume name in the list is supported. Server would return error if list is bigger).
      context - The context to associate with this operation.
      Returns:
      response object for pre validation api.
      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.

    • preRestore

      PreValidationResponse preRestore(String resourceGroupName, String elasticSanName, String volumeGroupName, DiskSnapshotList parameters)
      Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      parameters - Disk Snapshot List (currently only one Disk Snapshot in the list is supported and that the Disk Snapshot must be in same azure region as the ElasticSan. Server would return error if list is bigger).
      Returns:
      response object for pre validation api.
      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.

    • preRestore

      PreValidationResponse preRestore(String resourceGroupName, String elasticSanName, String volumeGroupName, DiskSnapshotList parameters, com.azure.core.util.Context context)
      Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      elasticSanName - The name of the ElasticSan.
      volumeGroupName - The name of the VolumeGroup.
      parameters - Disk Snapshot List (currently only one Disk Snapshot in the list is supported and that the Disk Snapshot must be in same azure region as the ElasticSan. Server would return error if list is bigger).
      context - The context to associate with this operation.
      Returns:
      response object for pre validation api.
      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

      Volume getById(String id)
      Get an Volume.
      Parameters:
      id - the resource ID.
      Returns:
      an Volume 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<Volume> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get an Volume.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      an Volume 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 an Volume.
      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, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, DeleteType deleteType, com.azure.core.util.Context context)
      Delete an Volume.
      Parameters:
      id - the resource ID.
      xMsDeleteSnapshots - Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.
      xMsForceDelete - Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.
      deleteType - Optional. Specifies that the delete operation should be a permanent delete for the soft deleted volume. The value of deleteType can only be 'permanent'.
      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

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