Package com.azure.resourcemanager.elasticsan.models

Interface VolumeSnapshots

public interface VolumeSnapshots
Resource collection API of VolumeSnapshots.

  • Method Details

    • listByVolumeGroup

      com.azure.core.http.rest.PagedIterable<Snapshot> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)
      List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter.
      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 Snapshots 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<Snapshot> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, String filter, com.azure.core.util.Context context)
      List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter.
      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.
      filter - Specify $filter='volumeName eq <volume name>' to filter on volume.
      context - The context to associate with this operation.
      Returns:
      list of Snapshots 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.

    • delete

      void delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String snapshotName)
      Delete a Volume Snapshot.
      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.
      snapshotName - The name of the volume snapshot within the given volume group.
      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 snapshotName, com.azure.core.util.Context context)
      Delete a Volume Snapshot.
      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.
      snapshotName - The name of the volume snapshot within the given volume group.
      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<Snapshot> getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String snapshotName, com.azure.core.util.Context context)
      Get a Volume Snapshot.
      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.
      snapshotName - The name of the volume snapshot within the given volume group.
      context - The context to associate with this operation.
      Returns:
      a Volume Snapshot 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

      Snapshot get(String resourceGroupName, String elasticSanName, String volumeGroupName, String snapshotName)
      Get a Volume Snapshot.
      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.
      snapshotName - The name of the volume snapshot within the given volume group.
      Returns:
      a Volume Snapshot.
      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

      Snapshot getById(String id)
      Get a Volume Snapshot.
      Parameters:
      id - the resource ID.
      Returns:
      a Volume Snapshot 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<Snapshot> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get a Volume Snapshot.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a Volume Snapshot 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 Volume Snapshot.
      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 Volume Snapshot.
      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

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