Interface Snapshots


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

    • list

      com.azure.core.http.rest.PagedIterable<Snapshot> list(String resourceGroupName, String accountName, String poolName, String volumeName)
      Describe all snapshots

      List all snapshots associated with the volume.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      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.
    • list

      com.azure.core.http.rest.PagedIterable<Snapshot> list(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)
      Describe all snapshots

      List all snapshots associated with the volume.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the 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.
    • get

      Snapshot get(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName)
      Describe a snapshot

      Get details of the specified snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      Returns:
      details of the specified 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.
    • getWithResponse

      com.azure.core.http.rest.Response<Snapshot> getWithResponse(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, com.azure.core.util.Context context)
      Describe a snapshot

      Get details of the specified snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      context - The context to associate with this operation.
      Returns:
      details of the specified 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.
    • update

      Snapshot update(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, Object body)
      Update a snapshot

      Patch a snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      body - Snapshot object supplied in the body of the operation.
      Returns:
      snapshot of a 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.
    • update

      Snapshot update(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, Object body, com.azure.core.util.Context context)
      Update a snapshot

      Patch a snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      body - Snapshot object supplied in the body of the operation.
      context - The context to associate with this operation.
      Returns:
      snapshot of a 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 accountName, String poolName, String volumeName, String snapshotName)
      Delete a snapshot

      Delete snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the 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.
    • delete

      void delete(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, com.azure.core.util.Context context)
      Delete a snapshot

      Delete snapshot.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      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.
    • restoreFiles

      void restoreFiles(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, SnapshotRestoreFiles body)
      Create a new Snapshot Restore Files request

      Restore the specified files from the specified snapshot to the active filesystem.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      body - Restore payload supplied in the body of the 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.
    • restoreFiles

      void restoreFiles(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, SnapshotRestoreFiles body, com.azure.core.util.Context context)
      Create a new Snapshot Restore Files request

      Restore the specified files from the specified snapshot to the active filesystem.

      Parameters:
      resourceGroupName - The name of the resource group.
      accountName - The name of the NetApp account.
      poolName - The name of the capacity pool.
      volumeName - The name of the volume.
      snapshotName - The name of the snapshot.
      body - Restore payload supplied in the body of the operation.
      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

      Snapshot getById(String id)
      Describe a snapshot

      Get details of the specified snapshot.

      Parameters:
      id - the resource ID.
      Returns:
      details of the specified 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)
      Describe a snapshot

      Get details of the specified snapshot.

      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      details of the specified 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 snapshot

      Delete 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 snapshot

      Delete 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

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