Volumes interface

Package:

@azure/arm-elasticsan

Interface representing a Volumes.

Methods

beginCreate(string, string, string, string, Volume, VolumesCreateOptionalParams)	Create a Volume.
beginCreateAndWait(string, string, string, string, Volume, VolumesCreateOptionalParams)	Create a Volume.
beginDelete(string, string, string, string, VolumesDeleteOptionalParams)	Delete an Volume.
beginDeleteAndWait(string, string, string, string, VolumesDeleteOptionalParams)	Delete an Volume.
beginPreBackup(string, string, string, VolumeNameList, VolumesPreBackupOptionalParams)	Validate whether a disk snapshot backup can be taken for list of volumes.
beginPreBackupAndWait(string, string, string, VolumeNameList, VolumesPreBackupOptionalParams)	Validate whether a disk snapshot backup can be taken for list of volumes.
beginPreRestore(string, string, string, DiskSnapshotList, VolumesPreRestoreOptionalParams)	Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
beginPreRestoreAndWait(string, string, string, DiskSnapshotList, VolumesPreRestoreOptionalParams)	Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.
beginUpdate(string, string, string, string, VolumeUpdate, VolumesUpdateOptionalParams)	Update an Volume.
beginUpdateAndWait(string, string, string, string, VolumeUpdate, VolumesUpdateOptionalParams)	Update an Volume.
get(string, string, string, string, VolumesGetOptionalParams)	Get an Volume.
listByVolumeGroup(string, string, string, VolumesListByVolumeGroupOptionalParams)	List Volumes in a VolumeGroup.

Method Details

beginCreate(string, string, string, string, Volume, VolumesCreateOptionalParams)

Create a Volume.

function beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

parameters

Volume

Volume object.

options

VolumesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, Volume, VolumesCreateOptionalParams)

Create a Volume.

function beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: Volume, options?: VolumesCreateOptionalParams): Promise<Volume>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

parameters

Volume

Volume object.

options

VolumesCreateOptionalParams

The options parameters.

Returns

Promise<Volume>

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

Delete an Volume.

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

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

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

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

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

options

VolumesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPreBackup(string, string, string, VolumeNameList, VolumesPreBackupOptionalParams)

Validate whether a disk snapshot backup can be taken for list of volumes.

function beginPreBackup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeNameList, options?: VolumesPreBackupOptionalParams): Promise<SimplePollerLike<OperationState<PreValidationResponse>, PreValidationResponse>>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

parameters

VolumeNameList

Volume Name List (currently only one volume name in the list is supported. Server would return error if list is bigger)

options

VolumesPreBackupOptionalParams

The options parameters.

Returns

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

beginPreBackupAndWait(string, string, string, VolumeNameList, VolumesPreBackupOptionalParams)

Validate whether a disk snapshot backup can be taken for list of volumes.

function beginPreBackupAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: VolumeNameList, options?: VolumesPreBackupOptionalParams): Promise<PreValidationResponse>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

parameters

VolumeNameList

Volume Name List (currently only one volume name in the list is supported. Server would return error if list is bigger)

options

VolumesPreBackupOptionalParams

The options parameters.

Returns

Promise<PreValidationResponse>

beginPreRestore(string, string, string, DiskSnapshotList, VolumesPreRestoreOptionalParams)

Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.

function beginPreRestore(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: DiskSnapshotList, options?: VolumesPreRestoreOptionalParams): Promise<SimplePollerLike<OperationState<PreValidationResponse>, PreValidationResponse>>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

parameters

DiskSnapshotList

Disk Snapshot List (currently only one Disk Snapshot in the list is supported and that the Disk Snapshot must be in same azure region as the ElasticSan. Server would return error if list is bigger)

options

VolumesPreRestoreOptionalParams

The options parameters.

Returns

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

beginPreRestoreAndWait(string, string, string, DiskSnapshotList, VolumesPreRestoreOptionalParams)

Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.

function beginPreRestoreAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, parameters: DiskSnapshotList, options?: VolumesPreRestoreOptionalParams): Promise<PreValidationResponse>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

parameters

DiskSnapshotList

Disk Snapshot List (currently only one Disk Snapshot in the list is supported and that the Disk Snapshot must be in same azure region as the ElasticSan. Server would return error if list is bigger)

options

VolumesPreRestoreOptionalParams

The options parameters.

Returns

Promise<PreValidationResponse>

beginUpdate(string, string, string, string, VolumeUpdate, VolumesUpdateOptionalParams)

Update an Volume.

function beginUpdate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Volume>, Volume>>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

parameters

VolumeUpdate

Volume object.

options

VolumesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, VolumeUpdate, VolumesUpdateOptionalParams)

Update an Volume.

function beginUpdateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, volumeName: string, parameters: VolumeUpdate, options?: VolumesUpdateOptionalParams): Promise<Volume>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

parameters

VolumeUpdate

Volume object.

options

VolumesUpdateOptionalParams

The options parameters.

Returns

Promise<Volume>

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

Get an Volume.

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

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

volumeName

string

The name of the Volume.

options

VolumesGetOptionalParams

The options parameters.

Returns

Promise<Volume>

listByVolumeGroup(string, string, string, VolumesListByVolumeGroupOptionalParams)

List Volumes in a VolumeGroup.

function listByVolumeGroup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumesListByVolumeGroupOptionalParams): PagedAsyncIterableIterator<Volume, Volume[], PageSettings>

Parameters

resourceGroupName

string

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

elasticSanName

string

The name of the ElasticSan.

volumeGroupName

string

The name of the VolumeGroup.

options

VolumesListByVolumeGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Volume, Volume[], PageSettings>