Volumes interface

Reference

Package:: @azure/arm-netapp

Interface representing a Volumes.

Methods

beginAuthorizeExternalReplication(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)	Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created
beginAuthorizeExternalReplicationAndWait(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)	Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created
beginAuthorizeReplication(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)	Authorize the replication connection on the source volume
beginAuthorizeReplicationAndWait(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)	Authorize the replication connection on the source volume
beginBreakFileLocks(string, string, string, string, VolumesBreakFileLocksOptionalParams)	Break all the file locks on a volume
beginBreakFileLocksAndWait(string, string, string, string, VolumesBreakFileLocksOptionalParams)	Break all the file locks on a volume
beginBreakReplication(string, string, string, string, VolumesBreakReplicationOptionalParams)	Break the replication connection on the destination volume
beginBreakReplicationAndWait(string, string, string, string, VolumesBreakReplicationOptionalParams)	Break the replication connection on the destination volume
beginCreateOrUpdate(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)	Create or update the specified volume within the capacity pool
beginCreateOrUpdateAndWait(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)	Create or update the specified volume within the capacity pool
beginDelete(string, string, string, string, VolumesDeleteOptionalParams)	Delete the specified volume
beginDeleteAndWait(string, string, string, string, VolumesDeleteOptionalParams)	Delete the specified volume
beginDeleteReplication(string, string, string, string, VolumesDeleteReplicationOptionalParams)	Delete the replication connection on the destination volume, and send release to the source replication
beginDeleteReplicationAndWait(string, string, string, string, VolumesDeleteReplicationOptionalParams)	Delete the replication connection on the destination volume, and send release to the source replication
beginFinalizeExternalReplication(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)	Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
beginFinalizeExternalReplicationAndWait(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)	Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
beginFinalizeRelocation(string, string, string, string, VolumesFinalizeRelocationOptionalParams)	Finalizes the relocation of the volume and cleans up the old volume.
beginFinalizeRelocationAndWait(string, string, string, string, VolumesFinalizeRelocationOptionalParams)	Finalizes the relocation of the volume and cleans up the old volume.
beginListGetGroupIdListForLdapUser(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)	Returns the list of group Ids for a specific LDAP User
beginListGetGroupIdListForLdapUserAndWait(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)	Returns the list of group Ids for a specific LDAP User
beginPeerExternalCluster(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)	Starts peering the external cluster for this migration volume
beginPeerExternalClusterAndWait(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)	Starts peering the external cluster for this migration volume
beginPerformReplicationTransfer(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)	Performs an adhoc replication transfer on a volume with volumeType Migration
beginPerformReplicationTransferAndWait(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)	Performs an adhoc replication transfer on a volume with volumeType Migration
beginPoolChange(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)	Moves volume to another pool
beginPoolChangeAndWait(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)	Moves volume to another pool
beginPopulateAvailabilityZone(string, string, string, string, VolumesPopulateAvailabilityZoneOptionalParams)	This operation will populate availability zone information for a volume
beginPopulateAvailabilityZoneAndWait(string, string, string, string, VolumesPopulateAvailabilityZoneOptionalParams)	This operation will populate availability zone information for a volume
beginReestablishReplication(string, string, string, string, ReestablishReplicationRequest, VolumesReestablishReplicationOptionalParams)	Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
beginReestablishReplicationAndWait(string, string, string, string, ReestablishReplicationRequest, VolumesReestablishReplicationOptionalParams)	Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
beginReInitializeReplication(string, string, string, string, VolumesReInitializeReplicationOptionalParams)	Re-Initializes the replication connection on the destination volume
beginReInitializeReplicationAndWait(string, string, string, string, VolumesReInitializeReplicationOptionalParams)	Re-Initializes the replication connection on the destination volume
beginRelocate(string, string, string, string, VolumesRelocateOptionalParams)	Relocates volume to a new stamp
beginRelocateAndWait(string, string, string, string, VolumesRelocateOptionalParams)	Relocates volume to a new stamp
beginResetCifsPassword(string, string, string, string, VolumesResetCifsPasswordOptionalParams)	Reset cifs password from volume
beginResetCifsPasswordAndWait(string, string, string, string, VolumesResetCifsPasswordOptionalParams)	Reset cifs password from volume
beginResyncReplication(string, string, string, string, VolumesResyncReplicationOptionalParams)	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.
beginResyncReplicationAndWait(string, string, string, string, VolumesResyncReplicationOptionalParams)	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.
beginRevert(string, string, string, string, VolumeRevert, VolumesRevertOptionalParams)	Revert a volume to the snapshot specified in the body
beginRevertAndWait(string, string, string, string, VolumeRevert, VolumesRevertOptionalParams)	Revert a volume to the snapshot specified in the body
beginRevertRelocation(string, string, string, string, VolumesRevertRelocationOptionalParams)	Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.
beginRevertRelocationAndWait(string, string, string, string, VolumesRevertRelocationOptionalParams)	Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.
beginUpdate(string, string, string, string, VolumePatch, VolumesUpdateOptionalParams)	Patch the specified volume
beginUpdateAndWait(string, string, string, string, VolumePatch, VolumesUpdateOptionalParams)	Patch the specified volume
get(string, string, string, string, VolumesGetOptionalParams)	Get the details of the specified volume
list(string, string, string, VolumesListOptionalParams)	List all volumes within the capacity pool
listReplications(string, string, string, string, VolumesListReplicationsOptionalParams)	List all replications for a specified volume
replicationStatus(string, string, string, string, VolumesReplicationStatusOptionalParams)	Get the status of the replication

