@datafire/azure_recoveryservicesbackup
v5.0.0
Published
DataFire integration for RecoveryServicesBackupClient
Downloads
1
Readme
@datafire/azure_recoveryservicesbackup
Client library for RecoveryServicesBackupClient
Installation and Usage
npm install --save @datafire/azure_recoveryservicesbackup
let azure_recoveryservicesbackup = require('@datafire/azure_recoveryservicesbackup').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Actions
BackupEngines_Get
The backup management servers registered to a Recovery Services vault. This returns a pageable list of servers.
azure_recoveryservicesbackup.BackupEngines_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: Use this filter to choose the specific backup management server. backupManagementType { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. - $skipToken
string
: The Skip Token filter.
- api-version required
Output
- output BackupEngineBaseResourceList
ProtectionContainerRefreshOperationResults_Get
Provides the result of the refresh operation triggered by the BeginRefresh operation.
azure_recoveryservicesbackup.ProtectionContainerRefreshOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the container. - operationId required
string
: The operation ID used for this GET operation.
- api-version required
Output
Output schema unknown
ProtectionContainers_Get
Gets details of the specific container registered to your Recovery Services vault.
azure_recoveryservicesbackup.ProtectionContainers_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the container. - containerName required
string
: The container name used for this GET operation.
- api-version required
Output
- output ProtectionContainerResource
ProtectionContainerOperationResults_Get
Gets the result of any operation on the container.
azure_recoveryservicesbackup.ProtectionContainerOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the container. - containerName required
string
: The container name used for this GET operation. - operationId required
string
: The operation ID used for this GET operation.
- api-version required
Output
- output ProtectionContainerResource
ProtectedItems_Delete
Used to disable the backup job for an item within a container. This is an asynchronous operation. To learn the status of the request, call the GetItemOperationResult API.
azure_recoveryservicesbackup.ProtectedItems_Delete({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The backup item to be deleted.
- api-version required
Output
Output schema unknown
ProtectedItems_Get
Provides the details of the backup item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
azure_recoveryservicesbackup.ProtectedItems_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The backup item name used in this GET operation. - $filter
string
: expand eq {extendedInfo}. This filter enables you to choose (or filter) specific items in the list of backup items.
- api-version required
Output
- output ProtectedItemResource
ProtectedItems_CreateOrUpdate
This operation enables an item to be backed up, or modifies the existing backup policy information for an item that has been backed up. This is an asynchronous operation. To learn the status of the operation, call the GetItemOperationResult API.
azure_recoveryservicesbackup.ProtectedItems_CreateOrUpdate({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"resourceProtectedItem": null
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The name of the backup item. - resourceProtectedItem required ProtectedItemResource
- api-version required
Output
Output schema unknown
Backups_Trigger
Triggers the backup job for the specified backup item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.
azure_recoveryservicesbackup.Backups_Trigger({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"resourceBackupRequest": null
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The name of backup item used in this POST operation. - resourceBackupRequest required BackupRequestResource
- api-version required
Output
Output schema unknown
ProtectedItemOperationResults_Get
Gets the result of any operation on the backup item.
azure_recoveryservicesbackup.ProtectedItemOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The name of backup item used in this GET operation. - operationId required
string
: The OperationID used in this GET operation.
- api-version required
Output
- output ProtectedItemResource
ProtectedItemOperationStatuses_Get
Gets the status of an operation such as triggering a backup or restore. The status can be: In progress, Completed, or Failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
azure_recoveryservicesbackup.ProtectedItemOperationStatuses_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The name of backup item used in this GET operation. - operationId required
string
: The OperationID used in this GET operation.
- api-version required
Output
- output OperationStatus
RecoveryPoints_List
Lists the recovery points, or backup copies, for the specified backup item.
azure_recoveryservicesbackup.RecoveryPoints_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup item. - containerName required
string
: The container name associated with the backup item. - protectedItemName required
string
: The name of backup item used in this GET operation. - $filter
string
: startDate eq {yyyy-mm-dd hh:mm:ss PM} and endDate { yyyy-mm-dd hh:mm:ss PM}.
- api-version required
Output
- output RecoveryPointResourceList
RecoveryPoints_Get
Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.
azure_recoveryservicesbackup.RecoveryPoints_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"recoveryPointId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with backup item. - containerName required
string
: The container name associated with backup item. - protectedItemName required
string
: The name of the backup item used in this GET operation. - recoveryPointId required
string
: The RecoveryPointID associated with this GET operation.
- api-version required
Output
- output RecoveryPointResource
ItemLevelRecoveryConnections_Provision
Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens File Explorer which displays the recoverable files and folders. This is an asynchronous operation. To get the provisioning status, call GetProtectedItemOperationResult API.
azure_recoveryservicesbackup.ItemLevelRecoveryConnections_Provision({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"recoveryPointId": "",
"resourceILRRequest": null
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup items. - containerName required
string
: The container name associated with the backup items. - protectedItemName required
string
: The name of the backup item whose files or folders are to be restored. - recoveryPointId required
string
: The recovery point ID for backup data. The iSCSI connection will be provisioned for this backup data. - resourceILRRequest required ILRRequestResource
- api-version required
Output
Output schema unknown
Restores_Trigger
Restores the specified backup data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.
azure_recoveryservicesbackup.Restores_Trigger({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"recoveryPointId": "",
"resourceRestoreRequest": null
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup items. - containerName required
string
: The container name associated with the backup items. - protectedItemName required
string
: The backup item to be restored. - recoveryPointId required
string
: The recovery point ID for the backup data to be restored. - resourceRestoreRequest required RestoreRequestResource
- api-version required
Output
Output schema unknown
ItemLevelRecoveryConnections_Revoke
Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.
azure_recoveryservicesbackup.ItemLevelRecoveryConnections_Revoke({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": "",
"containerName": "",
"protectedItemName": "",
"recoveryPointId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the backup items. The value allowed is Azure. - containerName required
string
: The container name associated with the backup items. - protectedItemName required
string
: The name of the backup items whose files or folders will be restored. - recoveryPointId required
string
: The string that identifies the recovery point. The iSCSI connection will be revoked for this protected data.
- api-version required
Output
Output schema unknown
ProtectionContainers_Refresh
Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the GetRefreshOperationResult API.
azure_recoveryservicesbackup.ProtectionContainers_Refresh({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"fabricName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - fabricName required
string
: The fabric name associated with the container.
- api-version required
Output
Output schema unknown
Jobs_List
Provides a pageable list of jobs.
azure_recoveryservicesbackup.Jobs_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: The following equation can be used to filter the list of jobs based on status, type, start date, and end date. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }. - $skipToken
string
: The Skip Token filter.
- api-version required
Output
- output JobResourceList
ExportJobsOperationResults_Get
Gets the result of the operation triggered by the ExportJob API.
azure_recoveryservicesbackup.ExportJobsOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - operationId required
string
: The ID associated with the export job.
- api-version required
Output
JobDetails_Get
Gets extended information associated with the job.
azure_recoveryservicesbackup.JobDetails_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"jobName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - jobName required
string
: Name of the job associated with this GET operation.
- api-version required
Output
- output JobResource
JobCancellations_Trigger
Cancels the job. This is an asynchronous operation. To know the status of the cancellation, call the GetCancelOperationResult API.
azure_recoveryservicesbackup.JobCancellations_Trigger({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"jobName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - jobName required
string
: Name of the job to cancel.
- api-version required
Output
Output schema unknown
JobOperationResults_Get
Gets the result of the operation.
azure_recoveryservicesbackup.JobOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"jobName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - jobName required
string
: Job name associated with this GET operation. - operationId required
string
: OperationID associated with this GET operation.
- api-version required
Output
Output schema unknown
Jobs_Export
Exports all jobs for a given Shared Access Signatures (SAS) URL. The SAS URL expires within 15 minutes of its creation.
azure_recoveryservicesbackup.Jobs_Export({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: The OData filter options. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }.
- api-version required
Output
Output schema unknown
BackupOperationResults_Get
Provides the status of the delete operations, for example, deleting a backup item. Once the operation starts, the response status code is Accepted. The response status code remains in this state until the operation reaches completion. On successful completion, the status code changes to OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.
azure_recoveryservicesbackup.BackupOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - operationId required
string
: The ID of the operation.
- api-version required
Output
Output schema unknown
BackupOperationStatuses_Get
Gets the status of an operation such as triggering a backup or restore. The status can be In progress, Completed or Failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.
azure_recoveryservicesbackup.BackupOperationStatuses_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - operationId required
string
: The ID of the operation.
- api-version required
Output
- output OperationStatus
ProtectionPolicies_List
Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.
azure_recoveryservicesbackup.ProtectionPolicies_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: The following equation can be used to filter the list of backup policies. backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}.
- api-version required
Output
- output ProtectionPolicyResourceList
ProtectionPolicies_Delete
Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
azure_recoveryservicesbackup.ProtectionPolicies_Delete({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"policyName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - policyName required
string
: The name of the backup policy to be deleted.
- api-version required
Output
Output schema unknown
ProtectionPolicies_Get
Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
azure_recoveryservicesbackup.ProtectionPolicies_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"policyName": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - policyName required
string
: The backup policy name used in this GET operation.
- api-version required
Output
- output ProtectionPolicyResource
ProtectionPolicies_CreateOrUpdate
Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
azure_recoveryservicesbackup.ProtectionPolicies_CreateOrUpdate({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"policyName": "",
"resourceProtectionPolicy": null
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - policyName required
string
: The backup policy to be created. - resourceProtectionPolicy required ProtectionPolicyResource
- api-version required
Output
- output ProtectionPolicyResource
ProtectionPolicyOperationResults_Get
Provides the result of an operation.
azure_recoveryservicesbackup.ProtectionPolicyOperationResults_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"policyName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - policyName required
string
: The backup policy name used in this GET operation. - operationId required
string
: The ID associated with this GET operation.
- api-version required
Output
- output ProtectionPolicyResource
ProtectionPolicyOperationStatuses_Get
Provides the status of the asynchronous operations like backup or restore. The status can be: in progress, completed, or failed. You can refer to the Operation Status enumeration for the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
azure_recoveryservicesbackup.ProtectionPolicyOperationStatuses_Get({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": "",
"policyName": "",
"operationId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - policyName required
string
: The backup policy name used in this GET operation. - operationId required
string
: The ID associated with this GET operation.
- api-version required
Output
- output OperationStatus
ProtectableItems_List
Based on the query filter and the pagination parameters, this operation provides a pageable list of objects within the subscription that can be protected.
azure_recoveryservicesbackup.ProtectableItems_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: Using the following query filters, you can sort a specific backup item based on: type of backup item, status, name of the item, and more. providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and status eq { NotProtected , Protecting , Protected } and friendlyName {name} and skipToken eq {string which provides the next set of list} and topToken eq {int} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. - $skipToken
string
: The Skip Token filter.
- api-version required
Output
ProtectedItems_List
Provides a pageable list of all items in a subscription, that can be protected.
azure_recoveryservicesbackup.ProtectedItems_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: itemType eq { VM , FileFolder , AzureSqlDb , SQLDB , Exchange , Sharepoint , DPMUnknown } and providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and policyName eq {policyName} and containerName eq {containername} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. - $skipToken
string
: The Skip Token filter.
- api-version required
Output
- output ProtectedItemResourceList
ProtectionContainers_List
Lists the containers registered to the Recovery Services vault.
azure_recoveryservicesbackup.ProtectionContainers_List({
"api-version": "",
"vaultName": "",
"resourceGroupName": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - vaultName required
string
: The name of the Recovery Services vault. - resourceGroupName required
string
: The name of the resource group associated with the Recovery Services vault. - subscriptionId required
string
: The subscription ID. - $filter
string
: The following equation is used to sort or filter the containers registered to the vault. providerType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql} and status eq {Unknown, NotRegistered, Registered, Registering} and friendlyName eq {containername} and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}.
- api-version required
Output
Definitions
AzureBackupServerEngine
- AzureBackupServerEngine
object
: The backup engine type when Azure Backup Server is used to manage the backups.- backupEngineId
string
: The ID of the backup engine. - backupEngineType
string
: The type of the backup engine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The type of backup management associated with the backup engine. - canReRegister
boolean
: The flag indicating whether the backup engine be registered again, once the engine has been initially registered. - friendlyName
string
: The friendly name of the backup engine. - healthStatus
string
: The backup status of the backup engine. - registrationStatus
string
: The status of the backup engine registration with the Recovery Services vault.
- backupEngineId
AzureIaaSClassicComputeVMContainer
- AzureIaaSClassicComputeVMContainer
object
: IaaS VM workload-specific backup item representing a classic-deployed virtual machine.- resourceGroup
string
: The resource group name associated with the Recovery Services vault. - virtualMachineId
string
: The fully qualified Resource Manager URL of the virtual machine represented by this Azure IaaS VM container. - virtualMachineVersion
string
: Specifies whether the container represents a classic or a Resource Manager-deployed virtual machine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the container. - containerType
string
: The type assigned to the container. The values to use for each of these properties are: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like Azure Backup Server and DPM) is Windows 4. Azure SQL instance is AzureSqlContainer. - friendlyName
string
: Friendly name of the container. - healthStatus
string
: The status of the container's health. - protectableObjectType
string
: The protectable object type associated with the container. - registrationStatus
string
: The container's registration status with the Recovery Services vault.
- resourceGroup
AzureIaaSClassicComputeVMProtectableItem
- AzureIaaSClassicComputeVMProtectableItem
object
: IaaS VM workload-specific backup item representing a classic VM.- virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine. - backupManagementType
string
: The backup management type. - friendlyName
string
: The friendly name of the backup item. - protectableItemType
string
: The type of the backup item. - protectionState
string
(values: Invalid, NotProtected, Protecting, Protected): The state of the back up item.
- virtualMachineId
AzureIaaSClassicComputeVMProtectedItem
- AzureIaaSClassicComputeVMProtectedItem
object
: IaaS VM workload-specific backup item representing the classic VM.- extendedInfo AzureIaaSVMProtectedItemExtendedInfo
- friendlyName
string
: The friendly name of the VM represented by this backup item. - lastBackupStatus
string
: The last backup operation status. The possible values are: Healthy or Unhealthy. - lastBackupTime
string
: The timestamp of the last backup operation for this backup item. - protectionState
string
(values: Invalid, IRPending, Protected, ProtectionError, ProtectionStopped, ProtectionPaused): The backup state of this backup item. - protectionStatus
string
: The backup status of this backup item. - virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine represented by this item. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type associated with the backup item. - lastRecoveryPoint
string
: The timestamp when the most recent backup copy was created for this backup item. - policyId
string
: The ID of the backup policy associated with this backup item. - protectedItemType
string
: The backup item type. - sourceResourceId
string
: The ID of the resource to be backed up. - workloadType
string
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, DPMUnknown): The workload type for this item.
AzureIaaSComputeVMContainer
- AzureIaaSComputeVMContainer
object
: IaaS VM workload-specific backup item representing a Resource Manager-deployed virtual machine.- resourceGroup
string
: The resource group name associated with the Recovery Services vault. - virtualMachineId
string
: The fully qualified Resource Manager URL of the virtual machine represented by this Azure IaaS VM container. - virtualMachineVersion
string
: Specifies whether the container represents a classic or a Resource Manager-deployed virtual machine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the container. - containerType
string
: The type assigned to the container. The values to use for each of these properties are: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like Azure Backup Server and DPM) is Windows 4. Azure SQL instance is AzureSqlContainer. - friendlyName
string
: Friendly name of the container. - healthStatus
string
: The status of the container's health. - protectableObjectType
string
: The protectable object type associated with the container. - registrationStatus
string
: The container's registration status with the Recovery Services vault.
- resourceGroup
AzureIaaSComputeVMProtectableItem
- AzureIaaSComputeVMProtectableItem
object
: IaaS VM workload-specific backup item representing a Resource Manager VM.- virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine. - backupManagementType
string
: The backup management type. - friendlyName
string
: The friendly name of the backup item. - protectableItemType
string
: The type of the backup item. - protectionState
string
(values: Invalid, NotProtected, Protecting, Protected): The state of the back up item.
- virtualMachineId
AzureIaaSComputeVMProtectedItem
- AzureIaaSComputeVMProtectedItem
object
: IaaS VM workload-specific backup item representing the Resource Manager VM.- extendedInfo AzureIaaSVMProtectedItemExtendedInfo
- friendlyName
string
: The friendly name of the VM represented by this backup item. - lastBackupStatus
string
: The last backup operation status. The possible values are: Healthy or Unhealthy. - lastBackupTime
string
: The timestamp of the last backup operation for this backup item. - protectionState
string
(values: Invalid, IRPending, Protected, ProtectionError, ProtectionStopped, ProtectionPaused): The backup state of this backup item. - protectionStatus
string
: The backup status of this backup item. - virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine represented by this item. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type associated with the backup item. - lastRecoveryPoint
string
: The timestamp when the most recent backup copy was created for this backup item. - policyId
string
: The ID of the backup policy associated with this backup item. - protectedItemType
string
: The backup item type. - sourceResourceId
string
: The ID of the resource to be backed up. - workloadType
string
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, DPMUnknown): The workload type for this item.
AzureIaaSVMErrorInfo
- AzureIaaSVMErrorInfo
object
: Azure IaaS VM workload-specific error information.- errorCode
integer
: Error code. - errorString
string
: Localized error string. - errorTitle
string
: Title: typically, the entity associated the error. - recommendations
array
: List of localized recommendations for the error string.- items
string
- items
- errorCode
AzureIaaSVMJob
- AzureIaaSVMJob
object
: The Azure IaaS VM workload-specific job object.- actionsInfo
array
: Gets or sets the state, or actions, applicable on this job. Examples of the actions are: Cancel or Retry.- items
string
(values: Invalid, Cancellable, Retriable)
- items
- duration
string
: The time that elapsed during the execution of this job. - errorDetails
array
: Error details about this job.- items AzureIaaSVMErrorInfo
- extendedInfo AzureIaaSVMJobExtendedInfo
- virtualMachineVersion
string
: Specifies whether the backup item is a Classic VM or a Resource Manager VM. - activityId
string
: ActivityId of job. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the current job. - endTime
string
: The end time. - entityFriendlyName
string
: The friendly name of the entity on which the current job is executing. - jobType
string
: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. - operation
string
: The operation name. - startTime
string
: The start time. - status
string
: The job status.
- actionsInfo
AzureIaaSVMJobExtendedInfo
- AzureIaaSVMJobExtendedInfo
object
: Additional information for the Azure IaaS VM workload-specific job.- dynamicErrorMessage
string
: Non-localized error message for job execution. - progressPercentage
number
: Indicates progress of the job. Null if it has not started or completed. - propertyBag
object
: Job properties. - tasksList
array
: List of tasks associated with this job.
- dynamicErrorMessage
AzureIaaSVMJobTaskDetails
- AzureIaaSVMJobTaskDetails
object
: Azure IaaS VM workload-specific job task details.- duration
string
: The time elapsed for the task. - endTime
string
: The end time. - instanceId
string
: The instance ID. - progressPercentage
number
: The progress of the task, as a percentage. - startTime
string
: The start time. - status
string
: The status. - taskId
string
: The task display name.
- duration
AzureIaaSVMProtectedItem
- AzureIaaSVMProtectedItem
object
: This Azure VM workload-specific (also known as IaaS VM workload-specific) backup item has been backed up.- extendedInfo AzureIaaSVMProtectedItemExtendedInfo
- friendlyName
string
: The friendly name of the VM represented by this backup item. - lastBackupStatus
string
: The last backup operation status. The possible values are: Healthy or Unhealthy. - lastBackupTime
string
: The timestamp of the last backup operation for this backup item. - protectionState
string
(values: Invalid, IRPending, Protected, ProtectionError, ProtectionStopped, ProtectionPaused): The backup state of this backup item. - protectionStatus
string
: The backup status of this backup item. - virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine represented by this item. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type associated with the backup item. - lastRecoveryPoint
string
: The timestamp when the most recent backup copy was created for this backup item. - policyId
string
: The ID of the backup policy associated with this backup item. - protectedItemType
string
: The backup item type. - sourceResourceId
string
: The ID of the resource to be backed up. - workloadType
string
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, DPMUnknown): The workload type for this item.
AzureIaaSVMProtectedItemExtendedInfo
- AzureIaaSVMProtectedItemExtendedInfo
object
: Additional information for the Azure VM (also known as IaaS VM)-specific backup item.- oldestRecoveryPoint
string
: The oldest backup copy available for this backup item. - policyInconsistent
boolean
: Specifies if the backup policy associated with the backup item is inconsistent. - recoveryPointCount
integer
: The number of backup copies available for this backup item.
- oldestRecoveryPoint
AzureIaaSVMProtectionPolicy
- AzureIaaSVMProtectionPolicy
object
: Azure VM (also known as IaaS VM) workload-specific backup policy.- retentionPolicy RetentionPolicy
- schedulePolicy SchedulePolicy
- backupManagementType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. - protectedItemsCount
integer
: The number of items associated with this policy.
AzureSqlContainer
- AzureSqlContainer
object
: Azure SQL workload-specific container.- backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the container. - containerType
string
: The type assigned to the container. The values to use for each of these properties are: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like Azure Backup Server and DPM) is Windows 4. Azure SQL instance is AzureSqlContainer. - friendlyName
string
: Friendly name of the container. - healthStatus
string
: The status of the container's health. - protectableObjectType
string
: The protectable object type associated with the container. - registrationStatus
string
: The container's registration status with the Recovery Services vault.
- backupManagementType
AzureSqlProtectedItem
- AzureSqlProtectedItem
object
: This is an Azure SQL workload-specific backup item.- extendedInfo AzureSqlProtectedItemExtendedInfo
- protectedItemDataId
string
: The internal ID of a backup item. The internal ID is used by the Azure SQL Backup engine to contact Recovery Services. - protectionState
string
(values: Invalid, IRPending, Protected, ProtectionError, ProtectionStopped, ProtectionPaused): The backup state of the backup item. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type associated with the backup item. - lastRecoveryPoint
string
: The timestamp when the most recent backup copy was created for this backup item. - policyId
string
: The ID of the backup policy associated with this backup item. - protectedItemType
string
: The backup item type. - sourceResourceId
string
: The ID of the resource to be backed up. - workloadType
string
(values: Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, DPMUnknown): The workload type for this item.
AzureSqlProtectedItemExtendedInfo
- AzureSqlProtectedItemExtendedInfo
object
: Additional information for the Azure SQL specific backup item.- oldestRecoveryPoint
string
: The oldest backup copy available for this item in the service. - policyState
string
: The state of the backup policy associated with this backup item. - recoveryPointCount
integer
: The number of available backup copies for this backup item.
- oldestRecoveryPoint
AzureSqlProtectionPolicy
- AzureSqlProtectionPolicy
object
: The Azure SQL workload-specific backup policy.- retentionPolicy RetentionPolicy
- backupManagementType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. - protectedItemsCount
integer
: The number of items associated with this policy.
BEKDetails
- BEKDetails
object
: BEK is Bitlocker Encryption Key.- secretData
string
: Bitlocker Encryption Key (BEK) data. - secretUrl
string
: Secret refers to Bitlocker Encryption Key (BEK). The Secret can be unlocked by the key (or KEK). - secretVaultId
string
: ID of the Key Vault where this Secret is stored.
- secretData
BMSBackupEngineQueryObject
- BMSBackupEngineQueryObject
object
: The query parameters used to GET the list of backup engines.- backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type associated with the backup engine.
- backupManagementType
BMSContainerQueryObject
- BMSContainerQueryObject
object
: The query filters that can be used with the list containers API.- backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for this container. - friendlyName
string
: The friendly name of the container. - status
string
: The status of the container's registration with the Recovery Services vault.
- backupManagementType
BMSPOQueryObject
- BMSPOQueryObject
object
: Filters the list of backup items.- backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type. - friendlyName
string
: The friendly name for the item. - status
string
: The backup status query parameter.
- backupManagementType
BMSRPQueryObject
- BMSRPQueryObject
object
: Filters the list of backup copies based on the property.- endDate
string
: Use backup copies created before this time. - startDate
string
: Use backup copies created after this time.
- endDate
BackupEngineBase
- BackupEngineBase
object
: The base backup engine class. All workload-specific backup engines derive from this class.- backupEngineId
string
: The ID of the backup engine. - backupEngineType
string
: The type of the backup engine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The type of backup management associated with the backup engine. - canReRegister
boolean
: The flag indicating whether the backup engine be registered again, once the engine has been initially registered. - friendlyName
string
: The friendly name of the backup engine. - healthStatus
string
: The backup status of the backup engine. - registrationStatus
string
: The status of the backup engine registration with the Recovery Services vault.
- backupEngineId
BackupEngineBaseResource
- BackupEngineBaseResource
object
: The base backup engine class. All workload-specific backup engines derive from this class.- properties BackupEngineBase
- eTag
string
: Optional ETag. - id
string
: Resource ID represents the complete path to the resource. - location
string
: Resource location. - name
string
: Resource name associated with the resource. - tags
object
: Resource tags. - type
string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
BackupEngineBaseResourceList
- BackupEngineBaseResourceList
object
: List of BackupEngineBase resources- value
array
: List of resources.- items BackupEngineBaseResource
- nextLink
string
: The URI to GET the next page of resources. Call ListNext() gets the next page of resources.
- value
BackupRequest
- BackupRequest
object
: The base class for a backup request. Workload-specific backup requests are derived from this class.- objectType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.
- objectType
BackupRequestResource
- BackupRequestResource
object
: Base class for the backup request. Workload-specific backup requests are derived from this class.- properties BackupRequest
- eTag
string
: Optional ETag. - id
string
: Resource ID represents the complete path to the resource. - location
string
: Resource location. - name
string
: Resource name associated with the resource. - tags
object
: Resource tags. - type
string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
ClientScriptForConnect
- ClientScriptForConnect
object
: Client script details for the file or folder restore.- osType
string
: The operating system platform ("Windows" or "Linux") for which this file or folder restore client script works. - scriptContent
string
: File content of the client script for file or folder restore. - scriptExtension
string
: File extension of the client script for the file or folder restore. Some examples of the extension are: .ps1 and .sh.
- osType
DailyRetentionFormat
- DailyRetentionFormat
object
: Daily retention format.- daysOfTheMonth
array
: List of days of the month.- items Day
- daysOfTheMonth
DailyRetentionSchedule
- DailyRetentionSchedule
object
: Daily retention schedule.- retentionDuration RetentionDuration
- retentionTimes
array
: The retention times of retention policy.- items
string
- items
Day
- Day
object
: Day of the week.- date
integer
- isLast
boolean
- date
DpmBackupEngine
- DpmBackupEngine
object
: The backup engine type when Data Protection Manager (DPM) is used to manage backups.- backupEngineId
string
: The ID of the backup engine. - backupEngineType
string
: The type of the backup engine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The type of backup management associated with the backup engine. - canReRegister
boolean
: The flag indicating whether the backup engine be registered again, once the engine has been initially registered. - friendlyName
string
: The friendly name of the backup engine. - healthStatus
string
: The backup status of the backup engine. - registrationStatus
string
: The status of the backup engine registration with the Recovery Services vault.
- backupEngineId
DpmErrorInfo
- DpmErrorInfo
object
: DPM workload-specific error information.- errorString
string
: Localized error string. - recommendations
array
: The list of localized recommendations for the error string.- items
string
- items
- errorString
DpmJob
- DpmJob
object
: The DPM workload-specific job object.- actionsInfo
array
: The state or actions applicable on this job, such as Cancel or Retry.- items
string
(values: Invalid, Cancellable, Retriable)
- items
- containerName
string
: The name of the cluster or server protecting the current backup item, if any. - containerType
string
: The type of container. - dpmServerName
string
: DPM server name managing the backup item or backup job. - duration
string
: The time elapsed for the job. - errorDetails
array
: The errors.- items DpmErrorInfo
- extendedInfo DpmJobExtendedInfo
- workloadType
string
: The type of backup item. - activityId
string
: ActivityId of job. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the current job. - endTime
string
: The end time. - entityFriendlyName
string
: The friendly name of the entity on which the current job is executing. - jobType
string
: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. - operation
string
: The operation name. - startTime
string
: The start time. - status
string
: The job status.
- actionsInfo
DpmJobExtendedInfo
- DpmJobExtendedInfo
object
: Additional information on the DPM workload-specific job.- dynamicErrorMessage
string
: Non-localized error message on job execution. - propertyBag
object
: The job properties. - tasksList
array
: List of tasks associated with this job.- items DpmJobTaskDetails
- dynamicErrorMessage
DpmJobTaskDetails
- DpmJobTaskDetails
object
: DPM workload-specific job task details.- duration
string
: The time elapsed for task. - endTime
string
: The end time. - startTime
string
: The start time. - status
string
: The status. - taskId
string
: The task display name.
- duration
EncryptionDetails
- EncryptionDetails
object
: Details needed if the VM was encrypted at the time of backup.- encryptionEnabled
boolean
: Identifies whether the backup copy represents an encrypted VM at the time of backup. - kekUrl
string
: URL of the Key Encryption Key (KEK). - kekVaultId
string
: The ID of Key Vault where the Key Encryption Key (KEK) is stored. - secretKeyUrl
string
: URL of the Bitlocker Encryption Key (BEK). - secretKeyVaultId
string
: The ID of Key Vault where the Bitlocker Encryption Key (BEK), or Secret, is stored.
- encryptionEnabled
ExportJobsOperationResultInfo
- ExportJobsOperationResultInfo
object
: This class is used to send blob details after exporting jobs.- blobSasKey
string
: The Shared Access Signatures (SAS) key used to access the blob. The key expires after 15 minutes. - blobUrl
string
: The URL of the blob. The serialized string, which is the list of jobs, is exported to this URL. - objectType
string
: This property is the discriminator for deciding between the specific types in the polymorphic chain of types.
- blobSasKey
GenericRecoveryPoint
- GenericRecoveryPoint
object
: Generic backup copy.- friendlyName
string
: Friendly name of the backup copy. - recoveryPointAdditionalInfo
string
: Additional information associated with this backup copy. - recoveryPointTime
string
: The time when this backup copy was created. - recoveryPointType
string
: Type of the backup copy. - objectType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.
- friendlyName
GetProtectedItemQueryObject
- GetProtectedItemQueryObject
object
: This object filters the list of backup items.- expand
string
: Specifies if the additional information should be provided for this item.
- expand
ILRRequest
- ILRRequest
object
: Parameters to restore file or folders API.- objectType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.
- objectType
ILRRequestResource
- ILRRequestResource
object
: The parameters to restore files or folders.- properties ILRRequest
- eTag
string
: Optional ETag. - id
string
: Resource ID represents the complete path to the resource. - location
string
: Resource location. - name
string
: Resource name associated with the resource. - tags
object
: Resource tags. - type
string
: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
IaaSVMContainer
- IaaSVMContainer
object
: IaaS VM workload-specific container.- resourceGroup
string
: The resource group name associated with the Recovery Services vault. - virtualMachineId
string
: The fully qualified Resource Manager URL of the virtual machine represented by this Azure IaaS VM container. - virtualMachineVersion
string
: Specifies whether the container represents a classic or a Resource Manager-deployed virtual machine. - backupManagementType
string
(values: Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql): The backup management type for the container. - containerType
string
: The type assigned to the container. The values to use for each of these properties are: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like Azure Backup Server and DPM) is Windows 4. Azure SQL instance is AzureSqlContainer. - friendlyName
string
: Friendly name of the container. - healthStatus
string
: The status of the container's health. - protectableObjectType
string
: The protectable object type associated with the container. - registrationStatus
string
: The container's registration status with the Recovery Services vault.
- resourceGroup
IaaSVMProtectableItem
- IaaSVMProtectableItem
object
: This Azure VM workload-specific (also known as IaaS VM workload-specific) backup item can be backed up.- virtualMachineId
string
: The fully qualified Resource Manager ID of the virtual machine. - backupManagementType
string
: The backup management type. - friendlyName
string
: The friendly name of the backup item. - protectableItemType
string
: The type of the backup item. - protectionState
string
(values: Invalid, NotProtected, Protecting, Protected): The state of the back up item.
- virtualMachineId
IaasVMBackupRequest
- IaasVMBackupRequest
object
: This is an Azure VM (also known as IaaS VM) workload-specific backup request.- recoveryPointExpiryTimeInUTC
string
: The backup copy will expire after the time specified. The time is in UTC format. - objectType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.
- recoveryPointExpiryTimeInUTC
IaasVMILRRegistrationRequest
- IaasVMILRRegistrationRequest
object
: Restore files or folders from a backup copy, or recovery point, of an IaaS (or Azure) VM.- initiatorName
string
: The iSCSI initiator name. - recoveryPointId
string
: The ID of the IaaS VM recovery point used to restore the files or folders. - renewExistingRegistration
boolean
: Whether to renew the existing registration with the iSCSI server. - virtualMachineId
string
: The fully qualified Resource Manager ID of the VM used to restore the files or folders. - objectType
string
: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.
- initiatorName
IaasVMRecoveryPoint
- IaasVMRecoveryPoint
object
: Azure VM (also known as IaaS VM)