VolumeSnapshots interface
Interface representing a VolumeSnapshots.
Methods
| begin |
Create a Volume Snapshot. |
| begin |
Create a Volume Snapshot. |
| begin |
Delete a Volume Snapshot. |
| begin |
Delete a Volume Snapshot. |
| get(string, string, string, string, Volume |
Get a Volume Snapshot. |
| list |
List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter |
Method Details
beginCreate(string, string, string, string, Snapshot, VolumeSnapshotsCreateOptionalParams)
Create a Volume Snapshot.
function beginCreate(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, parameters: Snapshot, options?: VolumeSnapshotsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>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.
- snapshotName
-
string
The name of the volume snapshot within the given volume group.
- parameters
- Snapshot
Snapshot object.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Snapshot>, Snapshot>>
beginCreateAndWait(string, string, string, string, Snapshot, VolumeSnapshotsCreateOptionalParams)
Create a Volume Snapshot.
function beginCreateAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, parameters: Snapshot, options?: VolumeSnapshotsCreateOptionalParams): Promise<Snapshot>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.
- snapshotName
-
string
The name of the volume snapshot within the given volume group.
- parameters
- Snapshot
Snapshot object.
The options parameters.
Returns
Promise<Snapshot>
beginDelete(string, string, string, string, VolumeSnapshotsDeleteOptionalParams)
Delete a Volume Snapshot.
function beginDelete(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsDeleteOptionalParams): 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.
- snapshotName
-
string
The name of the volume snapshot within the given volume group.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, VolumeSnapshotsDeleteOptionalParams)
Delete a Volume Snapshot.
function beginDeleteAndWait(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsDeleteOptionalParams): 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.
- snapshotName
-
string
The name of the volume snapshot within the given volume group.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, VolumeSnapshotsGetOptionalParams)
Get a Volume Snapshot.
function get(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, snapshotName: string, options?: VolumeSnapshotsGetOptionalParams): Promise<Snapshot>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.
- snapshotName
-
string
The name of the volume snapshot within the given volume group.
- options
- VolumeSnapshotsGetOptionalParams
The options parameters.
Returns
Promise<Snapshot>
listByVolumeGroup(string, string, string, VolumeSnapshotsListByVolumeGroupOptionalParams)
List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter
function listByVolumeGroup(resourceGroupName: string, elasticSanName: string, volumeGroupName: string, options?: VolumeSnapshotsListByVolumeGroupOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], 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.
The options parameters.