Method Details

beginAuthorizeExternalReplication(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)

Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created

function beginAuthorizeExternalReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesAuthorizeExternalReplicationOptionalParams): Promise<SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesAuthorizeExternalReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>

beginAuthorizeExternalReplicationAndWait(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)

Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created

function beginAuthorizeExternalReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesAuthorizeExternalReplicationOptionalParams): Promise<SvmPeerCommandResponse>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesAuthorizeExternalReplicationOptionalParams

The options parameters.

Returns

Promise<SvmPeerCommandResponse>

beginAuthorizeReplication(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)

Authorize the replication connection on the source volume

function beginAuthorizeReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: AuthorizeRequest, options?: VolumesAuthorizeReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: AuthorizeRequest

Authorize request object supplied in the body of the operation.

options: VolumesAuthorizeReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginAuthorizeReplicationAndWait(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)

Authorize the replication connection on the source volume

function beginAuthorizeReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: AuthorizeRequest, options?: VolumesAuthorizeReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: AuthorizeRequest

Authorize request object supplied in the body of the operation.

options: VolumesAuthorizeReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginBreakFileLocks(string, string, string, string, VolumesBreakFileLocksOptionalParams)

Break all the file locks on a volume

function beginBreakFileLocks(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakFileLocksOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesBreakFileLocksOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginBreakFileLocksAndWait(string, string, string, string, VolumesBreakFileLocksOptionalParams)

Break all the file locks on a volume

function beginBreakFileLocksAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakFileLocksOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesBreakFileLocksOptionalParams

The options parameters.

Returns

Promise<void>

beginBreakReplication(string, string, string, string, VolumesBreakReplicationOptionalParams)

Break the replication connection on the destination volume

function beginBreakReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesBreakReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginBreakReplicationAndWait(string, string, string, string, VolumesBreakReplicationOptionalParams)

Break the replication connection on the destination volume

function beginBreakReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesBreakReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)

Create or update the specified volume within the capacity pool

function beginCreateOrUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: Volume

Volume object supplied in the body of the operation.

options: VolumesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Volume>, Volume>>

beginCreateOrUpdateAndWait(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)

Create or update the specified volume within the capacity pool

function beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<Volume>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: Volume

Volume object supplied in the body of the operation.

options: VolumesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Volume>

beginDelete(string, string, string, string, VolumesDeleteOptionalParams)

Delete the specified volume

function beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, VolumesDeleteOptionalParams)

Delete the specified volume

function beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteReplication(string, string, string, string, VolumesDeleteReplicationOptionalParams)

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

function beginDeleteReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesDeleteReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteReplicationAndWait(string, string, string, string, VolumesDeleteReplicationOptionalParams)

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

function beginDeleteReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesDeleteReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginFinalizeExternalReplication(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)

Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.

function beginFinalizeExternalReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeExternalReplicationOptionalParams): Promise<SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesFinalizeExternalReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>

beginFinalizeExternalReplicationAndWait(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)

Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.

function beginFinalizeExternalReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeExternalReplicationOptionalParams): Promise<VolumesFinalizeExternalReplicationHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesFinalizeExternalReplicationOptionalParams

The options parameters.

