Share via

BackupInstancesOperations interface

Package:
@azure/arm-dataprotection

Interface representing a BackupInstances operations.

Properties

adhocBackup

Trigger adhoc backup
createOrUpdate

Create or update a backup instance in a backup vault
delete
get

Gets a backup instance with name in a backup vault
getBackupInstanceOperationResult

Get result of backup instance creation operation
list

Gets a backup instances belonging to a backup vault
resumeBackups

This operation will resume backups for backup instance
resumeProtection

This operation will resume protection for a stopped backup instance
stopProtection

This operation will stop protection of a backup instance and data will be held forever
suspendBackups

This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)
syncBackupInstance

Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
triggerCrossRegionRestore

Triggers Cross Region Restore for BackupInstance.
triggerRehydrate

rehydrate recovery point for restore for a BackupInstance
triggerRestore

Triggers restore for a BackupInstance
validateCrossRegionRestore

Validates whether Cross Region Restore can be triggered for DataSource.
validateForBackup

Validate whether adhoc backup will be successful or not
validateForModifyBackup

Validate whether update for backup instance will be successful or not
validateForRestore

Validates if Restore can be triggered for a DataSource

Property Details

adhocBackup

Trigger adhoc backup

adhocBackup: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: TriggerBackupRequest, options?: BackupInstancesAdhocBackupOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: TriggerBackupRequest, options?: BackupInstancesAdhocBackupOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

createOrUpdate

Create or update a backup instance in a backup vault

createOrUpdate: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: BackupInstanceResource, options?: BackupInstancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<BackupInstanceResource>, BackupInstanceResource>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: BackupInstanceResource, options?: BackupInstancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<BackupInstanceResource>, BackupInstanceResource>

delete 

delete: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a backup instance with name in a backup vault

get: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesGetOptionalParams) => Promise<BackupInstanceResource>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesGetOptionalParams) => Promise<BackupInstanceResource>

getBackupInstanceOperationResult

Get result of backup instance creation operation

getBackupInstanceOperationResult: (resourceGroupName: string, vaultName: string, backupInstanceName: string, operationId: string, options?: BackupInstancesGetBackupInstanceOperationResultOptionalParams) => Promise<null | BackupInstanceResource>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, operationId: string, options?: BackupInstancesGetBackupInstanceOperationResultOptionalParams) => Promise<null | BackupInstanceResource>

list

Gets a backup instances belonging to a backup vault

list: (resourceGroupName: string, vaultName: string, options?: BackupInstancesListOptionalParams) => PagedAsyncIterableIterator<BackupInstanceResource, BackupInstanceResource[], PageSettings>

Property Value

(resourceGroupName: string, vaultName: string, options?: BackupInstancesListOptionalParams) => PagedAsyncIterableIterator<BackupInstanceResource, BackupInstanceResource[], PageSettings>

resumeBackups

This operation will resume backups for backup instance

resumeBackups: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeBackupsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeBackupsOptionalParams) => PollerLike<OperationState<void>, void>

resumeProtection

This operation will resume protection for a stopped backup instance

resumeProtection: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeProtectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeProtectionOptionalParams) => PollerLike<OperationState<void>, void>

stopProtection

This operation will stop protection of a backup instance and data will be held forever

stopProtection: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesStopProtectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesStopProtectionOptionalParams) => PollerLike<OperationState<void>, void>

suspendBackups

This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)

suspendBackups: (resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesSuspendBackupsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesSuspendBackupsOptionalParams) => PollerLike<OperationState<void>, void>

syncBackupInstance

Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state

syncBackupInstance: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: SyncBackupInstanceRequest, options?: BackupInstancesSyncBackupInstanceOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: SyncBackupInstanceRequest, options?: BackupInstancesSyncBackupInstanceOptionalParams) => PollerLike<OperationState<void>, void>

triggerCrossRegionRestore

Triggers Cross Region Restore for BackupInstance.

triggerCrossRegionRestore: (resourceGroupName: string, location: string, parameters: CrossRegionRestoreRequestObject, options?: BackupInstancesTriggerCrossRegionRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, location: string, parameters: CrossRegionRestoreRequestObject, options?: BackupInstancesTriggerCrossRegionRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

triggerRehydrate

rehydrate recovery point for restore for a BackupInstance

triggerRehydrate: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRehydrationRequest, options?: BackupInstancesTriggerRehydrateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRehydrationRequest, options?: BackupInstancesTriggerRehydrateOptionalParams) => PollerLike<OperationState<void>, void>

triggerRestore

Triggers restore for a BackupInstance

triggerRestore: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRestoreRequestUnion, options?: BackupInstancesTriggerRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRestoreRequestUnion, options?: BackupInstancesTriggerRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

validateCrossRegionRestore

Validates whether Cross Region Restore can be triggered for DataSource.

validateCrossRegionRestore: (resourceGroupName: string, location: string, parameters: ValidateCrossRegionRestoreRequestObject, options?: BackupInstancesValidateCrossRegionRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, location: string, parameters: ValidateCrossRegionRestoreRequestObject, options?: BackupInstancesValidateCrossRegionRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

validateForBackup

Validate whether adhoc backup will be successful or not

validateForBackup: (resourceGroupName: string, vaultName: string, parameters: ValidateForBackupRequest, options?: BackupInstancesValidateForBackupOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, vaultName: string, parameters: ValidateForBackupRequest, options?: BackupInstancesValidateForBackupOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

validateForModifyBackup

Validate whether update for backup instance will be successful or not

validateForModifyBackup: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateForModifyBackupRequest, options?: BackupInstancesValidateForModifyBackupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateForModifyBackupRequest, options?: BackupInstancesValidateForModifyBackupOptionalParams) => PollerLike<OperationState<void>, void>

validateForRestore

Validates if Restore can be triggered for a DataSource

validateForRestore: (resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateRestoreRequestObject, options?: BackupInstancesValidateForRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>

Property Value

(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateRestoreRequestObject, options?: BackupInstancesValidateForRestoreOptionalParams) => PollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>