Package com.azure.resourcemanager.netapp.models

Interface Volumes

public interface Volumes

Resource collection API of Volumes.

Method Summary

Modifier and Type	Method	Description
void	authorizeReplication(String resourceGroupName, String accountName, String poolName, String volumeName, AuthorizeRequest body)	Authorize the replication connection on the source volume.
void	authorizeReplication(String resourceGroupName, String accountName, String poolName, String volumeName, AuthorizeRequest body, com.azure.core.util.Context context)	Authorize the replication connection on the source volume.
void	breakReplication(String resourceGroupName, String accountName, String poolName, String volumeName)	Break the replication connection on the destination volume.
void	breakReplication(String resourceGroupName, String accountName, String poolName, String volumeName, BreakReplicationRequest body)	Break the replication connection on the destination volume.
void	breakReplication(String resourceGroupName, String accountName, String poolName, String volumeName, BreakReplicationRequest body, com.azure.core.util.Context context)	Break the replication connection on the destination volume.
Volume.DefinitionStages.Blank	define(String name)	Begins definition for a new Volume resource.
void	delete(String resourceGroupName, String accountName, String poolName, String volumeName)	Delete the specified volume.
void	delete(String resourceGroupName, String accountName, String poolName, String volumeName, Boolean forceDelete)	Delete the specified volume.
void	delete(String resourceGroupName, String accountName, String poolName, String volumeName, Boolean forceDelete, com.azure.core.util.Context context)	Delete the specified volume.
void	deleteById(String id)	Delete the specified volume.
void	deleteByIdWithResponse(String id, Boolean forceDelete, com.azure.core.util.Context context)	Delete the specified volume.
void	deleteReplication(String resourceGroupName, String accountName, String poolName, String volumeName)	Delete the replication connection on the destination volume, and send release to the source replication.
void	deleteReplication(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	Delete the replication connection on the destination volume, and send release to the source replication.
Volume	get(String resourceGroupName, String accountName, String poolName, String volumeName)	Get the details of the specified volume.
Volume	getById(String id)	Get the details of the specified volume.
com.azure.core.http.rest.Response<Volume>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the details of the specified volume.
com.azure.core.http.rest.Response<Volume>	getWithResponse(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	Get the details of the specified volume.
com.azure.core.http.rest.PagedIterable<Volume>	list(String resourceGroupName, String accountName, String poolName)	List all volumes within the capacity pool.
com.azure.core.http.rest.PagedIterable<Volume>	list(String resourceGroupName, String accountName, String poolName, com.azure.core.util.Context context)	List all volumes within the capacity pool.
void	poolChange(String resourceGroupName, String accountName, String poolName, String volumeName, PoolChangeRequest body)	Moves volume to another pool.
void	poolChange(String resourceGroupName, String accountName, String poolName, String volumeName, PoolChangeRequest body, com.azure.core.util.Context context)	Moves volume to another pool.
void	reInitializeReplication(String resourceGroupName, String accountName, String poolName, String volumeName)	Re-Initializes the replication connection on the destination volume.
void	reInitializeReplication(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	Re-Initializes the replication connection on the destination volume.
ReplicationStatus	replicationStatus(String resourceGroupName, String accountName, String poolName, String volumeName)	Get the status of the replication.
com.azure.core.http.rest.Response<ReplicationStatus>	replicationStatusWithResponse(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	Get the status of the replication.
void	resyncReplication(String resourceGroupName, String accountName, String poolName, String volumeName)	Resync the connection on the destination volume.
void	resyncReplication(String resourceGroupName, String accountName, String poolName, String volumeName, com.azure.core.util.Context context)	Resync the connection on the destination volume.
void	revert(String resourceGroupName, String accountName, String poolName, String volumeName, VolumeRevert body)	Revert a volume to the snapshot specified in the body.
void	revert(String resourceGroupName, String accountName, String poolName, String volumeName, VolumeRevert body, com.azure.core.util.Context context)	Revert a volume to the snapshot specified in the body.

Method Detail

list

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

List all volumes within the capacity pool.

Parameters:

resourceGroupName - The name of the resource group.

accountName - The name of the NetApp account.

poolName - The name of the capacity pool.

Returns:

list of volume resources 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<Volume> list(String resourceGroupName,
                                                    String accountName,
                                                    String poolName,
                                                    com.azure.core.util.Context context)

List all volumes within the capacity pool.

Parameters:

resourceGroupName - The name of the resource group.

accountName - The name of the NetApp account.

poolName - The name of the capacity pool.

context - The context to associate with this operation.

Returns:

list of volume resources 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

Volume get(String resourceGroupName,
           String accountName,
           String poolName,
           String volumeName)

Get the details of the specified 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:

the details of the specified 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.

getWithResponse

com.azure.core.http.rest.Response<Volume> getWithResponse(String resourceGroupName,
                                                          String accountName,
                                                          String poolName,
                                                          String volumeName,
                                                          com.azure.core.util.Context context)

Get the details of the specified 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:

the details of the specified 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.

delete

void delete(String resourceGroupName,
            String accountName,
            String poolName,
            String volumeName,
            Boolean forceDelete)

Delete the specified 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.

forceDelete - An option to force delete the volume. Will cleanup resources connected to the particular 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)

Delete the specified 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.

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,
            Boolean forceDelete,
            com.azure.core.util.Context context)

Delete the specified 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.

forceDelete - An option to force delete the volume. Will cleanup resources connected to the particular volume.

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.

revert

void revert(String resourceGroupName,
            String accountName,
            String poolName,
            String volumeName,
            VolumeRevert body)

Revert a volume to the snapshot specified in the body.

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.

body - Object for snapshot to revert 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.

revert

void revert(String resourceGroupName,
            String accountName,
            String poolName,
            String volumeName,
            VolumeRevert body,
            com.azure.core.util.Context context)

Revert a volume to the snapshot specified in the body.

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.

body - Object for snapshot to revert 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.

breakReplication

void breakReplication(String resourceGroupName,
                      String accountName,
                      String poolName,
                      String volumeName,
                      BreakReplicationRequest body)

Break the replication connection on the destination 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.

body - Optional body to force break the replication.

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.

breakReplication

void breakReplication(String resourceGroupName,
                      String accountName,
                      String poolName,
                      String volumeName)

Break the replication connection on the destination 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.

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.

breakReplication

void breakReplication(String resourceGroupName,
                      String accountName,
                      String poolName,
                      String volumeName,
                      BreakReplicationRequest body,
                      com.azure.core.util.Context context)

Break the replication connection on the destination 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.

body - Optional body to force break the replication.

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.

replicationStatus

ReplicationStatus replicationStatus(String resourceGroupName,
                                    String accountName,
                                    String poolName,
                                    String volumeName)

Get the status of the replication.

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:

the status of the replication.

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.

replicationStatusWithResponse

com.azure.core.http.rest.Response<ReplicationStatus> replicationStatusWithResponse(String resourceGroupName,
                                                                                   String accountName,
                                                                                   String poolName,
                                                                                   String volumeName,
                                                                                   com.azure.core.util.Context context)

Get the status of the replication.

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:

the status of the replication 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.

resyncReplication

void resyncReplication(String resourceGroupName,
                       String accountName,
                       String poolName,
                       String volumeName)

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

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.

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.

resyncReplication

void resyncReplication(String resourceGroupName,
                       String accountName,
                       String poolName,
                       String volumeName,
                       com.azure.core.util.Context context)

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

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.

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.

deleteReplication

void deleteReplication(String resourceGroupName,
                       String accountName,
                       String poolName,
                       String volumeName)

Delete the replication connection on the destination volume, and send release to the source replication.

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.

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.

deleteReplication

void deleteReplication(String resourceGroupName,
                       String accountName,
                       String poolName,
                       String volumeName,
                       com.azure.core.util.Context context)

Delete the replication connection on the destination volume, and send release to the source replication.

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.

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.

authorizeReplication

void authorizeReplication(String resourceGroupName,
                          String accountName,
                          String poolName,
                          String volumeName,
                          AuthorizeRequest body)

Authorize the replication connection on the source 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.

body - Authorize request object 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.

authorizeReplication

void authorizeReplication(String resourceGroupName,
                          String accountName,
                          String poolName,
                          String volumeName,
                          AuthorizeRequest body,
                          com.azure.core.util.Context context)

Authorize the replication connection on the source 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.

body - Authorize request object 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.

reInitializeReplication

void reInitializeReplication(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName)

Re-Initializes the replication connection on the destination 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.

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.

reInitializeReplication

void reInitializeReplication(String resourceGroupName,
                             String accountName,
                             String poolName,
                             String volumeName,
                             com.azure.core.util.Context context)

Re-Initializes the replication connection on the destination 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.

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.

poolChange

void poolChange(String resourceGroupName,
                String accountName,
                String poolName,
                String volumeName,
                PoolChangeRequest body)

Moves volume to another pool.

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.

body - Move volume to the pool 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.

poolChange

void poolChange(String resourceGroupName,
                String accountName,
                String poolName,
                String volumeName,
                PoolChangeRequest body,
                com.azure.core.util.Context context)

Moves volume to another pool.

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.

body - Move volume to the pool 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

Volume getById(String id)

Get the details of the specified volume.

Parameters:

id - the resource ID.

Returns:

the details of the specified 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 the details of the specified volume.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the specified 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 the specified 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,
                            Boolean forceDelete,
                            com.azure.core.util.Context context)

Delete the specified volume.

Parameters:

id - the resource ID.

forceDelete - An option to force delete the volume. Will cleanup resources connected to the particular volume.

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.