Returns

Promise<VolumesFinalizeExternalReplicationHeaders>

beginFinalizeRelocation(string, string, string, string, VolumesFinalizeRelocationOptionalParams)

Finalizes the relocation of the volume and cleans up the old volume.

function beginFinalizeRelocation(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeRelocationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesFinalizeRelocationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginFinalizeRelocationAndWait(string, string, string, string, VolumesFinalizeRelocationOptionalParams)

Finalizes the relocation of the volume and cleans up the old volume.

function beginFinalizeRelocationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeRelocationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesFinalizeRelocationOptionalParams

The options parameters.

Returns

Promise<void>

beginListGetGroupIdListForLdapUser(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)

Returns the list of group Ids for a specific LDAP User

function beginListGetGroupIdListForLdapUser(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: GetGroupIdListForLdapUserRequest, options?: VolumesListGetGroupIdListForLdapUserOptionalParams): Promise<SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: GetGroupIdListForLdapUserRequest

Returns group Id list for a specific LDAP user

options: VolumesListGetGroupIdListForLdapUserOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>

beginListGetGroupIdListForLdapUserAndWait(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)

Returns the list of group Ids for a specific LDAP User

function beginListGetGroupIdListForLdapUserAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: GetGroupIdListForLdapUserRequest, options?: VolumesListGetGroupIdListForLdapUserOptionalParams): Promise<GetGroupIdListForLdapUserResponse>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: GetGroupIdListForLdapUserRequest

Returns group Id list for a specific LDAP user

options: VolumesListGetGroupIdListForLdapUserOptionalParams

The options parameters.

Returns

Promise<GetGroupIdListForLdapUserResponse>

beginPeerExternalCluster(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)

Starts peering the external cluster for this migration volume

function beginPeerExternalCluster(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PeerClusterForVolumeMigrationRequest, options?: VolumesPeerExternalClusterOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: PeerClusterForVolumeMigrationRequest

Cluster peer request object supplied in the body of the operation.

options: VolumesPeerExternalClusterOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>

beginPeerExternalClusterAndWait(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)

Starts peering the external cluster for this migration volume

function beginPeerExternalClusterAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PeerClusterForVolumeMigrationRequest, options?: VolumesPeerExternalClusterOptionalParams): Promise<ClusterPeerCommandResponse>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: PeerClusterForVolumeMigrationRequest

Cluster peer request object supplied in the body of the operation.

options: VolumesPeerExternalClusterOptionalParams

The options parameters.

Returns

Promise<ClusterPeerCommandResponse>

beginPerformReplicationTransfer(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)

Performs an adhoc replication transfer on a volume with volumeType Migration

function beginPerformReplicationTransfer(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPerformReplicationTransferOptionalParams): Promise<SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesPerformReplicationTransferOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>

beginPerformReplicationTransferAndWait(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)

Performs an adhoc replication transfer on a volume with volumeType Migration

function beginPerformReplicationTransferAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPerformReplicationTransferOptionalParams): Promise<VolumesPerformReplicationTransferHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesPerformReplicationTransferOptionalParams

The options parameters.

Returns

Promise<VolumesPerformReplicationTransferHeaders>

beginPoolChange(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)

Moves volume to another pool

