Subvolumes interface

Interface representing a Subvolumes.

Methods

beginCreate(string, string, string, string, string, SubvolumeInfo, SubvolumesCreateOptionalParams)

Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

beginCreateAndWait(string, string, string, string, string, SubvolumeInfo, SubvolumesCreateOptionalParams)

Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

beginDelete(string, string, string, string, string, SubvolumesDeleteOptionalParams)

Delete subvolume

beginDeleteAndWait(string, string, string, string, string, SubvolumesDeleteOptionalParams)

Delete subvolume

beginGetMetadata(string, string, string, string, string, SubvolumesGetMetadataOptionalParams)

Get details of the specified subvolume

beginGetMetadataAndWait(string, string, string, string, string, SubvolumesGetMetadataOptionalParams)

Get details of the specified subvolume

beginUpdate(string, string, string, string, string, SubvolumePatchRequest, SubvolumesUpdateOptionalParams)

Patch a subvolume

beginUpdateAndWait(string, string, string, string, string, SubvolumePatchRequest, SubvolumesUpdateOptionalParams)

Patch a subvolume

get(string, string, string, string, string, SubvolumesGetOptionalParams)

Returns the path associated with the subvolumeName provided

listByVolume(string, string, string, string, SubvolumesListByVolumeOptionalParams)

Returns a list of the subvolumes in the volume

Method Details

beginCreate(string, string, string, string, string, SubvolumeInfo, SubvolumesCreateOptionalParams)

Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

function beginCreate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

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

subvolumeName

string

The name of the subvolume.

body
SubvolumeInfo

Subvolume object supplied in the body of the operation.

options
SubvolumesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, string, SubvolumeInfo, SubvolumesCreateOptionalParams)

Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

function beginCreateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumeInfo, options?: SubvolumesCreateOptionalParams): Promise<SubvolumeInfo>

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

subvolumeName

string

The name of the subvolume.

body
SubvolumeInfo

Subvolume object supplied in the body of the operation.

options
SubvolumesCreateOptionalParams

The options parameters.

Returns

Promise<SubvolumeInfo>

beginDelete(string, string, string, string, string, SubvolumesDeleteOptionalParams)

Delete subvolume

function beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): 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

subvolumeName

string

The name of the subvolume.

options
SubvolumesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, SubvolumesDeleteOptionalParams)

Delete subvolume

function beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesDeleteOptionalParams): 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

subvolumeName

string

The name of the subvolume.

options
SubvolumesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGetMetadata(string, string, string, string, string, SubvolumesGetMetadataOptionalParams)

Get details of the specified subvolume

function beginGetMetadata(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeModel>, SubvolumeModel>>

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

subvolumeName

string

The name of the subvolume.

options
SubvolumesGetMetadataOptionalParams

The options parameters.

Returns

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

beginGetMetadataAndWait(string, string, string, string, string, SubvolumesGetMetadataOptionalParams)

Get details of the specified subvolume

function beginGetMetadataAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetMetadataOptionalParams): Promise<SubvolumeModel>

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

subvolumeName

string

The name of the subvolume.

options
SubvolumesGetMetadataOptionalParams

The options parameters.

Returns

Promise<SubvolumeModel>

beginUpdate(string, string, string, string, string, SubvolumePatchRequest, SubvolumesUpdateOptionalParams)

Patch a subvolume

function beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SubvolumeInfo>, SubvolumeInfo>>

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

subvolumeName

string

The name of the subvolume.

body
SubvolumePatchRequest

Subvolume object supplied in the body of the operation.

options
SubvolumesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, string, SubvolumePatchRequest, SubvolumesUpdateOptionalParams)

Patch a subvolume

function beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, body: SubvolumePatchRequest, options?: SubvolumesUpdateOptionalParams): Promise<SubvolumeInfo>

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

subvolumeName

string

The name of the subvolume.

body
SubvolumePatchRequest

Subvolume object supplied in the body of the operation.

options
SubvolumesUpdateOptionalParams

The options parameters.

Returns

Promise<SubvolumeInfo>

get(string, string, string, string, string, SubvolumesGetOptionalParams)

Returns the path associated with the subvolumeName provided

function get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, subvolumeName: string, options?: SubvolumesGetOptionalParams): Promise<SubvolumeInfo>

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

subvolumeName

string

The name of the subvolume.

options
SubvolumesGetOptionalParams

The options parameters.

Returns

Promise<SubvolumeInfo>

listByVolume(string, string, string, string, SubvolumesListByVolumeOptionalParams)

Returns a list of the subvolumes in the volume

function listByVolume(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: SubvolumesListByVolumeOptionalParams): PagedAsyncIterableIterator<SubvolumeInfo, SubvolumeInfo[], 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
SubvolumesListByVolumeOptionalParams

The options parameters.

Returns