Package version:

Interface Backups

Interface representing a Backups.

interface Backups {
    beginCreate(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, body: Backup, options?: BackupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Backup>, Backup>>;
    beginCreateAndWait(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, body: Backup, options?: BackupsCreateOptionalParams): Promise<Backup>;
    beginDelete(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, options?: BackupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<BackupsDeleteHeaders>, BackupsDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, options?: BackupsDeleteOptionalParams): Promise<BackupsDeleteHeaders>;
    beginUpdate(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, options?: BackupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Backup>, Backup>>;
    beginUpdateAndWait(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, options?: BackupsUpdateOptionalParams): Promise<Backup>;
    get(resourceGroupName: string, accountName: string, backupVaultName: string, backupName: string, options?: BackupsGetOptionalParams): Promise<Backup>;
    getLatestStatus(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: BackupsGetLatestStatusOptionalParams): Promise<BackupStatus>;
    getVolumeLatestRestoreStatus(resourceGroupName: string, accountName: string, poolName: string, volumeName: string, options?: BackupsGetVolumeLatestRestoreStatusOptionalParams): Promise<RestoreStatus>;
    listByVault(resourceGroupName: string, accountName: string, backupVaultName: string, options?: BackupsListByVaultOptionalParams): PagedAsyncIterableIterator<Backup>;
}

Methods

  • Create a backup under the Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • body: Backup

      Backup object supplied in the body of the operation.

    • Optionaloptions: BackupsCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Backup>, Backup>>

  • Create a backup under the Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • body: Backup

      Backup object supplied in the body of the operation.

    • Optionaloptions: BackupsCreateOptionalParams

      The options parameters.

    Returns Promise<Backup>

  • Delete a Backup under the Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • Optionaloptions: BackupsDeleteOptionalParams

      The options parameters.

    Returns Promise<BackupsDeleteHeaders>

  • Patch a Backup under the Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • Optionaloptions: BackupsUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Backup>, Backup>>

  • Patch a Backup under the Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • Optionaloptions: BackupsUpdateOptionalParams

      The options parameters.

    Returns Promise<Backup>

  • Get the specified Backup under Backup Vault.

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • backupName: string

      The name of the backup

    • Optionaloptions: BackupsGetOptionalParams

      The options parameters.

    Returns Promise<Backup>

  • Get the latest status of the backup for a 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: BackupsGetLatestStatusOptionalParams

      The options parameters.

    Returns Promise<BackupStatus>

  • Get the latest status of the restore for a 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: BackupsGetVolumeLatestRestoreStatusOptionalParams

      The options parameters.

    Returns Promise<RestoreStatus>

  • List all backups Under a Backup Vault

    Parameters

    • resourceGroupName: string

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

    • accountName: string

      The name of the NetApp account

    • backupVaultName: string

      The name of the Backup Vault

    • Optionaloptions: BackupsListByVaultOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Backup>