BackupInstances interface
Interface representing a BackupInstances.
Methods
Method Details
beginAdhocBackup(string, string, string, TriggerBackupRequest, BackupInstancesAdhocBackupOptionalParams)
Trigger adhoc backup
function beginAdhocBackup(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: TriggerBackupRequest, options?: BackupInstancesAdhocBackupOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- TriggerBackupRequest
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginAdhocBackupAndWait(string, string, string, TriggerBackupRequest, BackupInstancesAdhocBackupOptionalParams)
Trigger adhoc backup
function beginAdhocBackupAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: TriggerBackupRequest, options?: BackupInstancesAdhocBackupOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- TriggerBackupRequest
Request body for operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
beginCreateOrUpdate(string, string, string, BackupInstanceResource, BackupInstancesCreateOrUpdateOptionalParams)
Create or update a backup instance in a backup vault
function beginCreateOrUpdate(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: BackupInstanceResource, options?: BackupInstancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupInstanceResource>, BackupInstanceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- BackupInstanceResource
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInstanceResource>, BackupInstanceResource>>
beginCreateOrUpdateAndWait(string, string, string, BackupInstanceResource, BackupInstancesCreateOrUpdateOptionalParams)
Create or update a backup instance in a backup vault
function beginCreateOrUpdateAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: BackupInstanceResource, options?: BackupInstancesCreateOrUpdateOptionalParams): Promise<BackupInstanceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- BackupInstanceResource
Request body for operation
The options parameters.
Returns
Promise<BackupInstanceResource>
beginDelete(string, string, string, BackupInstancesDeleteOptionalParams)
Delete a backup instance in a backup vault
function beginDelete(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, BackupInstancesDeleteOptionalParams)
Delete a backup instance in a backup vault
function beginDeleteAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<void>
beginResumeBackups(string, string, string, BackupInstancesResumeBackupsOptionalParams)
This operation will resume backups for backup instance
function beginResumeBackups(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeBackupsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResumeBackupsAndWait(string, string, string, BackupInstancesResumeBackupsOptionalParams)
This operation will resume backups for backup instance
function beginResumeBackupsAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeBackupsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<void>
beginResumeProtection(string, string, string, BackupInstancesResumeProtectionOptionalParams)
This operation will resume protection for a stopped backup instance
function beginResumeProtection(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeProtectionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResumeProtectionAndWait(string, string, string, BackupInstancesResumeProtectionOptionalParams)
This operation will resume protection for a stopped backup instance
function beginResumeProtectionAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesResumeProtectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<void>
beginStopProtection(string, string, string, BackupInstancesStopProtectionOptionalParams)
This operation will stop protection of a backup instance and data will be held forever
function beginStopProtection(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesStopProtectionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopProtectionAndWait(string, string, string, BackupInstancesStopProtectionOptionalParams)
This operation will stop protection of a backup instance and data will be held forever
function beginStopProtectionAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesStopProtectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<void>
beginSuspendBackups(string, string, string, BackupInstancesSuspendBackupsOptionalParams)
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)
function beginSuspendBackups(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesSuspendBackupsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginSuspendBackupsAndWait(string, string, string, BackupInstancesSuspendBackupsOptionalParams)
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)
function beginSuspendBackupsAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesSuspendBackupsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
The options parameters.
Returns
Promise<void>
beginSyncBackupInstance(string, string, string, SyncBackupInstanceRequest, BackupInstancesSyncBackupInstanceOptionalParams)
Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
function beginSyncBackupInstance(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: SyncBackupInstanceRequest, options?: BackupInstancesSyncBackupInstanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- SyncBackupInstanceRequest
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginSyncBackupInstanceAndWait(string, string, string, SyncBackupInstanceRequest, BackupInstancesSyncBackupInstanceOptionalParams)
Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
function beginSyncBackupInstanceAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: SyncBackupInstanceRequest, options?: BackupInstancesSyncBackupInstanceOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- SyncBackupInstanceRequest
Request body for operation
The options parameters.
Returns
Promise<void>
beginTriggerCrossRegionRestore(string, string, CrossRegionRestoreRequestObject, BackupInstancesTriggerCrossRegionRestoreOptionalParams)
Triggers Cross Region Restore for BackupInstance.
function beginTriggerCrossRegionRestore(resourceGroupName: string, location: string, parameters: CrossRegionRestoreRequestObject, options?: BackupInstancesTriggerCrossRegionRestoreOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of the Azure region.
- parameters
- CrossRegionRestoreRequestObject
Request body for trigger CRR operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginTriggerCrossRegionRestoreAndWait(string, string, CrossRegionRestoreRequestObject, BackupInstancesTriggerCrossRegionRestoreOptionalParams)
Triggers Cross Region Restore for BackupInstance.
function beginTriggerCrossRegionRestoreAndWait(resourceGroupName: string, location: string, parameters: CrossRegionRestoreRequestObject, options?: BackupInstancesTriggerCrossRegionRestoreOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of the Azure region.
- parameters
- CrossRegionRestoreRequestObject
Request body for trigger CRR operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
beginTriggerRehydrate(string, string, string, AzureBackupRehydrationRequest, BackupInstancesTriggerRehydrateOptionalParams)
rehydrate recovery point for restore for a BackupInstance
function beginTriggerRehydrate(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRehydrationRequest, options?: BackupInstancesTriggerRehydrateOptionalParams): Promise<SimplePollerLike<OperationState<BackupInstancesTriggerRehydrateHeaders>, BackupInstancesTriggerRehydrateHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- AzureBackupRehydrationRequest
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInstancesTriggerRehydrateHeaders>, BackupInstancesTriggerRehydrateHeaders>>
beginTriggerRehydrateAndWait(string, string, string, AzureBackupRehydrationRequest, BackupInstancesTriggerRehydrateOptionalParams)
rehydrate recovery point for restore for a BackupInstance
function beginTriggerRehydrateAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRehydrationRequest, options?: BackupInstancesTriggerRehydrateOptionalParams): Promise<BackupInstancesTriggerRehydrateHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- AzureBackupRehydrationRequest
Request body for operation
The options parameters.
Returns
beginTriggerRestore(string, string, string, AzureBackupRestoreRequestUnion, BackupInstancesTriggerRestoreOptionalParams)
Triggers restore for a BackupInstance
function beginTriggerRestore(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRestoreRequestUnion, options?: BackupInstancesTriggerRestoreOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- AzureBackupRestoreRequestUnion
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginTriggerRestoreAndWait(string, string, string, AzureBackupRestoreRequestUnion, BackupInstancesTriggerRestoreOptionalParams)
Triggers restore for a BackupInstance
function beginTriggerRestoreAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: AzureBackupRestoreRequestUnion, options?: BackupInstancesTriggerRestoreOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- AzureBackupRestoreRequestUnion
Request body for operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
beginValidateCrossRegionRestore(string, string, ValidateCrossRegionRestoreRequestObject, BackupInstancesValidateCrossRegionRestoreOptionalParams)
Validates whether Cross Region Restore can be triggered for DataSource.
function beginValidateCrossRegionRestore(resourceGroupName: string, location: string, parameters: ValidateCrossRegionRestoreRequestObject, options?: BackupInstancesValidateCrossRegionRestoreOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of the Azure region.
- parameters
- ValidateCrossRegionRestoreRequestObject
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginValidateCrossRegionRestoreAndWait(string, string, ValidateCrossRegionRestoreRequestObject, BackupInstancesValidateCrossRegionRestoreOptionalParams)
Validates whether Cross Region Restore can be triggered for DataSource.
function beginValidateCrossRegionRestoreAndWait(resourceGroupName: string, location: string, parameters: ValidateCrossRegionRestoreRequestObject, options?: BackupInstancesValidateCrossRegionRestoreOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- location
-
string
The name of the Azure region.
- parameters
- ValidateCrossRegionRestoreRequestObject
Request body for operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
beginValidateForBackup(string, string, ValidateForBackupRequest, BackupInstancesValidateForBackupOptionalParams)
Validate whether adhoc backup will be successful or not
function beginValidateForBackup(resourceGroupName: string, vaultName: string, parameters: ValidateForBackupRequest, options?: BackupInstancesValidateForBackupOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- ValidateForBackupRequest
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginValidateForBackupAndWait(string, string, ValidateForBackupRequest, BackupInstancesValidateForBackupOptionalParams)
Validate whether adhoc backup will be successful or not
function beginValidateForBackupAndWait(resourceGroupName: string, vaultName: string, parameters: ValidateForBackupRequest, options?: BackupInstancesValidateForBackupOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- parameters
- ValidateForBackupRequest
Request body for operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
beginValidateForRestore(string, string, string, ValidateRestoreRequestObject, BackupInstancesValidateForRestoreOptionalParams)
Validates if Restore can be triggered for a DataSource
function beginValidateForRestore(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateRestoreRequestObject, options?: BackupInstancesValidateForRestoreOptionalParams): Promise<SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- ValidateRestoreRequestObject
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationJobExtendedInfo>, OperationJobExtendedInfo>>
beginValidateForRestoreAndWait(string, string, string, ValidateRestoreRequestObject, BackupInstancesValidateForRestoreOptionalParams)
Validates if Restore can be triggered for a DataSource
function beginValidateForRestoreAndWait(resourceGroupName: string, vaultName: string, backupInstanceName: string, parameters: ValidateRestoreRequestObject, options?: BackupInstancesValidateForRestoreOptionalParams): Promise<OperationJobExtendedInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- parameters
- ValidateRestoreRequestObject
Request body for operation
The options parameters.
Returns
Promise<OperationJobExtendedInfo>
get(string, string, string, BackupInstancesGetOptionalParams)
Gets a backup instance with name in a backup vault
function get(resourceGroupName: string, vaultName: string, backupInstanceName: string, options?: BackupInstancesGetOptionalParams): Promise<BackupInstanceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- options
- BackupInstancesGetOptionalParams
The options parameters.
Returns
Promise<BackupInstanceResource>
getBackupInstanceOperationResult(string, string, string, string, BackupInstancesGetBackupInstanceOperationResultOptionalParams)
Get result of backup instance creation operation
function getBackupInstanceOperationResult(resourceGroupName: string, vaultName: string, backupInstanceName: string, operationId: string, options?: BackupInstancesGetBackupInstanceOperationResultOptionalParams): Promise<BackupInstanceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
- backupInstanceName
-
string
The name of the backup instance.
- operationId
-
string
The options parameters.
Returns
Promise<BackupInstanceResource>
list(string, string, BackupInstancesListOptionalParams)
Gets a backup instances belonging to a backup vault
function list(resourceGroupName: string, vaultName: string, options?: BackupInstancesListOptionalParams): PagedAsyncIterableIterator<BackupInstanceResource, BackupInstanceResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- vaultName
-
string
The name of the backup vault.
The options parameters.