function beginPoolChange(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PoolChangeRequest, options?: VolumesPoolChangeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: PoolChangeRequest

Move volume to the pool supplied in the body of the operation.

options: VolumesPoolChangeOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginPoolChangeAndWait(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)

Moves volume to another pool

function beginPoolChangeAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PoolChangeRequest, options?: VolumesPoolChangeOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: PoolChangeRequest

Move volume to the pool supplied in the body of the operation.

options: VolumesPoolChangeOptionalParams

The options parameters.

Returns

Promise<void>

beginPopulateAvailabilityZone(string, string, string, string, VolumesPopulateAvailabilityZoneOptionalParams)

This operation will populate availability zone information for a volume

function beginPopulateAvailabilityZone(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPopulateAvailabilityZoneOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesPopulateAvailabilityZoneOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Volume>, Volume>>

beginPopulateAvailabilityZoneAndWait(string, string, string, string, VolumesPopulateAvailabilityZoneOptionalParams)

This operation will populate availability zone information for a volume

function beginPopulateAvailabilityZoneAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPopulateAvailabilityZoneOptionalParams): Promise<Volume>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesPopulateAvailabilityZoneOptionalParams

The options parameters.

Returns

Promise<Volume>

beginReestablishReplication(string, string, string, string, ReestablishReplicationRequest, VolumesReestablishReplicationOptionalParams)

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots

function beginReestablishReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: ReestablishReplicationRequest, options?: VolumesReestablishReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: ReestablishReplicationRequest

body for the id of the source volume.

options: VolumesReestablishReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginReestablishReplicationAndWait(string, string, string, string, ReestablishReplicationRequest, VolumesReestablishReplicationOptionalParams)

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots

function beginReestablishReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: ReestablishReplicationRequest, options?: VolumesReestablishReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: ReestablishReplicationRequest

body for the id of the source volume.

options: VolumesReestablishReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginReInitializeReplication(string, string, string, string, VolumesReInitializeReplicationOptionalParams)

Re-Initializes the replication connection on the destination volume

function beginReInitializeReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReInitializeReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesReInitializeReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginReInitializeReplicationAndWait(string, string, string, string, VolumesReInitializeReplicationOptionalParams)

Re-Initializes the replication connection on the destination volume

function beginReInitializeReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReInitializeReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesReInitializeReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginRelocate(string, string, string, string, VolumesRelocateOptionalParams)

Relocates volume to a new stamp

function beginRelocate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRelocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesRelocateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRelocateAndWait(string, string, string, string, VolumesRelocateOptionalParams)

Relocates volume to a new stamp

function beginRelocateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRelocateOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesRelocateOptionalParams

The options parameters.

Returns

Promise<void>

beginResetCifsPassword(string, string, string, string, VolumesResetCifsPasswordOptionalParams)

Reset cifs password from volume

function beginResetCifsPassword(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResetCifsPasswordOptionalParams): Promise<SimplePollerLike<OperationState<VolumesResetCifsPasswordHeaders>, VolumesResetCifsPasswordHeaders>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesResetCifsPasswordOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VolumesResetCifsPasswordHeaders>, VolumesResetCifsPasswordHeaders>>

beginResetCifsPasswordAndWait(string, string, string, string, VolumesResetCifsPasswordOptionalParams)

Reset cifs password from volume

function beginResetCifsPasswordAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResetCifsPasswordOptionalParams): Promise<VolumesResetCifsPasswordHeaders>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesResetCifsPasswordOptionalParams

The options parameters.

Returns

Promise<VolumesResetCifsPasswordHeaders>

beginResyncReplication(string, string, string, string, VolumesResyncReplicationOptionalParams)

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.

function beginResyncReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResyncReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesResyncReplicationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginResyncReplicationAndWait(string, string, string, string, VolumesResyncReplicationOptionalParams)

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.

function beginResyncReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResyncReplicationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesResyncReplicationOptionalParams

The options parameters.

Returns

Promise<void>

beginRevert(string, string, string, string, VolumeRevert, VolumesRevertOptionalParams)

Revert a volume to the snapshot specified in the body

function beginRevert(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumeRevert, options?: VolumesRevertOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: VolumeRevert

Object for snapshot to revert supplied in the body of the operation.

options: VolumesRevertOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRevertAndWait(string, string, string, string, VolumeRevert, VolumesRevertOptionalParams)

Revert a volume to the snapshot specified in the body

function beginRevertAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumeRevert, options?: VolumesRevertOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: VolumeRevert

Object for snapshot to revert supplied in the body of the operation.

options: VolumesRevertOptionalParams

The options parameters.

Returns

Promise<void>

beginRevertRelocation(string, string, string, string, VolumesRevertRelocationOptionalParams)

Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

function beginRevertRelocation(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRevertRelocationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesRevertRelocationOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRevertRelocationAndWait(string, string, string, string, VolumesRevertRelocationOptionalParams)

Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

function beginRevertRelocationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRevertRelocationOptionalParams): Promise<void>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesRevertRelocationOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, VolumePatch, VolumesUpdateOptionalParams)

Patch the specified volume

function beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumePatch, options?: VolumesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: VolumePatch

Volume object supplied in the body of the operation.

options: VolumesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Volume>, Volume>>

beginUpdateAndWait(string, string, string, string, VolumePatch, VolumesUpdateOptionalParams)

Patch the specified volume

function beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumePatch, options?: VolumesUpdateOptionalParams): Promise<Volume>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

body: VolumePatch

