Package version:

Interface Snapshots

Interface representing a Snapshots.

interface Snapshots {
    beginCreate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Snapshot, options?: SnapshotsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>;
    beginCreateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Snapshot, options?: SnapshotsCreateOptionalParams): Promise<Snapshot>;
    beginDelete(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, options?: SnapshotsDeleteOptionalParams): Promise<void>;
    beginRestoreFiles(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginRestoreFilesAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: SnapshotRestoreFiles, options?: SnapshotsRestoreFilesOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Record<string, unknown>, options?: SnapshotsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>;
    beginUpdateAndWait(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, body: Record<string, unknown>, options?: SnapshotsUpdateOptionalParams): Promise<Snapshot>;
    get(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, snapshotName: string, options?: SnapshotsGetOptionalParams): Promise<Snapshot>;
    list(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: SnapshotsListOptionalParams): PagedAsyncIterableIterator<Snapshot>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginRestoreFiles beginRestoreFilesAndWait beginUpdate beginUpdateAndWait get list

Methods

beginCreate

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

  • Create the specified snapshot within the given 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

    • snapshotName: string

      The name of the snapshot

    • body: Snapshot

      Snapshot object supplied in the body of the operation.

    • Optionaloptions: SnapshotsCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>

beginCreateAndWait

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

  • Create the specified snapshot within the given 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

    • snapshotName: string

      The name of the snapshot

    • body: Snapshot

      Snapshot object supplied in the body of the operation.

    • Optionaloptions: SnapshotsCreateOptionalParams

      The options parameters.

    Returns Promise<Snapshot>

beginDelete

  • beginDelete(resourceGroupName, accountName, poolName, volumeName, snapshotName, options?): Promise<SimplePollerLike<OperationState<void>, void>>

  • Delete 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

    • Optionaloptions: SnapshotsDeleteOptionalParams

      The options parameters.

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

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, accountName, poolName, volumeName, snapshotName, options?): Promise<void>

  • Delete 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

    • Optionaloptions: SnapshotsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginRestoreFiles

  • beginRestoreFiles(resourceGroupName, accountName, poolName, volumeName, snapshotName, body, options?): Promise<SimplePollerLike<OperationState<void>, void>>

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

    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.

    • Optionaloptions: SnapshotsRestoreFilesOptionalParams

      The options parameters.

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

beginRestoreFilesAndWait

  • beginRestoreFilesAndWait(resourceGroupName, accountName, poolName, volumeName, snapshotName, body, options?): Promise<void>

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

    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.

    • Optionaloptions: SnapshotsRestoreFilesOptionalParams

      The options parameters.

    Returns Promise<void>

beginUpdate

  • beginUpdate(resourceGroupName, accountName, poolName, volumeName, snapshotName, body, options?): Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>

  • Patch a 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.

    • Optionaloptions: SnapshotsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Snapshot>, Snapshot>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, accountName, poolName, volumeName, snapshotName, body, options?): Promise<Snapshot>

  • Patch a 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.

    • Optionaloptions: SnapshotsUpdateOptionalParams

      The options parameters.

    Returns Promise<Snapshot>

get

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

  • Get details of the specified 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

    • Optionaloptions: SnapshotsGetOptionalParams

      The options parameters.

    Returns Promise<Snapshot>

list

  • list(resourceGroupName, accountName, poolName, volumeName, options?): PagedAsyncIterableIterator<Snapshot>

  • List all snapshots associated with the 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: SnapshotsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Snapshot>

Settings

Member Visibility