Package version:

Interface Volumes

Interface representing a Volumes.

interface Volumes {
    beginAuthorizeExternalReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesAuthorizeExternalReplicationOptionalParams): Promise<SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>;
    beginAuthorizeExternalReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesAuthorizeExternalReplicationOptionalParams): Promise<SvmPeerCommandResponse>;
    beginAuthorizeReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: AuthorizeRequest, options?: VolumesAuthorizeReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginAuthorizeReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: AuthorizeRequest, options?: VolumesAuthorizeReplicationOptionalParams): Promise<void>;
    beginBreakFileLocks(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakFileLocksOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginBreakFileLocksAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakFileLocksOptionalParams): Promise<void>;
    beginBreakReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginBreakReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesBreakReplicationOptionalParams): Promise<void>;
    beginCreateOrUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>;
    beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: Volume, options?: VolumesCreateOrUpdateOptionalParams): Promise<Volume>;
    beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteOptionalParams): Promise<void>;
    beginDeleteReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesDeleteReplicationOptionalParams): Promise<void>;
    beginFinalizeExternalReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeExternalReplicationOptionalParams): Promise<SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>;
    beginFinalizeExternalReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeExternalReplicationOptionalParams): Promise<VolumesFinalizeExternalReplicationHeaders>;
    beginFinalizeRelocation(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeRelocationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginFinalizeRelocationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesFinalizeRelocationOptionalParams): Promise<void>;
    beginListGetGroupIdListForLdapUser(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: GetGroupIdListForLdapUserRequest, options?: VolumesListGetGroupIdListForLdapUserOptionalParams): Promise<SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>;
    beginListGetGroupIdListForLdapUserAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: GetGroupIdListForLdapUserRequest, options?: VolumesListGetGroupIdListForLdapUserOptionalParams): Promise<GetGroupIdListForLdapUserResponse>;
    beginPeerExternalCluster(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PeerClusterForVolumeMigrationRequest, options?: VolumesPeerExternalClusterOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>;
    beginPeerExternalClusterAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PeerClusterForVolumeMigrationRequest, options?: VolumesPeerExternalClusterOptionalParams): Promise<ClusterPeerCommandResponse>;
    beginPerformReplicationTransfer(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPerformReplicationTransferOptionalParams): Promise<SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>;
    beginPerformReplicationTransferAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPerformReplicationTransferOptionalParams): Promise<VolumesPerformReplicationTransferHeaders>;
    beginPoolChange(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PoolChangeRequest, options?: VolumesPoolChangeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPoolChangeAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: PoolChangeRequest, options?: VolumesPoolChangeOptionalParams): Promise<void>;
    beginPopulateAvailabilityZone(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPopulateAvailabilityZoneOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>;
    beginPopulateAvailabilityZoneAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesPopulateAvailabilityZoneOptionalParams): Promise<Volume>;
    beginReestablishReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: ReestablishReplicationRequest, options?: VolumesReestablishReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReestablishReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: ReestablishReplicationRequest, options?: VolumesReestablishReplicationOptionalParams): Promise<void>;
    beginReInitializeReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReInitializeReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginReInitializeReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReInitializeReplicationOptionalParams): Promise<void>;
    beginRelocate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRelocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRelocateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRelocateOptionalParams): Promise<void>;
    beginResetCifsPassword(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResetCifsPasswordOptionalParams): Promise<SimplePollerLike<OperationState<VolumesResetCifsPasswordHeaders>, VolumesResetCifsPasswordHeaders>>;
    beginResetCifsPasswordAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResetCifsPasswordOptionalParams): Promise<VolumesResetCifsPasswordHeaders>;
    beginResyncReplication(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResyncReplicationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginResyncReplicationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesResyncReplicationOptionalParams): Promise<void>;
    beginRevert(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumeRevert, options?: VolumesRevertOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRevertAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumeRevert, options?: VolumesRevertOptionalParams): Promise<void>;
    beginRevertRelocation(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRevertRelocationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRevertRelocationAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesRevertRelocationOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumePatch, options?: VolumesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>;
    beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, body: VolumePatch, options?: VolumesUpdateOptionalParams): Promise<Volume>;
    get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesGetOptionalParams): Promise<Volume>;
    list(resourceGroupName: string, accountName: string, poolName: string, options?: VolumesListOptionalParams): PagedAsyncIterableIterator<Volume>;
    listReplications(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesListReplicationsOptionalParams): PagedAsyncIterableIterator<Replication>;
    replicationStatus(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: VolumesReplicationStatusOptionalParams): Promise<ReplicationStatus>;
}