Volume object supplied in the body of the operation.

options: VolumesUpdateOptionalParams

The options parameters.

Returns

Promise<Volume>

get(string, string, string, string, VolumesGetOptionalParams)

Get the details of the specified volume

function get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesGetOptionalParams): Promise<Volume>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesGetOptionalParams

The options parameters.

Returns

Promise<Volume>

list(string, string, string, VolumesListOptionalParams)

List all volumes within the capacity pool

function list(resourceGroupName: string, accountName: string, poolName: string, options?: VolumesListOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

options: VolumesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

listReplications(string, string, string, string, VolumesListReplicationsOptionalParams)

List all replications for a specified volume

function listReplications(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesListReplicationsOptionalParams): PagedAsyncIterableIterator<Replication, Replication[], PageSettings>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesListReplicationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Replication, Replication[], PageSettings>

replicationStatus(string, string, string, string, VolumesReplicationStatusOptionalParams)

Get the status of the replication

function replicationStatus(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReplicationStatusOptionalParams): Promise<ReplicationStatus>

Parameters

resourceGroupName: string

The name of the resource group. The name is case insensitive.

accountName: string

The name of the NetApp account

poolName: string

The name of the capacity pool

volumeName: string

The name of the volume

options: VolumesReplicationStatusOptionalParams

The options parameters.

Returns

Promise<ReplicationStatus>

Share via

Volumes interface

Methods

Method Details

beginAuthorizeExternalReplication(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)

Parameters

Returns

beginAuthorizeExternalReplicationAndWait(string, string, string, string, VolumesAuthorizeExternalReplicationOptionalParams)

Parameters

Returns

beginAuthorizeReplication(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)

Parameters

Returns

beginAuthorizeReplicationAndWait(string, string, string, string, AuthorizeRequest, VolumesAuthorizeReplicationOptionalParams)

Parameters

Returns

beginBreakFileLocks(string, string, string, string, VolumesBreakFileLocksOptionalParams)

Parameters

Returns

beginBreakFileLocksAndWait(string, string, string, string, VolumesBreakFileLocksOptionalParams)

Parameters

Returns

beginBreakReplication(string, string, string, string, VolumesBreakReplicationOptionalParams)

Parameters

Returns

beginBreakReplicationAndWait(string, string, string, string, VolumesBreakReplicationOptionalParams)

Parameters

Returns

beginCreateOrUpdate(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)

Parameters

Returns

beginCreateOrUpdateAndWait(string, string, string, string, Volume, VolumesCreateOrUpdateOptionalParams)

Parameters

Returns

beginDelete(string, string, string, string, VolumesDeleteOptionalParams)

Parameters

Returns

beginDeleteAndWait(string, string, string, string, VolumesDeleteOptionalParams)

Parameters

Returns

beginDeleteReplication(string, string, string, string, VolumesDeleteReplicationOptionalParams)

Parameters

Returns

beginDeleteReplicationAndWait(string, string, string, string, VolumesDeleteReplicationOptionalParams)

Parameters

Returns

beginFinalizeExternalReplication(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)

Parameters

Returns

beginFinalizeExternalReplicationAndWait(string, string, string, string, VolumesFinalizeExternalReplicationOptionalParams)

Parameters

Returns

beginFinalizeRelocation(string, string, string, string, VolumesFinalizeRelocationOptionalParams)

Parameters

Returns

beginFinalizeRelocationAndWait(string, string, string, string, VolumesFinalizeRelocationOptionalParams)

Parameters

Returns

beginListGetGroupIdListForLdapUser(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)

Parameters

Returns

beginListGetGroupIdListForLdapUserAndWait(string, string, string, string, GetGroupIdListForLdapUserRequest, VolumesListGetGroupIdListForLdapUserOptionalParams)

Parameters

Returns

beginPeerExternalCluster(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)

Parameters

Returns

beginPeerExternalClusterAndWait(string, string, string, string, PeerClusterForVolumeMigrationRequest, VolumesPeerExternalClusterOptionalParams)

Parameters

Returns

beginPerformReplicationTransfer(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)

Parameters

Returns

beginPerformReplicationTransferAndWait(string, string, string, string, VolumesPerformReplicationTransferOptionalParams)

Parameters

Returns

beginPoolChange(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)

Parameters

Returns

beginPoolChangeAndWait(string, string, string, string, PoolChangeRequest, VolumesPoolChangeOptionalParams)