Package com.azure.resourcemanager.elasticsan.fluent

Interface VolumesClient

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

  • Method Details

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VolumeInner>,VolumeInner> beginCreate(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeInner parameters)
      Create a 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.
      parameters - Volume object.
      Returns:
      the SyncPoller for polling of response for Volume request.
      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.

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VolumeInner>,VolumeInner> beginCreate(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeInner parameters, com.azure.core.util.Context context)
      Create a 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.
      parameters - Volume object.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of response for Volume request.
      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.

    • create

      VolumeInner create(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeInner parameters)
      Create a 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.
      parameters - Volume object.
      Returns:
      response for Volume request.
      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.

    • create

      VolumeInner create(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeInner parameters, com.azure.core.util.Context context)
      Create a 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.
      parameters - Volume object.
      context - The context to associate with this operation.
      Returns:
      response for Volume request.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VolumeInner>,VolumeInner> beginUpdate(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeUpdate parameters)
      Update 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.
      parameters - Volume object.
      Returns:
      the SyncPoller for polling of response for Volume request.
      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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VolumeInner>,VolumeInner> beginUpdate(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeUpdate parameters, com.azure.core.util.Context context)
      Update 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.
      parameters - Volume object.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of response for Volume request.
      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.

    • update

      VolumeInner update(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeUpdate parameters)
      Update 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.
      parameters - Volume object.
      Returns:
      response for Volume request.
      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.

    • update

      VolumeInner update(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, VolumeUpdate parameters, com.azure.core.util.Context context)
      Update 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.
      parameters - Volume object.
      context - The context to associate with this operation.
      Returns:
      response for Volume request.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.
      Returns:
      the SyncPoller for polling of long-running 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.

    • 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<VolumeInner> 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

      VolumeInner 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<VolumeInner> 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<VolumeInner> 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.

    • beginPreBackup

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PreValidationResponseInner>,PreValidationResponseInner> beginPreBackup(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:
      the SyncPoller for polling of 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.

    • beginPreBackup

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PreValidationResponseInner>,PreValidationResponseInner> beginPreBackup(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:
      the SyncPoller for polling of 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

      PreValidationResponseInner 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

      PreValidationResponseInner 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.

    • beginPreRestore

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PreValidationResponseInner>,PreValidationResponseInner> beginPreRestore(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:
      the SyncPoller for polling of 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.

    • beginPreRestore

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PreValidationResponseInner>,PreValidationResponseInner> beginPreRestore(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:
      the SyncPoller for polling of 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

      PreValidationResponseInner 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

      PreValidationResponseInner 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.