Index

Methods

Methods

beginAuthorizeExternalReplication

beginAuthorizeExternalReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>
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
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
- Optionaloptions: VolumesAuthorizeExternalReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>
- Defined in operationsInterfaces/volumes.ts:644

beginAuthorizeExternalReplicationAndWait

beginAuthorizeExternalReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SvmPeerCommandResponse>
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
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
- Optionaloptions: VolumesAuthorizeExternalReplicationOptionalParams
  The options parameters.
Returns Promise<SvmPeerCommandResponse>
- Defined in operationsInterfaces/volumes.ts:665

beginAuthorizeReplication

beginAuthorizeReplication(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Authorize the replication connection on the source 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: AuthorizeRequest
  Authorize request object supplied in the body of the operation.
- Optionaloptions: VolumesAuthorizeReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:541

beginAuthorizeReplicationAndWait

beginAuthorizeReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<void>
Authorize the replication connection on the source 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: AuthorizeRequest
  Authorize request object supplied in the body of the operation.
- Optionaloptions: VolumesAuthorizeReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:558

beginBreakFileLocks

beginBreakFileLocks(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Break all the file locks on a 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
- Optionaloptions: VolumesBreakFileLocksOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:326

beginBreakFileLocksAndWait

beginBreakFileLocksAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Break all the file locks on a 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
- Optionaloptions: VolumesBreakFileLocksOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:341

beginBreakReplication

beginBreakReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Break the replication connection on the destination 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
- Optionaloptions: VolumesBreakReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:395

beginBreakReplicationAndWait

beginBreakReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Break the replication connection on the destination 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
- Optionaloptions: VolumesBreakReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:410

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<Volume>, Volume>>
Create or update the specified volume within the capacity pool
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.
- Optionaloptions: VolumesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Volume>, Volume>>
- Defined in operationsInterfaces/volumes.ts:115

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<Volume>
Create or update the specified volume within the capacity pool
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.
- Optionaloptions: VolumesCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:137

beginDelete

beginDelete(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete the specified 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
- Optionaloptions: VolumesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:192

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Delete the specified 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
- Optionaloptions: VolumesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:207

beginDeleteReplication

beginDeleteReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete the replication connection on the destination volume, and send release to the source replication
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
- Optionaloptions: VolumesDeleteReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:509

beginDeleteReplicationAndWait

beginDeleteReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Delete the replication connection on the destination volume, and send release to the source replication
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
- Optionaloptions: VolumesDeleteReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:525

beginFinalizeExternalReplication

beginFinalizeExternalReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>
Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
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
- Optionaloptions: VolumesFinalizeExternalReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>
- Defined in operationsInterfaces/volumes.ts:681

beginFinalizeExternalReplicationAndWait

beginFinalizeExternalReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<VolumesFinalizeExternalReplicationHeaders>
Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
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
- Optionaloptions: VolumesFinalizeExternalReplicationOptionalParams
  The options parameters.
Returns Promise<VolumesFinalizeExternalReplicationHeaders>
- Defined in operationsInterfaces/volumes.ts:702

beginFinalizeRelocation

beginFinalizeRelocation(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Finalizes the relocation of the volume and cleans up the old 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
- Optionaloptions: VolumesFinalizeRelocationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:816

beginFinalizeRelocationAndWait

beginFinalizeRelocationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Finalizes the relocation of the volume and cleans up the old 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
- Optionaloptions: VolumesFinalizeRelocationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:831

beginListGetGroupIdListForLdapUser

beginListGetGroupIdListForLdapUser(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>
Returns the list of group Ids for a specific LDAP User
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
- Optionaloptions: VolumesListGetGroupIdListForLdapUserOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>
- Defined in operationsInterfaces/volumes.ts:357

beginListGetGroupIdListForLdapUserAndWait

beginListGetGroupIdListForLdapUserAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<GetGroupIdListForLdapUserResponse>
Returns the list of group Ids for a specific LDAP User
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
- Optionaloptions: VolumesListGetGroupIdListForLdapUserOptionalParams
  The options parameters.
Returns Promise<GetGroupIdListForLdapUserResponse>
- Defined in operationsInterfaces/volumes.ts:379

beginPeerExternalCluster

beginPeerExternalCluster(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>
Starts peering the external cluster for this migration 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: PeerClusterForVolumeMigrationRequest
  Cluster peer request object supplied in the body of the operation.
- Optionaloptions: VolumesPeerExternalClusterOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>
- Defined in operationsInterfaces/volumes.ts:605

beginPeerExternalClusterAndWait

beginPeerExternalClusterAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<ClusterPeerCommandResponse>
Starts peering the external cluster for this migration 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: PeerClusterForVolumeMigrationRequest
  Cluster peer request object supplied in the body of the operation.
- Optionaloptions: VolumesPeerExternalClusterOptionalParams
  The options parameters.
Returns Promise<ClusterPeerCommandResponse>
- Defined in operationsInterfaces/volumes.ts:627

beginPerformReplicationTransfer

beginPerformReplicationTransfer(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>
Performs an adhoc replication transfer on a volume with volumeType Migration
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
- Optionaloptions: VolumesPerformReplicationTransferOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>
- Defined in operationsInterfaces/volumes.ts:717

beginPerformReplicationTransferAndWait

beginPerformReplicationTransferAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<VolumesPerformReplicationTransferHeaders>
Performs an adhoc replication transfer on a volume with volumeType Migration
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
- Optionaloptions: VolumesPerformReplicationTransferOptionalParams
  The options parameters.
Returns Promise<VolumesPerformReplicationTransferHeaders>
- Defined in operationsInterfaces/volumes.ts:737

beginPoolChange

beginPoolChange(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Moves volume to another pool
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.
- Optionaloptions: VolumesPoolChangeOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:753

beginPoolChangeAndWait

beginPoolChangeAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<void>
Moves volume to another pool
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.
- Optionaloptions: VolumesPoolChangeOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:770

beginPopulateAvailabilityZone

beginPopulateAvailabilityZone(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<Volume>, Volume>>
This operation will populate availability zone information for a 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
- Optionaloptions: VolumesPopulateAvailabilityZoneOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Volume>, Volume>>
- Defined in operationsInterfaces/volumes.ts:222

beginPopulateAvailabilityZoneAndWait

beginPopulateAvailabilityZoneAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<Volume>
This operation will populate availability zone information for a 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
- Optionaloptions: VolumesPopulateAvailabilityZoneOptionalParams
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:242

beginReestablishReplication

beginReestablishReplication(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
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.
- Optionaloptions: VolumesReestablishReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:427

beginReestablishReplicationAndWait

beginReestablishReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<void>
Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
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.
- Optionaloptions: VolumesReestablishReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:445

beginReInitializeReplication

beginReInitializeReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Re-Initializes the replication connection on the destination 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
- Optionaloptions: VolumesReInitializeReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:574

beginReInitializeReplicationAndWait

beginReInitializeReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Re-Initializes the replication connection on the destination 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
- Optionaloptions: VolumesReInitializeReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:589

beginRelocate

beginRelocate(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Relocates volume to a new stamp
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
- Optionaloptions: VolumesRelocateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:786

beginRelocateAndWait

beginRelocateAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Relocates volume to a new stamp
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
- Optionaloptions: VolumesRelocateOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:801

beginResetCifsPassword

beginResetCifsPassword(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<VolumesResetCifsPasswordHeaders>, VolumesResetCifsPasswordHeaders>>
Reset cifs password from 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
- Optionaloptions: VolumesResetCifsPasswordOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VolumesResetCifsPasswordHeaders>, VolumesResetCifsPasswordHeaders>>
- Defined in operationsInterfaces/volumes.ts:291

beginResetCifsPasswordAndWait

beginResetCifsPasswordAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<VolumesResetCifsPasswordHeaders>
Reset cifs password from 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
- Optionaloptions: VolumesResetCifsPasswordOptionalParams
  The options parameters.
Returns Promise<VolumesResetCifsPasswordHeaders>
- Defined in operationsInterfaces/volumes.ts:311

beginResyncReplication

beginResyncReplication(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
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: 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
- Optionaloptions: VolumesResyncReplicationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:477

beginResyncReplicationAndWait

beginResyncReplicationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
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: 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
- Optionaloptions: VolumesResyncReplicationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:493

beginRevert

beginRevert(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Revert a volume to the snapshot specified in the body
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.
- Optionaloptions: VolumesRevertOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:258

beginRevertAndWait

beginRevertAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<void>
Revert a volume to the snapshot specified in the body
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.
- Optionaloptions: VolumesRevertOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:275

beginRevertRelocation

beginRevertRelocation(resourceGroupName, accountName, poolName, volumeName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Reverts the volume relocation process, cleans up the new volume and starts using the former-existing 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
- Optionaloptions: VolumesRevertRelocationOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/volumes.ts:847

beginRevertRelocationAndWait

beginRevertRelocationAndWait(resourceGroupName, accountName, poolName, volumeName, options?): Promise<void>
Reverts the volume relocation process, cleans up the new volume and starts using the former-existing 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
- Optionaloptions: VolumesRevertRelocationOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/volumes.ts:863

beginUpdate

beginUpdate(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<SimplePollerLike<OperationState<Volume>, Volume>>
Patch the specified 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.
- Optionaloptions: VolumesUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Volume>, Volume>>
- Defined in operationsInterfaces/volumes.ts:154

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, accountName, poolName, volumeName, body, options?): Promise<Volume>
Patch the specified 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.
- Optionaloptions: VolumesUpdateOptionalParams
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:176

get

get(resourceGroupName, accountName, poolName, volumeName, options?): Promise<Volume>
Get the details of the specified 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
- Optionaloptions: VolumesGetOptionalParams
  The options parameters.
Returns Promise<Volume>
- Defined in operationsInterfaces/volumes.ts:99

list

list(resourceGroupName, accountName, poolName, options?): PagedAsyncIterableIterator<Volume>
List all volumes within the capacity pool
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
- Optionaloptions: VolumesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Volume>
- Defined in operationsInterfaces/volumes.ts:70

listReplications

listReplications(resourceGroupName, accountName, poolName, volumeName, options?): PagedAsyncIterableIterator<Replication>
List all replications for a specified 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
- Optionaloptions: VolumesListReplicationsOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Replication>
- Defined in operationsInterfaces/volumes.ts:84

replicationStatus

replicationStatus(resourceGroupName, accountName, poolName, volumeName, options?): Promise<ReplicationStatus>
Get the status of the replication
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
- Optionaloptions: VolumesReplicationStatusOptionalParams
  The options parameters.
Returns Promise<ReplicationStatus>
- Defined in operationsInterfaces/volumes.ts:461

Interface Volumes

Index

Methods

Methods

beginAuthorizeExternalReplication

Parameters

Returns Promise<SimplePollerLike<OperationState<SvmPeerCommandResponse>, SvmPeerCommandResponse>>

beginAuthorizeExternalReplicationAndWait

Parameters

Returns Promise<SvmPeerCommandResponse>

beginAuthorizeReplication

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginAuthorizeReplicationAndWait

Parameters

Returns Promise<void>

beginBreakFileLocks

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginBreakFileLocksAndWait

Parameters

Returns Promise<void>

beginBreakReplication

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginBreakReplicationAndWait

Parameters

Returns Promise<void>

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<Volume>, Volume>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<Volume>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginDeleteReplication

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteReplicationAndWait

Parameters

Returns Promise<void>

beginFinalizeExternalReplication

Parameters

Returns Promise<SimplePollerLike<OperationState<VolumesFinalizeExternalReplicationHeaders>, VolumesFinalizeExternalReplicationHeaders>>

beginFinalizeExternalReplicationAndWait

Parameters

Returns Promise<VolumesFinalizeExternalReplicationHeaders>

beginFinalizeRelocation

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginFinalizeRelocationAndWait

Parameters

Returns Promise<void>

beginListGetGroupIdListForLdapUser

Parameters

Returns Promise<SimplePollerLike<OperationState<GetGroupIdListForLdapUserResponse>, GetGroupIdListForLdapUserResponse>>

beginListGetGroupIdListForLdapUserAndWait

Parameters

Returns Promise<GetGroupIdListForLdapUserResponse>

beginPeerExternalCluster

Parameters

Returns Promise<SimplePollerLike<OperationState<ClusterPeerCommandResponse>, ClusterPeerCommandResponse>>

beginPeerExternalClusterAndWait

Parameters

Returns Promise<ClusterPeerCommandResponse>

beginPerformReplicationTransfer

Parameters

Returns Promise<SimplePollerLike<OperationState<VolumesPerformReplicationTransferHeaders>, VolumesPerformReplicationTransferHeaders>>

beginPerformReplicationTransferAndWait

Parameters

Returns Promise<VolumesPerformReplicationTransferHeaders>

beginPoolChange

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginPoolChangeAndWait