Package com.azure.resourcemanager.netapp.models

Interface Snapshots

public interface Snapshots

Resource collection API of Snapshots.

Method Summary

Modifier and Type	Method	Description
Snapshot.DefinitionStages.Blank	define(String name)	Begins definition for a new Snapshot resource.
void	delete(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName)	Delete snapshot.
void	delete(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, com.azure.core.util.Context context)	Delete snapshot.
void	deleteById(String id)	Delete snapshot.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete snapshot.
Snapshot	get(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName)	Get details of the specified snapshot.
Snapshot	getById(String id)	Get details of the specified snapshot.
com.azure.core.http.rest.Response<Snapshot>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get details of the specified snapshot.
com.azure.core.http.rest.Response<Snapshot>	getWithResponse(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, com.azure.core.util.Context context)	Get details of the specified snapshot.
com.azure.core.http.rest.PagedIterable<Snapshot>	list(String resourceGroupName, String accountName, String poolName, String volumeName)	List all snapshots associated with the volume.
com.azure.core.http.rest.PagedIterable<Snapshot>	list(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	List all snapshots associated with the volume.
void	restoreFiles(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, SnapshotRestoreFiles body)	Restore the specified files from the specified snapshot to the active filesystem.
void	restoreFiles(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, SnapshotRestoreFiles body, com.azure.core.util.Context context)	Restore the specified files from the specified snapshot to the active filesystem.
Snapshot	update(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, Object body)	Patch a snapshot.
Snapshot	update(String resourceGroupName, String accountName, String poolName, String volumeName, String snapshotName, Object body, com.azure.core.util.Context context)	Patch a snapshot.

Method Detail

list

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

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)

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)

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)

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)

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)

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 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 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)

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)

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)

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)

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