Snapshots interface

Package:

@azure/arm-netapp

Interface representing a Snapshots.

Methods

beginCreate(string, string, string, string, string, Snapshot, SnapshotsCreateOptionalParams)	Create the specified snapshot within the given volume
beginCreateAndWait(string, string, string, string, string, Snapshot, SnapshotsCreateOptionalParams)	Create the specified snapshot within the given volume
beginDelete(string, string, string, string, string, SnapshotsDeleteOptionalParams)	Delete snapshot
beginDeleteAndWait(string, string, string, string, string, SnapshotsDeleteOptionalParams)	Delete snapshot
beginRestoreFiles(string, string, string, string, string, SnapshotRestoreFiles, SnapshotsRestoreFilesOptionalParams)	Restore the specified files from the specified snapshot to the active filesystem
beginRestoreFilesAndWait(string, string, string, string, string, SnapshotRestoreFiles, SnapshotsRestoreFilesOptionalParams)	Restore the specified files from the specified snapshot to the active filesystem
beginUpdate(string, string, string, string, string, Record<string, unknown>, SnapshotsUpdateOptionalParams)	Patch a snapshot
beginUpdateAndWait(string, string, string, string, string, Record<string, unknown>, SnapshotsUpdateOptionalParams)	Patch a snapshot
get(string, string, string, string, string, SnapshotsGetOptionalParams)	Get details of the specified snapshot
list(string, string, string, string, SnapshotsListOptionalParams)	List all snapshots associated with the volume

Method Details

beginCreate(string, string, string, string, string, Snapshot, SnapshotsCreateOptionalParams)

Create the specified snapshot within the given volume

function beginCreate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Snapshot, options?: SnapshotsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>

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

snapshotName

string

The name of the snapshot

body

Snapshot

Snapshot object supplied in the body of the operation.

options

SnapshotsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, string, Snapshot, SnapshotsCreateOptionalParams)

Create the specified snapshot within the given volume

function beginCreateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Snapshot, options?: SnapshotsCreateOptionalParams): Promise<Snapshot>

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

snapshotName

string

The name of the snapshot

body

Snapshot

Snapshot object supplied in the body of the operation.

options

SnapshotsCreateOptionalParams

The options parameters.

Returns

Promise<Snapshot>

beginDelete(string, string, string, string, string, SnapshotsDeleteOptionalParams)

Delete snapshot

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

snapshotName

string

The name of the snapshot

options

SnapshotsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, SnapshotsDeleteOptionalParams)

Delete snapshot

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

snapshotName

string

The name of the snapshot

options

SnapshotsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRestoreFiles(string, string, string, string, string, SnapshotRestoreFiles, SnapshotsRestoreFilesOptionalParams)

Restore the specified files from the specified snapshot to the active filesystem

function beginRestoreFiles(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): 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

snapshotName

string

The name of the snapshot

body

SnapshotRestoreFiles

Restore payload supplied in the body of the operation.

options

SnapshotsRestoreFilesOptionalParams

The options parameters.

Returns

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

beginRestoreFilesAndWait(string, string, string, string, string, SnapshotRestoreFiles, SnapshotsRestoreFilesOptionalParams)

Restore the specified files from the specified snapshot to the active filesystem

function beginRestoreFilesAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): 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

snapshotName

string

The name of the snapshot

body

SnapshotRestoreFiles

Restore payload supplied in the body of the operation.

options

SnapshotsRestoreFilesOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, string, Record<string, unknown>, SnapshotsUpdateOptionalParams)

Patch a snapshot

function beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Record<string, unknown>, options?: SnapshotsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>

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

snapshotName

string

The name of the snapshot

body

Record<string, unknown>

Snapshot object supplied in the body of the operation.

options

SnapshotsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, string, Record<string, unknown>, SnapshotsUpdateOptionalParams)

Patch a snapshot

function beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Record<string, unknown>, options?: SnapshotsUpdateOptionalParams): Promise<Snapshot>

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

snapshotName

string

The name of the snapshot

body

Record<string, unknown>

Snapshot object supplied in the body of the operation.

options

SnapshotsUpdateOptionalParams

The options parameters.

Returns

Promise<Snapshot>

get(string, string, string, string, string, SnapshotsGetOptionalParams)

Get details of the specified snapshot

function get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, options?: SnapshotsGetOptionalParams): Promise<Snapshot>

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

snapshotName

string

The name of the snapshot

options

SnapshotsGetOptionalParams

The options parameters.

Returns

Promise<Snapshot>

list(string, string, string, string, SnapshotsListOptionalParams)

List all snapshots associated with the volume

function list(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<Snapshot, Snapshot[], 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

SnapshotsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Snapshot, Snapshot[], PageSettings>