swagger: '2.0'
info:
version: 2022-09-30-preview
title: Microsoft Azure RecoveryServicesBackupClient
x-ms-code-generation-settings:
internalConstructors: false
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
: get:
tags:
- BackupResourceStorageConfigsNonCRR
description: Fetches resource storage config.
operationId: microsoftAzureBackupresourcestorageconfigsnoncrrGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceConfigResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get Vault Storage Configuration:
$ref: ./examples/Common/BackupStorageConfig_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig
put:
tags:
- BackupResourceStorageConfigsNonCRR
description: Updates vault storage model type.
operationId: microsoftAzureBackupresourcestorageconfigsnoncrrUpdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Vault storage config request
required: true
schema:
$ref: '#/definitions/BackupResourceConfigResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceConfigResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Update Vault Storage Configuration:
$ref: ./examples/Common/BackupStorageConfig_Put.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig
patch:
tags:
- BackupResourceStorageConfigsNonCRR
description: Updates vault storage model type.
operationId: microsoftAzureBackupresourcestorageconfigsnoncrrPatch
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Vault storage config request
required: true
schema:
$ref: '#/definitions/BackupResourceConfigResource'
responses:
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Update Vault Storage Configuration:
$ref: ./examples/Common/BackupStorageConfig_Patch.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig
/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection:
post:
tags:
- ProtectionIntent
summary: "Microsoft Azure It Will Validate Followings\r\n1 Vault Capacity\r\n2 Vm Is Already Protected\r\n3 Any Vm Related Configuration Passed In Properties"
operationId: microsoftAzureProtectionintentValidate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/AzureRegion'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Enable backup validation request on Virtual Machine
required: true
schema:
$ref: '#/definitions/PreValidateEnableBackupRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PreValidateEnableBackupResponse'
x-ms-examples:
Validate Enable Protection on Azure Vm:
$ref: ./examples/AzureIaasVm/ProtectionIntent_Validate.json
description: Needs a more full description created.
/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus:
post:
tags:
- BackupStatus
summary: Microsoft Azure Get The Container Backup Status
operationId: microsoftAzureBackupstatusGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/AzureRegion'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Container Backup Status Request
required: true
schema:
$ref: '#/definitions/BackupStatusRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupStatusResponse'
x-ms-examples:
Get Azure Virtual Machine Backup Status:
$ref: ./examples/AzureIaasVm/GetBackupStatus.json
description: Needs a more full description created.
/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures:
post:
tags:
- FeatureSupport
summary: >-
Microsoft Azure It Will Validate If Given Feature With Resource Properties Is Supported In Service
operationId: microsoftAzureFeaturesupportValidate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/AzureRegion'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Feature support request object
required: true
schema:
$ref: '#/definitions/FeatureSupportRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AzureVMResourceFeatureSupportResponse'
x-ms-examples:
Check Azure Vm Backup Feature Support:
$ref: ./examples/AzureIaasVm/BackupFeature_Validate.json
description: Needs a more full description created.
? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
: get:
tags:
- ProtectionIntent
description: >-
Provides the details of the protection intent up item. This is an
asynchronous operation. To know the status of the operation,
call the
GetItemOperationResult API.
operationId: microsoftAzureProtectionintentGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up item.
required: true
type: string
- name: intentObjectName
in: path
description: Backed up item name whose details are to be fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionIntentResource'
x-ms-examples:
Get ProtectionIntent for an item:
$ref: ./examples/AzureWorkload/BackupProtectionIntent_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Backupprotectionintent Intentobjectname
put:
tags:
- ProtectionIntent
description: >-
Create Intent for Enabling backup of an item. This is a synchronous
operation.
operationId: microsoftAzureProtectionintentCreateorupdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backup item.
required: true
type: string
- name: intentObjectName
in: path
description: Intent object name.
required: true
type: string
- name: parameters
in: body
description: resource backed up item
required: true
schema:
$ref: '#/definitions/ProtectionIntentResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionIntentResource'
x-ms-examples:
Create or Update Azure Vm Protection Intent:
$ref: ./examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Backupprotectionintent Intentobjectname
delete:
tags:
- ProtectionIntent
description: Used to remove intent from an item
operationId: microsoftAzureProtectionintentDelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the intent.
required: true
type: string
- name: intentObjectName
in: path
description: Intent to be deleted.
required: true
type: string
responses:
'204':
description: NoContent
x-ms-examples:
Delete Protection intent from item:
$ref: ./examples/AzureWorkload/BackupProtectionIntent_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Backupprotectionintent Intentobjectname
? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents
: get:
tags:
- BackupProtectionIntent
description: Provides a pageable list of all intents that are present within a vault.
operationId: microsoftAzureBackupprotectionintentList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionIntentResourceList'
x-ms-odata: '#/definitions/ProtectionIntentQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List protection intent with backupManagementType filter:
$ref: ./examples/AzureWorkload/BackupProtectionIntent_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupprotectionintents
? /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries
: get:
tags:
- BackupUsageSummaries
description: Fetches the backup management usage summaries of the vault.
operationId: microsoftAzureBackupusagesummariesList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupManagementUsageList'
x-ms-odata: '#/definitions/BMSBackupSummariesQueryObject'
x-ms-pageable:
nextLinkName:
x-ms-examples:
Get Protected Items Usages Summary:
$ref: ./examples/Common/BackupProtectedItem_UsageSummary_Get.json
Get Protected Containers Usages Summary:
$ref: ./examples/Common/BackupProtectionContainers_UsageSummary_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupusagesummaries
/providers/Microsoft.RecoveryServices/operations:
get:
tags:
- Operations
description: Returns the list of available operations.
operationId: microsoftAzureOperationsList
parameters:
- $ref: '#/parameters/ApiVersion'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClientDiscoveryResponse'
x-ms-pageable:
nextLinkName: nextLink
itemName: value
x-ms-examples:
ListOperations:
$ref: ./examples/ListOperations.json
summary: Microsoft Azure Get Providers Microsoft Recoveryservices Operations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
: get:
tags:
- BackupResourceVaultConfigs
description: Fetches resource vault config.
operationId: microsoftAzureBackupresourcevaultconfigsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceVaultConfigResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get Vault Security Config:
$ref: ./examples/Common/BackupResourceVaultConfigs_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupconfig Vaultconfig
patch:
tags:
- BackupResourceVaultConfigs
description: Updates vault security config.
operationId: microsoftAzureBackupresourcevaultconfigsUpdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: resource config request
required: true
schema:
$ref: '#/definitions/BackupResourceVaultConfigResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceVaultConfigResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Update Vault Security Config:
$ref: ./examples/Common/BackupResourceVaultConfigs_Patch.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupconfig Vaultconfig
put:
tags:
- BackupResourceVaultConfigs
description: 'Updates vault security config. '
operationId: microsoftAzureBackupresourcevaultconfigsPut
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: resource config request
required: true
schema:
$ref: '#/definitions/BackupResourceVaultConfigResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceVaultConfigResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Update Vault Security Config:
$ref: ./examples/Common/BackupResourceVaultConfigs_Put.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupconfig Vaultconfig
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig
: get:
tags:
- BackupResourceEncryptionConfigs
description: Fetches Vault Encryption config.
operationId: microsoftAzureBackupresourceencryptionconfigsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupResourceEncryptionConfigExtendedResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get Vault Encryption Configuration:
$ref: ./examples/BackupResourceEncryptionConfig_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupencryptionconfigs Backupresourceencryptionconfig
put:
tags:
- BackupResourceEncryptionConfigs
description: Updates Vault encryption config.
operationId: microsoftAzureBackupresourceencryptionconfigsUpdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Vault encryption input config request
required: true
schema:
$ref: '#/definitions/BackupResourceEncryptionConfigResource'
responses:
'200':
description: OK
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Update Vault Encryption Configuration:
$ref: ./examples/BackupResourceEncryptionConfig_Put.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupencryptionconfigs Backupresourceencryptionconfig
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- PrivateEndpointConnection
description: Get Private Endpoint Connection. This call is made by Backup Admin.
operationId: microsoftAzurePrivateendpointconnectionGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: privateEndpointConnectionName
in: path
description: The name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get PrivateEndpointConnection:
$ref: >-
./examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname
put:
tags:
- PrivateEndpointConnection
description: >-
Approve or Reject Private Endpoint requests. This call is made by Backup
Admin.
operationId: microsoftAzurePrivateendpointconnectionPut
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: privateEndpointConnectionName
in: path
description: The name of the private endpoint connection.
required: true
type: string
- name: parameters
in: body
description: Request body for operation
required: true
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
'201':
description: Created
schema:
$ref: '#/definitions/PrivateEndpointConnectionResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Update PrivateEndpointConnection:
$ref: >-
./examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname
delete:
tags:
- PrivateEndpointConnection
description: Delete Private Endpoint requests. This call is made by Backup Admin.
operationId: microsoftAzurePrivateendpointconnectionDelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: privateEndpointConnectionName
in: path
description: The name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Delete PrivateEndpointConnection:
$ref: >-
./examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Privateendpointconnections Privateendpointconnectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}/operationsStatus/{operationId}
: get:
tags:
- PrivateEndpoint
summary: 'Microsoft Azure Gets The Operation Status For A Private Endpoint Connection'
operationId: microsoftAzurePrivateendpointGetoperationstatus
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: privateEndpointConnectionName
in: path
description: The name of the private endpoint connection.
required: true
type: string
- name: operationId
in: path
description: Operation id
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get OperationStatus:
$ref: >-
./examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}
: get:
tags:
- DataMove
description: Fetches operation status for data move operation on vault
operationId: microsoftAzureGetoperationstatus
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get OperationStatus:
$ref: ./examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Operationstatus Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove
: post:
tags:
- DataMove
description: Prepares source vault for Data Move operation
operationId: microsoftAzureBmspreparedatamove
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Prepare data move request
required: true
schema:
$ref: '#/definitions/PrepareDataMoveRequest'
responses:
'200':
description: OK
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-long-running-operation: true
x-ms-examples:
Prepare Data Move:
$ref: ./examples/BackupDataMove/PrepareDataMove_Post.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Preparedatamove
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationResults/{operationId}
: get:
tags:
- BMSPrepareDataMoveOperationResult
description: Fetches Operation Result for Prepare Data Move
operationId: microsoftAzureBmspreparedatamoveoperationresultGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/VaultStorageConfigOperationResultResponse'
'202':
description: Accepted
default:
description: 'Error response describing why the operation failed. '
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-examples:
Get operation result for PrepareDataMove:
$ref: ./examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove
: post:
tags:
- DataMove
description: Triggers Data Move Operation on target vault
operationId: microsoftAzureBmstriggerdatamove
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: Trigger data move request
required: true
schema:
$ref: '#/definitions/TriggerDataMoveRequest'
responses:
'200':
description: OK
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/NewErrorResponse'
x-ms-long-running-operation: true
x-ms-examples:
Trigger Data Move:
$ref: ./examples/BackupDataMove/TriggerDataMove_Post.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Triggerdatamove
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
: get:
tags:
- ProtectedItems
description: >-
Provides the details of the backed up item. This is an asynchronous
operation. To know the status of the operation,
call the
GetItemOperationResult API.
operationId: microsoftAzureProtecteditemsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up item.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item name whose details are to be fetched.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectedItemResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/GetProtectedItemQueryObject'
x-ms-examples:
Get Protected Classic Virtual Machine Details:
$ref: ./examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json
Get Protected Virtual Machine Details:
$ref: ./examples/AzureIaasVm/Compute_ProtectedItem_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname
put:
tags:
- ProtectedItems
description: >-
Enables backup of an item or to modifies the backup policy information
of an already backed up item. This is an
asynchronous operation. To
know the status of the operation, call the GetItemOperationResult API.
operationId: microsoftAzureProtecteditemsCreateorupdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backup item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backup item.
required: true
type: string
- name: protectedItemName
in: path
description: Item name to be backed up.
required: true
type: string
- name: parameters
in: body
description: resource backed up item
required: true
schema:
$ref: '#/definitions/ProtectedItemResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectedItemResource'
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Enable Protection on Azure IaasVm:
$ref: ./examples/AzureIaasVm/ConfigureProtection.json
Stop Protection with retain data on Azure IaasVm:
$ref: ./examples/AzureIaasVm/StopProtection.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname
delete:
tags:
- ProtectedItems
description: >-
Used to disable backup of an item within a container. This is an
asynchronous operation. To know the status of the
request, call the
GetItemOperationResult API.
operationId: microsoftAzureProtecteditemsDelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up item.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item to be deleted.
required: true
type: string
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Delete Protection from Azure Virtual Machine:
$ref: ./examples/Common/ProtectedItem_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}
: get:
tags:
- ProtectedItemOperationResults
description: Fetches the result of any operation on the backup item.
operationId: microsoftAzureProtecteditemoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backup item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backup item.
required: true
type: string
- name: protectedItemName
in: path
description: Backup item name whose details are to be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
OperationID which represents the operation whose result needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectedItemResource'
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Operation Results of Protected Vm:
$ref: ./examples/AzureIaasVm/ProtectedItemOperationResults.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints
: get:
tags:
- RecoveryPoints
description: Lists the backup copies for the backed up item.
operationId: microsoftAzureRecoverypointsList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up item.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item whose backup copies are to be fetched.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/RecoveryPointResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSRPQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get Protected Azure Vm Recovery Points:
$ref: ./examples/AzureIaasVm/RecoveryPoints_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
: get:
tags:
- RecoveryPoints
description: >-
Provides the information of the backed up data identified using
RecoveryPointID. This is an asynchronous operation.
To know the
status of the operation, call the GetProtectedItemOperationResult API.
operationId: microsoftAzureRecoverypointsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with backed up item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with backed up item.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item name whose backup data needs to be fetched.
required: true
type: string
- name: recoveryPointId
in: path
description: RecoveryPointID represents the backed up data to be fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/RecoveryPointResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Azure Vm Recovery Point Details:
$ref: ./examples/AzureIaasVm/RecoveryPoints_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore
: post:
tags:
- Restores
description: >-
Restores the specified backed up data. This is an asynchronous
operation. To know the status of this API call,
use
GetProtectedItemOperationResult API.
operationId: microsoftAzureRestoresTrigger
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up items.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up items.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item to be restored.
required: true
type: string
- name: recoveryPointId
in: path
description: >-
Recovery point ID which represents the backed up data to be
restored.
required: true
type: string
- name: parameters
in: body
description: resource restore request
required: true
schema:
$ref: '#/definitions/RestoreRequestResource'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Restore to New Azure IaasVm with IaasVMRestoreRequest:
$ref: ./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json
Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails:
$ref: >-
./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest:
$ref: >-
./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json
Restore Disks with IaasVMRestoreRequest:
$ref: >-
./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json
Restore Disks with IaasVMRestoreRequest with IdentityBasedRestoreDetails:
$ref: >-
./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json
Restore Disks with IaasVMRestoreWithRehydrationRequest:
$ref: >-
./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid Restore
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
: get:
tags:
- BackupPolicies
description: >-
Lists of backup policies associated with Recovery Services Vault. API
provides pagination parameters to fetch
scoped results.
operationId: microsoftAzureBackuppoliciesList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionPolicyResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/ProtectionPolicyQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List protection policies with backupManagementType filter as AzureIaasVm:
$ref: ./examples/AzureIaasVm/BackupPolicies_List.json
List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies:
$ref: ./examples/AzureIaasVm/V2Policy/v2-List-Policies.json
List protection policies with backupManagementType filter as AzureWorkload:
$ref: ./examples/AzureWorkload/BackupPolicies_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
: get:
tags:
- ProtectionPolicies
description: >-
Provides the details of the backup policies associated to Recovery
Services Vault. This is an asynchronous
operation. Status of the
operation can be fetched using GetPolicyOperationResult API.
operationId: microsoftAzureProtectionpoliciesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: policyName
in: path
description: Backup policy information to be fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionPolicyResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Azure IaasVm Protection Policy Details:
$ref: ./examples/AzureIaasVm/ProtectionPolicies_Get.json
Get Azure IaasVm Enhanced Protection Policy Details:
$ref: ./examples/AzureIaasVm/V2Policy/v2-Get-Policy.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies Policyname
put:
tags:
- ProtectionPolicies
description: >-
Creates or modifies a backup policy. This is an asynchronous operation.
Status of the operation can be fetched
using GetPolicyOperationResult
API.
operationId: microsoftAzureProtectionpoliciesCreateorupdate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: policyName
in: path
description: Backup policy to be created.
required: true
type: string
- name: parameters
in: body
description: resource backup policy
required: true
schema:
$ref: '#/definitions/ProtectionPolicyResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionPolicyResource'
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Create or Update Simple Azure Vm Protection Policy:
$ref: ./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json
Create or Update Full Azure Vm Protection Policy:
$ref: >-
./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json
Create or Update Enhanced Azure Vm Protection Policy with Hourly backup:
$ref: ./examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json
Create or Update Enhanced Azure Vm Protection Policy with daily backup:
$ref: ./examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json
Create or Update Full Azure Workload Protection Policy:
$ref: >-
./examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json
Create or Update Daily Azure Storage Protection Policy:
$ref: ./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json
Create or Update Hourly Azure Storage Protection Policy:
$ref: >-
./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies Policyname
delete:
tags:
- ProtectionPolicies
description: >-
Deletes specified backup policy from your Recovery Services Vault. This
is an asynchronous operation. Status of the
operation can be fetched
using GetProtectionPolicyOperationResult API.
operationId: microsoftAzureProtectionpoliciesDelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: policyName
in: path
description: Backup policy to be deleted.
required: true
type: string
responses:
'200':
description: OK
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Delete Azure Vm Protection Policy:
$ref: ./examples/AzureIaasVm/ProtectionPolicies_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies Policyname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}
: get:
tags:
- ProtectionPolicyOperationResults
description: Provides the result of an operation.
operationId: microsoftAzureProtectionpolicyoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: policyName
in: path
description: Backup policy name whose operation's result needs to be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
Operation ID which represents the operation whose result needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionPolicyResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Protection Policy Operation Results:
$ref: ./examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies Policyname Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs
: get:
tags:
- BackupJobs
description: Provides a pageable list of jobs.
operationId: microsoftAzureBackupjobsList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/JobResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/JobQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List All Jobs:
$ref: ./examples/Common/ListJobs.json
List Jobs With Filters:
$ref: ./examples/Common/ListJobsWithAllSupportedFilters.json
List Jobs With Time Filter:
$ref: ./examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobs
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}
: get:
tags:
- JobDetails
description: Gets extended information associated with the job.
operationId: microsoftAzureJobdetailsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: jobName
in: path
description: Name of the job whose details are to be fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/JobResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Job Details:
$ref: ./examples/Common/GetJobDetails.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobs Jobname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel
: post:
tags:
- JobCancellations
description: >-
Cancels a job. This is an asynchronous operation. To know the status of
the cancellation, call
GetCancelOperationResult API.
operationId: microsoftAzureJobcancellationsTrigger
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: jobName
in: path
description: Name of the job to cancel.
required: true
type: string
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Cancel Job:
$ref: ./examples/Common/TriggerCancelJob.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobs Jobname Cancel
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}
: get:
tags:
- JobOperationResults
description: Fetches the result of any operation.
operationId: microsoftAzureJoboperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: jobName
in: path
description: Job name whose operation result has to be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
OperationID which represents the operation whose result has to be
fetched.
required: true
type: string
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Cancel Job Operation Result:
$ref: ./examples/Common/CancelJobOperationResult.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobs Jobname Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}
: get:
tags:
- ExportJobsOperationResults
description: >-
Gets the operation result of operation triggered by Export Jobs API. If
the operation is successful, then it also
contains URL of a Blob and
a SAS key to access the same. The blob contains exported jobs in JSON
serialized format.
operationId: microsoftAzureExportjobsoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
description: OperationID which represents the export job.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationResultInfoBaseResource'
'202':
description: Accepted
schema:
$ref: '#/definitions/OperationResultInfoBaseResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Export Jobs Operation Results:
$ref: ./examples/Common/ExportJobsOperationResult.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobs Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
: post:
tags:
- Jobs
description: >-
Triggers export of jobs specified by filters and returns an OperationID
to track.
operationId: microsoftAzureJobsExport
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/JobQueryObject'
x-ms-examples:
Export Jobs:
$ref: ./examples/Common/TriggerExportJobs.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobsexport
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
: get:
tags:
- BackupProtectedItems
description: Provides a pageable list of all items that are backed up within a vault.
operationId: microsoftAzureBackupprotecteditemsList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectedItemResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/ProtectedItemQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List protected items with backupManagementType filter as AzureIaasVm:
$ref: ./examples/AzureIaasVm/BackupProtectedItems_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupprotecteditems
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation
: post:
tags:
- Operation
description: >-
Validate operation for specified backed up item. This is a synchronous
operation.
operationId: microsoftAzureOperationValidate
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: resource validate operation request
required: true
schema:
$ref: '#/definitions/ValidateOperationRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ValidateOperationsResponse'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Validate Operation:
$ref: ./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json
Validate Operation with identityBasedRestoreDetails:
$ref: >-
./examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupvalidateoperation
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTriggerValidateOperation
: post:
tags:
- ValidateOperation
description: >-
Validate operation for specified backed up item in the form of an
asynchronous operation. Returns tracking headers which can be tracked
using GetValidateOperationResult API.
operationId: microsoftAzureValidateoperationTrigger
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: resource validate operation request
required: true
schema:
$ref: '#/definitions/ValidateOperationRequest'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Trigger Validate Operation:
$ref: ./examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuptriggervalidateoperation
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationResults/{operationId}
: get:
tags:
- ValidateOperationResults
description: Fetches the result of a triggered validate operation.
operationId: microsoftAzureValidateoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
description: >-
OperationID which represents the operation whose result needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ValidateOperationsResponse'
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Operation Results of Validate Operation:
$ref: ./examples/AzureIaasVm/ValidateOperationResults.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupvalidateoperationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationsStatuses/{operationId}
: get:
tags:
- ValidateOperationStatuses
description: >-
Fetches the status of a triggered validate operation. The status can be
in progress, completed
or failed. You can refer to the
OperationStatus enum for all the possible states of the operation.
If
operation has completed, this method returns the list of errors obtained
while validating the operation.
operationId: microsoftAzureValidateoperationstatusesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
description: >-
OperationID represents the operation whose status needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Operation Status of Validate Operation:
$ref: ./examples/AzureIaasVm/ValidateOperationStatus.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupvalidateoperationsstatuses Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines
: get:
tags:
- BackupEngines
description: >-
Backup management servers registered to Recovery Services Vault. Returns
a pageable list of servers.
operationId: microsoftAzureBackupenginesList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupEngineBaseResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSBackupEnginesQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List Dpm/AzureBackupServer/Lajolla Backup Engines:
$ref: ./examples/Dpm/BackupEngines_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupengines
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}
: get:
tags:
- BackupEngines
description: Returns backup management server registered to Recovery Services Vault.
operationId: microsoftAzureBackupenginesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: backupEngineName
in: path
description: Name of the backup management server.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupEngineBaseResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSBackupEngineQueryObject'
x-ms-examples:
Get Dpm/AzureBackupServer/Lajolla Backup Engine Details:
$ref: ./examples/Dpm/BackupEngines_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupengines Backupenginename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}
: get:
tags:
- ProtectionContainerRefreshOperationResults
description: >-
Provides the result of the refresh operation triggered by the
BeginRefresh operation.
operationId: microsoftAzureProtectioncontainerrefreshoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the container.
required: true
type: string
- name: operationId
in: path
description: >-
Operation ID associated with the operation whose result needs to be
fetched.
required: true
type: string
responses:
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Azure Vm Discovery Operation Result:
$ref: ./examples/Common/RefreshContainers_OperationResults.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers
: get:
tags:
- ProtectableContainers
description: Lists the containers that can be registered to Recovery Services Vault.
operationId: microsoftAzureProtectablecontainersList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectableContainerResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSContainerQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List protectable items with backupManagementType filter as AzureStorage:
$ref: ./examples/AzureStorage/ProtectableContainers_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectablecontainers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
: get:
tags:
- ProtectionContainers
description: >-
Gets details of the specific container registered to your Recovery
Services Vault.
operationId: microsoftAzureProtectioncontainersGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Name of the fabric where the container belongs.
required: true
type: string
- name: containerName
in: path
description: Name of the container whose details need to be fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionContainerResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Protection Container Details:
$ref: ./examples/AzureWorkload/ProtectionContainers_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername
put:
tags:
- ProtectionContainers
description: >-
Registers the container with Recovery Services vault.
This is an
asynchronous operation. To track the operation status, use location
header to call get latest status of
the operation.
operationId: microsoftAzureProtectioncontainersRegister
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the container.
required: true
type: string
- name: containerName
in: path
description: Name of the container to be registered.
required: true
type: string
- name: parameters
in: body
description: Request body for operation
required: true
schema:
$ref: '#/definitions/ProtectionContainerResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionContainerResource'
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
RegisterAzure Storage ProtectionContainers:
$ref: ./examples/AzureStorage/ProtectionContainers_Register.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername
delete:
tags:
- ProtectionContainers
description: >-
Unregisters the given container from your Recovery Services Vault. This
is an asynchronous operation. To determine
whether the backend
service has finished processing the request, call Get Container
Operation Result API.
operationId: microsoftAzureProtectioncontainersUnregister
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Name of the fabric where the container belongs.
required: true
type: string
- name: containerName
in: path
description: >-
Name of the container which needs to be unregistered from the
Recovery Services Vault.
required: true
type: string
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Unregister Protection Container:
$ref: ./examples/AzureWorkload/ProtectionContainers_Unregister.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire
: post:
tags:
- ProtectionContainers
summary: 'Microsoft Azure Inquires All The Protectable Items Under The Given Container'
description: >-
This is an async operation and the results should be tracked using
location header or Azure-async-url.
operationId: microsoftAzureProtectioncontainersInquire
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric Name associated with the container.
required: true
type: string
- name: containerName
in: path
description: Name of the container in which inquiry needs to be triggered.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSContainersInquiryQueryObject'
x-ms-examples:
Inquire Azure Storage Protection Containers:
$ref: ./examples/AzureStorage/ProtectionContainers_Inquire.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items
: get:
tags:
- BackupWorkloadItems
description: >-
Provides a pageable list of workload item of a specific container
according to the query filter and the pagination
parameters.
operationId: microsoftAzureBackupworkloaditemsList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the container.
required: true
type: string
- name: containerName
in: path
description: Name of the container.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/WorkloadItemResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSWorkloadItemQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List Workload Items in Container:
$ref: ./examples/AzureWorkload/BackupWorkloadItems_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Items
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}
: get:
tags:
- ProtectionContainerOperationResults
description: Fetches the result of any operation on the container.
operationId: microsoftAzureProtectioncontaineroperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the container.
required: true
type: string
- name: containerName
in: path
description: Container name whose information should be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
Operation ID which represents the operation whose result needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionContainerResource'
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Azure Storage Protection Container Operation Result:
$ref: ./examples/AzureStorage/ProtectionContainers_Inquire_Result.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Operationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup
: post:
tags:
- Backups
description: >-
Triggers backup for specified backed up item. This is an asynchronous
operation. To know the status of the
operation, call
GetProtectedItemOperationResult API.
operationId: microsoftAzureBackupsTrigger
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backup item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backup item.
required: true
type: string
- name: protectedItemName
in: path
description: Backup item for which backup needs to be triggered.
required: true
type: string
- name: parameters
in: body
description: resource backup request
required: true
schema:
$ref: '#/definitions/BackupRequestResource'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Trigger Backup:
$ref: ./examples/Common/TriggerBackup_Post.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Backup
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
: get:
tags:
- ProtectedItemOperationStatuses
description: >-
Fetches the status of an operation such as triggering a backup, 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.
operationId: microsoftAzureProtecteditemoperationstatusesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backup item.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backup item.
required: true
type: string
- name: protectedItemName
in: path
description: Backup item name whose details are to be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
OperationID represents the operation whose status needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Operation Status of Protected Vm:
$ref: ./examples/AzureIaasVm/ProtectedItemOperationStatus.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Operationsstatus Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
: post:
tags:
- ItemLevelRecoveryConnections
description: >-
Provisions a script which invokes an iSCSI connection to the backup
data. Executing this script opens a file
explorer displaying all the
recoverable files and folders. This is an asynchronous operation. To
know the status of
provisioning, call GetProtectedItemOperationResult
API.
operationId: microsoftAzureItemlevelrecoveryconnectionsProvision
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up items.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up items.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item name whose files/folders are to be restored.
required: true
type: string
- name: recoveryPointId
in: path
description: "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data."
required: true
type: string
- name: parameters
in: body
description: resource ILR request
required: true
schema:
$ref: '#/definitions/ILRRequestResource'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Provision Instant Item Level Recovery for Azure Vm:
$ref: ./examples/AzureIaasVm/Provision_Ilr.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid Provisioninstantitemrecovery
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
: post:
tags:
- ItemLevelRecoveryConnections
description: >-
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.
operationId: microsoftAzureItemlevelrecoveryconnectionsRevoke
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated with the backed up items.
required: true
type: string
- name: containerName
in: path
description: Container name associated with the backed up items.
required: true
type: string
- name: protectedItemName
in: path
description: Backed up item name whose files/folders are to be restored.
required: true
type: string
- name: recoveryPointId
in: path
description: "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data."
required: true
type: string
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Revoke Instant Item Level Recovery for Azure Vm:
$ref: ./examples/AzureIaasVm/Revoke_Ilr.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypoints Recoverypointid Revokeinstantitemrecovery
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers
: post:
tags:
- ProtectionContainers
description: >-
Discovers all the containers in the subscription that can be backed up
to Recovery Services Vault. This is an
asynchronous operation. To
know the status of the operation, call GetRefreshOperationResult API.
operationId: microsoftAzureProtectioncontainersRefresh
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
description: Fabric name associated the container.
required: true
type: string
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSRefreshContainersQueryObject'
x-ms-examples:
Trigger Azure Vm Discovery:
$ref: ./examples/Common/RefreshContainers.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Refreshcontainers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperationResults/{operationId}
: get:
tags:
- BackupOperationResults
description: >-
Provides the status of the delete operations such as deleting backed up
item. Once the operation has started, the
status code in the response
would be Accepted. It will continue to be in this state till it reaches
completion. On
successful completion, the status code will be OK.
This method expects OperationID as an argument. OperationID is
part
of the Location header of the operation response.
operationId: microsoftAzureBackupoperationresultsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
description: OperationID which represents the operation.
required: true
type: string
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Result for Protected Item Delete Operation:
$ref: ./examples/Common/ProtectedItem_Delete_OperationResult.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupoperationresults Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperations/{operationId}
: get:
tags:
- BackupOperationStatuses
description: >-
Fetches the status of an operation such as triggering a backup, 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.
operationId: microsoftAzureBackupoperationstatusesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: operationId
in: path
description: OperationID which represents the operation.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Protected Item Delete Operation Status:
$ref: ./examples/Common/ProtectedItem_Delete_OperationStatus.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupoperations Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}
: get:
tags:
- ProtectionPolicyOperationStatuses
description: >-
Provides the status of the asynchronous operations like backup, restore.
The status can be in progress, completed
or failed. You can refer to
the Operation Status enum for all the possible states of an operation.
Some operations
create jobs. This method returns the list of jobs
associated with operation.
operationId: microsoftAzureProtectionpolicyoperationstatusesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: policyName
in: path
description: Backup policy name whose operation's status needs to be fetched.
required: true
type: string
- name: operationId
in: path
description: >-
Operation ID which represents an operation whose status needs to be
fetched.
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Protection Policy Operation Status:
$ref: ./examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backuppolicies Policyname Operations Operationid
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems
: get:
tags:
- BackupProtectableItems
description: >-
Provides a pageable list of protectable objects within your subscription
according to the query filter and the
pagination parameters.
operationId: microsoftAzureBackupprotectableitemsList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
- name: $skipToken
in: query
description: skipToken Filter.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/WorkloadProtectableItemResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSPOQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List protectable items with backupManagementType filter as AzureIaasVm:
$ref: ./examples/AzureIaasVm/BackupProtectableItems_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupprotectableitems
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionContainers
: get:
tags:
- BackupProtectionContainers
description: Lists the containers registered to Recovery Services Vault.
operationId: microsoftAzureBackupprotectioncontainersList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionContainerResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSContainerQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List Backup Protection Containers:
$ref: ./examples/AzureStorage/ProtectionContainers_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupprotectioncontainers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupDeletedProtectionContainers
: get:
tags:
- SoftDeletedContainers
description: Lists the soft deleted containers registered to Recovery Services Vault.
operationId: microsoftAzureDeletedprotectioncontainersList
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionId'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ApiVersion'
- name: $filter
in: query
description: OData filter options.
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProtectionContainerResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-odata: '#/definitions/BMSContainerQueryObject'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
List Backup Protection Containers:
$ref: ./examples/AzureStorage/SoftDeletedContainers_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupdeletedprotectioncontainers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupSecurityPIN
: post:
tags:
- SecurityPINs
description: Get the security PIN.
operationId: microsoftAzureSecuritypinsGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: parameters
in: body
description: security pin request
required: false
schema:
$ref: '#/definitions/SecurityPinBase'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TokenInformation'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get Vault Security Pin:
$ref: ./examples/Common/BackupSecurityPin_Get.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupsecuritypin
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/move
: post:
tags:
- RecoveryPoint
summary: 'Microsoft Azure Move Recovery Point From One Datastore To Another Store'
operationId: microsoftAzureMoverecoverypoint
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
required: true
type: string
- name: containerName
in: path
required: true
type: string
- name: protectedItemName
in: path
required: true
type: string
- name: recoveryPointId
in: path
required: true
type: string
- name: parameters
in: body
description: Move Resource Across Tiers Request
required: true
schema:
$ref: '#/definitions/MoveRPAcrossTiersRequest'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Trigger RP Move Operation:
$ref: ./examples/TriggerRecoveryPointMove_Post.json
description: Needs a more full description created.
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPointsRecommendedForMove
: post:
tags:
- RecoveryPointsRecommendedForMove
description: Lists the recovery points recommended for move to another tier
operationId: microsoftAzureRecoverypointsrecommendedformoveList
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: fabricName
in: path
required: true
type: string
- name: containerName
in: path
required: true
type: string
- name: protectedItemName
in: path
required: true
type: string
- name: parameters
in: body
description: List Recovery points Recommended for Move Request
required: true
schema:
$ref: '#/definitions/ListRecoveryPointsRecommendedForMoveRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/RecoveryPointResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get Protected Azure Vm Recovery Points Recommended for Move:
$ref: ./examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupfabrics Fabricname Protectioncontainers Containername Protecteditems Protecteditemname Recoverypointsrecommendedformove
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies
: get:
tags:
- ResourceGuardProxies
description: List the ResourceGuardProxies under vault
operationId: microsoftAzureResourceguardproxiesGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResourceGuardProxyBaseResourceList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get VaultGuardProxies:
$ref: ./examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupresourceguardproxies
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
: get:
tags:
- ResourceGuardProxy
description: >-
Returns ResourceGuardProxy under vault and with the name referenced in
request
operationId: microsoftAzureResourceguardproxyGet
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: resourceGuardProxyName
in: path
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResourceGuardProxyBaseResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Get ResourceGuardProxy:
$ref: ./examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupresourceguardproxies Resourceguardproxyname
put:
tags:
- ResourceGuardProxy
description: >-
Add or Update ResourceGuardProxy under vault
Secures vault critical
operations
operationId: microsoftAzureResourceguardproxyPut
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: resourceGuardProxyName
in: path
required: true
type: string
- name: parameters
in: body
description: Request body for operation
required: true
schema:
$ref: '#/definitions/ResourceGuardProxyBaseResource'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ResourceGuardProxyBaseResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Create ResourceGuardProxy:
$ref: ./examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupresourceguardproxies Resourceguardproxyname
delete:
tags:
- ResourceGuardProxy
description: Delete ResourceGuardProxy under vault
operationId: microsoftAzureResourceguardproxyDelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: resourceGuardProxyName
in: path
required: true
type: string
responses:
'200':
description: OK
'204':
description: NoContent
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
Delete ResourceGuardProxy:
$ref: ./examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupresourceguardproxies Resourceguardproxyname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete
: post:
tags:
- ResourceGuardProxy
description: Secures delete ResourceGuardProxy operations.
operationId: microsoftAzureResourceguardproxyUnlockdelete
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/VaultName'
- $ref: '#/parameters/ResourceGroupName'
- $ref: '#/parameters/SubscriptionId'
- name: resourceGuardProxyName
in: path
required: true
type: string
- name: parameters
in: body
description: Request body for operation
required: true
schema:
$ref: '#/definitions/UnlockDeleteRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/UnlockDeleteResponse'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-examples:
UnlockDelete ResourceGuardProxy:
$ref: >-
./examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupresourceguardproxies Resourceguardproxyname Unlockdelete
definitions:
BackupResourceEncryptionConfig:
type: object
properties:
encryptionAtRestType:
description: Encryption At Rest Type
enum:
- Invalid
- MicrosoftManaged
- CustomerManaged
type: string
x-ms-enum:
name: EncryptionAtRestType
modelAsString: true
keyUri:
description: Key Vault Key URI
type: string
subscriptionId:
description: Key Vault Subscription Id
type: string
lastUpdateStatus:
enum:
- Invalid
- NotEnabled
- PartiallySucceeded
- PartiallyFailed
- Failed
- Succeeded
- Initialized
- FirstInitialization
type: string
x-ms-enum:
name: LastUpdateStatus
modelAsString: true
infrastructureEncryptionState:
enum:
- Invalid
- Disabled
- Enabled
type: string
x-ms-enum:
name: InfrastructureEncryptionState
modelAsString: true
BackupResourceEncryptionConfigExtended:
type: object
allOf:
- $ref: '#/definitions/BackupResourceEncryptionConfig'
properties:
userAssignedIdentity:
description: User Assigned Identity Id
type: string
useSystemAssignedIdentity:
description: bool to indicate whether to use system Assigned Identity or not
type: boolean
BackupResourceEncryptionConfigExtendedResource:
type: object
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupResourceEncryptionConfigExtended'
description: BackupResourceEncryptionConfigExtendedResource properties
BackupResourceEncryptionConfigResource:
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupResourceEncryptionConfig'
description: BackupResourceEncryptionConfigResource properties
PrivateEndpoint:
description: >-
The Private Endpoint network resource that is linked to the Private
Endpoint connection
type: object
properties:
id:
description: Gets or sets id
type: string
PrivateEndpointConnection:
description: Private Endpoint Connection Response Properties
type: object
properties:
provisioningState:
description: Gets or sets provisioning state of the private endpoint connection
enum:
- Succeeded
- Deleting
- Failed
- Pending
type: string
x-ms-enum:
name: ProvisioningState
modelAsString: true
privateEndpoint:
$ref: '#/definitions/PrivateEndpoint'
description: >-
Gets or sets private endpoint associated with the private endpoint
connection
privateLinkServiceConnectionState:
$ref: '#/definitions/PrivateLinkServiceConnectionState'
description: Gets or sets private link service connection state
PrivateEndpointConnectionResource:
description: Private Endpoint Connection Response Properties
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/PrivateEndpointConnection'
description: PrivateEndpointConnectionResource properties
PrivateLinkServiceConnectionState:
description: Private Link Service Connection State
type: object
properties:
status:
description: Gets or sets the status
enum:
- Pending
- Approved
- Rejected
- Disconnected
type: string
x-ms-enum:
name: PrivateEndpointConnectionStatus
modelAsString: true
description:
description: Gets or sets description
type: string
actionRequired:
description: Gets or sets actions required
type: string
CloudError:
x-ms-external: true
properties:
error:
type: object
$ref: '#/definitions/CloudErrorBody'
description: The error object.
description: An error response from the Container Instance service.
CloudErrorBody:
x-ms-external: true
properties:
code:
readOnly: true
type: string
description: >-
An identifier for the error. Codes are invariant and are intended to
be consumed programmatically.
message:
readOnly: true
type: string
description: >-
A message describing the error, intended to be suitable for display in
a user interface.
target:
readOnly: true
type: string
description: >-
The target of the particular error. For example, the name of the
property in error.
details:
readOnly: true
type: array
items:
$ref: '#/definitions/CloudErrorBody'
x-ms-identifiers:
- code
description: A list of additional details about the error.
additionalInfo:
readOnly: true
type: array
items:
$ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo
x-ms-identifiers: []
description: The error additional info.
description: An error response from the Container Instance service.
NewErrorResponse:
properties:
error:
type: object
description: The error object.
properties:
code:
readOnly: true
type: string
description: The error code.
message:
readOnly: true
type: string
description: The error message.
target:
readOnly: true
type: string
description: The error target.
details:
readOnly: true
type: array
items:
$ref: '#/definitions/NewErrorResponse'
x-ms-identifiers:
- /error/code
description: The error details.
additionalInfo:
readOnly: true
type: array
items:
$ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo
x-ms-identifiers: []
description: The error additional info.
description: The resource management error response.
AzureFileshareProtectedItem:
description: Azure File Share workload-specific backup item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of the fileshare represented by this backup item.
type: string
protectionStatus:
description: Backup status of this backup item.
type: string
protectionState:
description: Backup state of this backup item.
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectionState
modelAsString: true
lastBackupStatus:
description: 'Last backup operation status. Possible values: Healthy, Unhealthy.'
type: string
lastBackupTime:
format: date-time
description: Timestamp of the last backup operation on this backup item.
type: string
kpisHealths:
description: Health details of different KPIs
type: object
additionalProperties:
$ref: '#/definitions/KPIResourceHealthDetails'
extendedInfo:
$ref: '#/definitions/AzureFileshareProtectedItemExtendedInfo'
description: Additional information with this backup item.
x-ms-discriminator-value: AzureFileShareProtectedItem
AzureFileshareProtectedItemExtendedInfo:
description: Additional information about Azure File Share backup item.
type: object
properties:
oldestRecoveryPoint:
format: date-time
description: The oldest backup copy available for this item in the service.
type: string
recoveryPointCount:
format: int32
description: Number of available backup copies associated with this backup item.
type: integer
policyState:
description: >-
Indicates consistency of policy object and policy applied to this
backup item.
type: string
resourceState:
description: >-
Indicates the state of this resource. Possible values are from enum
ResourceState {Invalid, Active, SoftDeleted, Deleted}
type: string
readOnly: true
resourceStateSyncTime:
format: date-time
description: The resource state sync time for this backup item.
type: string
readOnly: true
AzureFileShareRecoveryPoint:
description: Azure File Share workload specific backup copy.
type: object
allOf:
- $ref: '#/definitions/RecoveryPoint'
properties:
recoveryPointType:
description: >-
Type of the backup copy. Specifies whether it is a crash consistent
backup or app consistent.
type: string
recoveryPointTime:
format: date-time
description: Time at which this backup copy was created.
type: string
fileShareSnapshotUri:
description: Contains Url to the snapshot of fileshare, if applicable
type: string
recoveryPointSizeInGB:
format: int32
description: Contains recovery point size
type: integer
x-ms-discriminator-value: AzureFileShareRecoveryPoint
AzureFileShareRestoreRequest:
description: AzureFileShare Restore Request
type: object
allOf:
- $ref: '#/definitions/RestoreRequest'
properties:
recoveryType:
description: Type of this recovery.
enum:
- Invalid
- OriginalLocation
- AlternateLocation
- RestoreDisks
- Offline
type: string
x-ms-enum:
name: RecoveryType
modelAsString: true
sourceResourceId:
description: Source storage account ARM Id
type: string
copyOptions:
description: Options to resolve copy conflicts.
enum:
- Invalid
- CreateCopy
- Skip
- Overwrite
- FailOnConflict
type: string
x-ms-enum:
name: CopyOptions
modelAsString: true
restoreRequestType:
description: Restore Type (FullShareRestore or ItemLevelRestore)
enum:
- Invalid
- FullShareRestore
- ItemLevelRestore
type: string
x-ms-enum:
name: RestoreRequestType
modelAsString: true
restoreFileSpecs:
description: >-
List of Source Files/Folders(which need to recover) and
TargetFolderPath details
type: array
items:
$ref: '#/definitions/RestoreFileSpecs'
x-ms-identifiers: []
targetDetails:
$ref: '#/definitions/TargetAFSRestoreInfo'
description: Target File Share Details
x-ms-discriminator-value: AzureFileShareRestoreRequest
AzureVmWorkloadProtectionPolicy:
description: Azure VM (Mercury) workload-specific backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
workLoadType:
description: Type of workload for the backup management
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
settings:
$ref: '#/definitions/Settings'
description: Common settings for the backup management
subProtectionPolicy:
description: List of sub-protection policies which includes schedule and retention
type: array
items:
$ref: '#/definitions/SubProtectionPolicy'
x-ms-identifiers: []
makePolicyConsistent:
description: Fix the policy inconsistency
type: boolean
x-ms-discriminator-value: AzureWorkload
AzureFileShareProtectionPolicy:
description: AzureStorage backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
workLoadType:
description: Type of workload for the backup management
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
schedulePolicy:
$ref: '#/definitions/SchedulePolicy'
description: Backup schedule specified as part of backup policy.
retentionPolicy:
$ref: '#/definitions/RetentionPolicy'
description: Retention policy with the details on backup copy retention ranges.
timeZone:
description: >-
TimeZone optional input as string. For example: TimeZone = "Pacific
Standard Time".
type: string
x-ms-discriminator-value: AzureStorage
AzureIaaSClassicComputeVMProtectedItem:
description: IaaS VM workload-specific backup item representing the Classic Compute VM.
type: object
allOf:
- $ref: '#/definitions/AzureIaaSVMProtectedItem'
x-ms-discriminator-value: Microsoft.ClassicCompute/virtualMachines
AzureIaaSComputeVMProtectedItem:
description: >-
IaaS VM workload-specific backup item representing the Azure Resource
Manager VM.
type: object
allOf:
- $ref: '#/definitions/AzureIaaSVMProtectedItem'
x-ms-discriminator-value: Microsoft.Compute/virtualMachines
AzureIaaSVMErrorInfo:
description: Azure IaaS VM workload-specific error information.
type: object
properties:
errorCode:
format: int32
description: Error code.
type: integer
readOnly: true
errorTitle:
description: 'Title: Typically, the entity that the error pertains to.'
type: string
readOnly: true
errorString:
description: Localized error string.
type: string
readOnly: true
recommendations:
description: List of localized recommendations for above error code.
type: array
items:
type: string
readOnly: true
ResourceHealthDetails:
description: Health Details for backup items.
type: object
properties:
code:
format: int32
description: Health Code
type: integer
readOnly: true
title:
description: Health Title
type: string
readOnly: true
message:
description: Health Message
type: string
readOnly: true
recommendations:
description: Health Recommended Actions
type: array
items:
type: string
readOnly: true
AzureIaaSVMHealthDetails:
description: Azure IaaS VM workload-specific Health Details.
type: object
allOf:
- $ref: '#/definitions/ResourceHealthDetails'
AzureIaaSVMJob:
description: Azure IaaS VM workload-specific job object.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
duration:
format: duration
description: Time elapsed during the execution of this job.
type: string
actionsInfo:
description: >-
Gets or sets the state/actions applicable on this job like
cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
errorDetails:
description: Error details on execution of this job.
type: array
items:
$ref: '#/definitions/AzureIaaSVMErrorInfo'
x-ms-identifiers:
- errorCode
virtualMachineVersion:
description: >-
Specifies whether the backup item is a Classic or an Azure Resource
Manager VM.
type: string
extendedInfo:
$ref: '#/definitions/AzureIaaSVMJobExtendedInfo'
description: Additional information for this job.
containerName:
description: Container name of the entity on which the current job is executing.
type: string
isUserTriggered:
description: Indicated that whether the job is adhoc(true) or scheduled(false)
type: boolean
x-ms-discriminator-value: AzureIaaSVMJob
AzureIaaSVMJobV2:
description: Azure IaaS VM workload-specific job object.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
actionsInfo:
description: >-
Gets or sets the state/actions applicable on this job like
cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
containerName:
description: Container name of the entity on which the current job is executing.
type: string
duration:
format: duration
description: Time elapsed during the execution of this job.
type: string
errorDetails:
description: Error details on execution of this job.
type: array
items:
$ref: '#/definitions/AzureIaaSVMErrorInfo'
x-ms-identifiers:
- errorCode
virtualMachineVersion:
description: >-
Specifies whether the backup item is a Classic or an Azure Resource
Manager VM.
type: string
extendedInfo:
$ref: '#/definitions/AzureIaaSVMJobExtendedInfo'
description: Additional information for this job.
x-ms-discriminator-value: AzureIaaSVMJobV2
AzureIaaSVMJobExtendedInfo:
description: Azure IaaS VM workload-specific additional information for job.
type: object
properties:
tasksList:
description: List of tasks associated with this job.
type: array
items:
$ref: '#/definitions/AzureIaaSVMJobTaskDetails'
x-ms-identifiers:
- taskId
propertyBag:
description: Job properties.
type: object
additionalProperties:
type: string
internalPropertyBag:
description: Job internal properties.
type: object
additionalProperties:
type: string
progressPercentage:
format: double
description: >-
Indicates progress of the job. Null if it has not started or
completed.
type: number
estimatedRemainingDuration:
description: Time remaining for execution of this job.
type: string
dynamicErrorMessage:
description: Non localized error message on job execution.
type: string
AzureIaaSVMJobTaskDetails:
description: Azure IaaS VM workload-specific job task details.
type: object
properties:
taskId:
description: The task display name.
type: string
startTime:
format: date-time
description: The start time.
type: string
endTime:
format: date-time
description: The end time.
type: string
instanceId:
description: The instanceId.
type: string
duration:
format: duration
description: Time elapsed for task.
type: string
status:
description: The status.
type: string
progressPercentage:
format: double
description: Progress of the task.
type: number
taskExecutionDetails:
description: "Details about execution of the task.\r\neg: number of bytes transferred etc"
type: string
AzureIaaSVMProtectedItem:
description: IaaS VM workload-specific backup item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of the VM represented by this backup item.
type: string
readOnly: true
virtualMachineId:
description: >-
Fully qualified ARM ID of the virtual machine represented by this
item.
type: string
readOnly: true
protectionStatus:
description: Backup status of this backup item.
type: string
protectionState:
description: Backup state of this backup item.
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectionState
modelAsString: true
healthStatus:
description: Health status of protected item.
enum:
- Passed
- ActionRequired
- ActionSuggested
- Invalid
type: string
x-ms-enum:
name: HealthStatus
modelAsString: true
readOnly: true
healthDetails:
description: Health details on this backup item.
type: array
items:
$ref: '#/definitions/AzureIaaSVMHealthDetails'
x-ms-identifiers:
- code
kpisHealths:
description: Health details of different KPIs
type: object
additionalProperties:
$ref: '#/definitions/KPIResourceHealthDetails'
lastBackupStatus:
description: Last backup operation status.
type: string
lastBackupTime:
format: date-time
description: Timestamp of the last backup operation on this backup item.
type: string
readOnly: true
protectedItemDataId:
description: Data ID of the protected item.
type: string
readOnly: true
extendedInfo:
$ref: '#/definitions/AzureIaaSVMProtectedItemExtendedInfo'
description: Additional information for this backup item.
extendedProperties:
$ref: '#/definitions/ExtendedProperties'
x-ms-discriminator-value: AzureIaaSVMProtectedItem
AzureIaaSVMProtectedItemExtendedInfo:
description: Additional information on Azure IaaS VM specific backup item.
type: object
properties:
oldestRecoveryPoint:
format: date-time
description: >-
The oldest backup copy available for this backup item across all
tiers.
type: string
oldestRecoveryPointInVault:
format: date-time
description: The oldest backup copy available for this backup item in vault tier
type: string
oldestRecoveryPointInArchive:
format: date-time
description: The oldest backup copy available for this backup item in archive tier
type: string
newestRecoveryPointInArchive:
format: date-time
description: The latest backup copy available for this backup item in archive tier
type: string
recoveryPointCount:
format: int32
description: Number of backup copies available for this backup item.
type: integer
policyInconsistent:
description: >-
Specifies if backup policy associated with the backup item is
inconsistent.
type: boolean
AzureIaaSVMProtectionPolicy:
description: IaaS VM workload-specific backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
instantRPDetails:
$ref: '#/definitions/InstantRPAdditionalDetails'
schedulePolicy:
$ref: '#/definitions/SchedulePolicy'
description: Backup schedule specified as part of backup policy.
retentionPolicy:
$ref: '#/definitions/RetentionPolicy'
description: Retention policy with the details on backup copy retention ranges.
tieringPolicy:
description: "Tiering policy to automatically move RPs to another tier\r\nKey is Target Tier, defined in RecoveryPointTierType enum.\r\nTiering policy specifies the criteria to move RP to the target tier."
type: object
additionalProperties:
$ref: '#/definitions/TieringPolicy'
instantRpRetentionRangeInDays:
format: int32
description: Instant RP retention policy range in days
type: integer
timeZone:
description: >-
TimeZone optional input as string. For example: TimeZone = "Pacific
Standard Time".
type: string
policyType:
enum:
- Invalid
- V1
- V2
type: string
x-ms-enum:
name: IAASVMPolicyType
modelAsString: true
x-ms-discriminator-value: AzureIaasVM
AzureSqlProtectedItem:
description: Azure SQL workload-specific backup item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
protectedItemDataId:
description: >-
Internal ID of a backup item. Used by Azure SQL Backup engine to
contact Recovery Services.
type: string
protectionState:
description: Backup state of the backed up item.
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectedItemState
modelAsString: true
extendedInfo:
$ref: '#/definitions/AzureSqlProtectedItemExtendedInfo'
description: Additional information for this backup item.
x-ms-discriminator-value: Microsoft.Sql/servers/databases
AzureSqlProtectedItemExtendedInfo:
description: Additional information on Azure Sql specific protected item.
type: object
properties:
oldestRecoveryPoint:
format: date-time
description: The oldest backup copy available for this item in the service.
type: string
recoveryPointCount:
format: int32
description: Number of available backup copies associated with this backup item.
type: integer
policyState:
description: State of the backup policy associated with this backup item.
type: string
AzureStorageErrorInfo:
description: Azure storage specific error information
type: object
properties:
errorCode:
format: int32
description: Error code.
type: integer
errorString:
description: Localized error string.
type: string
recommendations:
description: List of localized recommendations for above error code.
type: array
items:
type: string
AzureSqlProtectionPolicy:
description: Azure SQL workload-specific backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
retentionPolicy:
$ref: '#/definitions/RetentionPolicy'
description: Retention policy details.
x-ms-discriminator-value: AzureSql
AzureStorageJob:
description: Azure storage specific job.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
duration:
format: duration
description: Time elapsed during the execution of this job.
type: string
actionsInfo:
description: >-
Gets or sets the state/actions applicable on this job like
cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
errorDetails:
description: Error details on execution of this job.
type: array
items:
$ref: '#/definitions/AzureStorageErrorInfo'
x-ms-identifiers:
- errorCode
storageAccountName:
description: Specifies friendly name of the storage account.
type: string
storageAccountVersion:
description: >-
Specifies whether the Storage account is a Classic or an Azure
Resource Manager Storage account.
type: string
extendedInfo:
$ref: '#/definitions/AzureStorageJobExtendedInfo'
description: Additional information about the job.
isUserTriggered:
description: Indicated that whether the job is adhoc(true) or scheduled(false)
type: boolean
x-ms-discriminator-value: AzureStorageJob
AzureStorageJobExtendedInfo:
description: Azure Storage workload-specific additional information for job.
type: object
properties:
tasksList:
description: List of tasks for this job
type: array
items:
$ref: '#/definitions/AzureStorageJobTaskDetails'
x-ms-identifiers:
- taskId
propertyBag:
description: Job properties.
type: object
additionalProperties:
type: string
dynamicErrorMessage:
description: Non localized error message on job execution.
type: string
AzureStorageJobTaskDetails:
description: Azure storage workload specific job task details.
type: object
properties:
taskId:
description: The task display name.
type: string
status:
description: The status.
type: string
AzureVmWorkloadProtectedItem:
description: Azure VM workload-specific protected item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of the DB represented by this backup item.
type: string
readOnly: true
serverName:
description: Host/Cluster Name for instance or AG
type: string
parentName:
description: Parent name of the DB such as Instance or Availability Group.
type: string
parentType:
description: >-
Parent type of protected item, example: for a DB, standalone server or
distributed
type: string
protectionStatus:
description: Backup status of this backup item.
type: string
readOnly: true
protectionState:
description: Backup state of this backup item.
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectionState
modelAsString: true
lastBackupStatus:
description: 'Last backup operation status. Possible values: Healthy, Unhealthy.'
enum:
- Invalid
- Healthy
- Unhealthy
- IRPending
type: string
x-ms-enum:
name: LastBackupStatus
modelAsString: true
lastBackupTime:
format: date-time
description: Timestamp of the last backup operation on this backup item.
type: string
lastBackupErrorDetail:
$ref: '#/definitions/ErrorDetail'
description: Error details in last backup
protectedItemDataSourceId:
description: Data ID of the protected item.
type: string
protectedItemHealthStatus:
description: >-
Health status of the backup item, evaluated based on last heartbeat
received
enum:
- Invalid
- Healthy
- Unhealthy
- NotReachable
- IRPending
type: string
x-ms-enum:
name: ProtectedItemHealthStatus
modelAsString: true
extendedInfo:
$ref: '#/definitions/AzureVmWorkloadProtectedItemExtendedInfo'
description: Additional information for this backup item.
kpisHealths:
description: Health details of different KPIs
type: object
additionalProperties:
$ref: '#/definitions/KPIResourceHealthDetails'
x-ms-discriminator-value: AzureVmWorkloadProtectedItem
AzureVmWorkloadProtectedItemExtendedInfo:
description: Additional information on Azure Workload for SQL specific backup item.
type: object
properties:
oldestRecoveryPoint:
format: date-time
description: >-
The oldest backup copy available for this backup item across all
tiers.
type: string
oldestRecoveryPointInVault:
format: date-time
description: The oldest backup copy available for this backup item in vault tier
type: string
oldestRecoveryPointInArchive:
format: date-time
description: The oldest backup copy available for this backup item in archive tier
type: string
newestRecoveryPointInArchive:
format: date-time
description: The latest backup copy available for this backup item in archive tier
type: string
recoveryPointCount:
format: int32
description: Number of backup copies available for this backup item.
type: integer
policyState:
description: >-
Indicates consistency of policy object and policy applied to this
backup item.
type: string
recoveryModel:
description: >-
Indicates consistency of policy object and policy applied to this
backup item.
type: string
AzureVmWorkloadSAPAseDatabaseProtectedItem:
description: Azure VM workload-specific protected item representing SAP ASE Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectedItem'
x-ms-discriminator-value: AzureVmWorkloadSAPAseDatabase
AzureVmWorkloadSAPHanaDatabaseProtectedItem:
description: Azure VM workload-specific protected item representing SAP HANA Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectedItem'
x-ms-discriminator-value: AzureVmWorkloadSAPHanaDatabase
AzureVmWorkloadSAPHanaDBInstanceProtectedItem:
description: >-
Azure VM workload-specific protected item representing SAP HANA
DBInstance.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectedItem'
x-ms-discriminator-value: AzureVmWorkloadSAPHanaDBInstance
AzureVmWorkloadSQLDatabaseProtectedItem:
description: Azure VM workload-specific protected item representing SQL Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectedItem'
x-ms-discriminator-value: AzureVmWorkloadSQLDatabase
AzureWorkloadErrorInfo:
description: Azure storage specific error information
type: object
properties:
errorCode:
format: int32
description: Error code.
type: integer
errorString:
description: Localized error string.
type: string
errorTitle:
description: 'Title: Typically, the entity that the error pertains to.'
type: string
recommendations:
description: List of localized recommendations for above error code.
type: array
items:
type: string
additionalDetails:
description: Additional details for above error code.
type: string
AzureWorkloadJob:
description: Azure storage specific job.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
workloadType:
description: Workload type of the job
type: string
duration:
format: duration
description: Time elapsed during the execution of this job.
type: string
actionsInfo:
description: >-
Gets or sets the state/actions applicable on this job like
cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
errorDetails:
description: Error details on execution of this job.
type: array
items:
$ref: '#/definitions/AzureWorkloadErrorInfo'
x-ms-identifiers:
- errorCode
extendedInfo:
$ref: '#/definitions/AzureWorkloadJobExtendedInfo'
description: Additional information about the job.
x-ms-discriminator-value: AzureWorkloadJob
AzureWorkloadJobExtendedInfo:
description: Azure VM workload-specific additional information for job.
type: object
properties:
tasksList:
description: List of tasks for this job
type: array
items:
$ref: '#/definitions/AzureWorkloadJobTaskDetails'
x-ms-identifiers:
- taskId
propertyBag:
description: Job properties.
type: object
additionalProperties:
type: string
dynamicErrorMessage:
description: Non localized error message on job execution.
type: string
AzureWorkloadJobTaskDetails:
description: Azure VM workload specific job task details.
type: object
properties:
taskId:
description: The task display name.
type: string
status:
description: The status.
type: string
AzureWorkloadPointInTimeRecoveryPoint:
description: Recovery point specific to PointInTime
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRecoveryPoint'
properties:
timeRanges:
description: List of log ranges
type: array
items:
$ref: '#/definitions/PointInTimeRange'
x-ms-identifiers: []
x-ms-discriminator-value: AzureWorkloadPointInTimeRecoveryPoint
AzureWorkloadPointInTimeRestoreRequest:
description: >-
AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log
restore
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRestoreRequest'
properties:
pointInTime:
format: date-time
description: PointInTime value
type: string
x-ms-discriminator-value: AzureWorkloadPointInTimeRestoreRequest
AzureWorkloadRecoveryPoint:
description: >-
Workload specific recovery point, specifically encapsulates full/diff
recovery point
type: object
allOf:
- $ref: '#/definitions/RecoveryPoint'
properties:
recoveryPointTimeInUTC:
format: date-time
description: UTC time at which recovery point was created
type: string
type:
description: Type of restore point
enum:
- Invalid
- Full
- Log
- Differential
- Incremental
- SnapshotFull
- SnapshotCopyOnlyFull
type: string
x-ms-enum:
name: RestorePointType
modelAsString: true
recoveryPointTierDetails:
description: Recovery point tier information.
type: array
items:
$ref: '#/definitions/RecoveryPointTierInformationV2'
x-ms-identifiers: []
recoveryPointMoveReadinessInfo:
description: Eligibility of RP to be moved to another tier
type: object
additionalProperties:
$ref: '#/definitions/RecoveryPointMoveReadinessInfo'
x-ms-discriminator-value: AzureWorkloadRecoveryPoint
AzureWorkloadRestoreRequest:
description: AzureWorkload-specific restore.
type: object
allOf:
- $ref: '#/definitions/RestoreRequest'
properties:
recoveryType:
description: Type of this recovery.
enum:
- Invalid
- OriginalLocation
- AlternateLocation
- RestoreDisks
- Offline
type: string
x-ms-enum:
name: RecoveryType
modelAsString: true
sourceResourceId:
description: >-
Fully qualified ARM ID of the VM on which workload that was running is
being recovered.
type: string
propertyBag:
description: Workload specific property bag.
type: object
additionalProperties:
type: string
targetInfo:
$ref: '#/definitions/TargetRestoreInfo'
description: Details of target database
recoveryMode:
description: >-
Defines whether the current recovery mode is file restore or database
restore
enum:
- Invalid
- FileRecovery
- WorkloadRecovery
type: string
x-ms-enum:
name: RecoveryMode
modelAsString: true
targetVirtualMachineId:
description: "This is the complete ARM Id of the target VM\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}"
type: string
x-ms-discriminator-value: AzureWorkloadRestoreRequest
AzureWorkloadSAPHanaPointInTimeRecoveryPoint:
description: Recovery point specific to PointInTime in SAPHana
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadPointInTimeRecoveryPoint'
x-ms-discriminator-value: AzureWorkloadSAPHanaPointInTimeRecoveryPoint
AzureWorkloadSAPHanaPointInTimeRestoreRequest:
description: >-
AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log
restore
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSAPHanaRestoreRequest'
properties:
pointInTime:
format: date-time
description: PointInTime value
type: string
x-ms-discriminator-value: AzureWorkloadSAPHanaPointInTimeRestoreRequest
AzureWorkloadSAPHanaRecoveryPoint:
description: >-
SAPHana specific recoverypoint, specifically encapsulates full/diff
recoverypoints
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRecoveryPoint'
x-ms-discriminator-value: AzureWorkloadSAPHanaRecoveryPoint
AzureWorkloadSAPHanaRestoreRequest:
description: AzureWorkload SAP Hana-specific restore.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRestoreRequest'
x-ms-discriminator-value: AzureWorkloadSAPHanaRestoreRequest
AzureWorkloadSQLPointInTimeRecoveryPoint:
description: Recovery point specific to PointInTime
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSQLRecoveryPoint'
properties:
timeRanges:
description: List of log ranges
type: array
items:
$ref: '#/definitions/PointInTimeRange'
x-ms-identifiers: []
x-ms-discriminator-value: AzureWorkloadSQLPointInTimeRecoveryPoint
AzureWorkloadSQLPointInTimeRestoreRequest:
description: >-
AzureWorkload SQL -specific restore. Specifically for PointInTime/Log
restore
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSQLRestoreRequest'
properties:
pointInTime:
format: date-time
description: PointInTime value
type: string
x-ms-discriminator-value: AzureWorkloadSQLPointInTimeRestoreRequest
AzureWorkloadSQLRecoveryPoint:
description: >-
SQL specific recoverypoint, specifically encapsulates full/diff
recoverypoint along with extended info
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRecoveryPoint'
properties:
extendedInfo:
$ref: '#/definitions/AzureWorkloadSQLRecoveryPointExtendedInfo'
description: "Extended Info that provides data directory details. Will be populated in two cases:\r\nWhen a specific recovery point is accessed using GetRecoveryPoint\r\nOr when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter"
x-ms-discriminator-value: AzureWorkloadSQLRecoveryPoint
AzureWorkloadSQLRecoveryPointExtendedInfo:
description: Extended info class details
type: object
properties:
dataDirectoryTimeInUTC:
format: date-time
description: UTC time at which data directory info was captured
type: string
dataDirectoryPaths:
description: List of data directory paths during restore operation.
type: array
items:
$ref: '#/definitions/SQLDataDirectory'
x-ms-identifiers: []
AzureWorkloadSQLRestoreRequest:
description: AzureWorkload SQL -specific restore. Specifically for full/diff restore
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadRestoreRequest'
properties:
shouldUseAlternateTargetLocation:
description: >-
Default option set to true. If this is set to false, alternate data
directory must be provided
type: boolean
isNonRecoverable:
description: >-
SQL specific property where user can chose to set no-recovery when
restore operation is tried
type: boolean
alternateDirectoryPaths:
description: Data directory details
type: array
items:
$ref: '#/definitions/SQLDataDirectoryMapping'
x-ms-identifiers: []
x-ms-discriminator-value: AzureWorkloadSQLRestoreRequest
BEKDetails:
description: BEK is bitlocker encryption key.
type: object
properties:
secretUrl:
description: Secret is BEK.
type: string
secretVaultId:
description: ID of the Key Vault where this Secret is stored.
type: string
secretData:
description: BEK data.
type: string
BMSRPQueryObject:
description: Filters to list backup copies.
type: object
properties:
startDate:
format: date-time
description: Backup copies created after this time.
type: string
endDate:
format: date-time
description: Backup copies created before this time.
type: string
restorePointQueryType:
description: RestorePoint type
enum:
- Invalid
- Full
- Log
- Differential
- FullAndDifferential
- All
- Incremental
- SnapshotFull
- SnapshotCopyOnlyFull
type: string
x-ms-enum:
name: RestorePointQueryType
modelAsString: true
extendedInfo:
description: >-
In Get Recovery Point, it tells whether extended information about
recovery point is asked.
type: boolean
moveReadyRPOnly:
description: Whether the RP can be moved to another tier
type: boolean
DiskExclusionProperties:
type: object
properties:
diskLunList:
description: >-
List of Disks' Logical Unit Numbers (LUN) to be used for VM
Protection.
type: array
items:
format: int32
type: integer
isInclusionList:
description: >-
Flag to indicate whether DiskLunList is to be included/ excluded from
backup.
type: boolean
ClientDiscoveryDisplay:
description: Localized display information of an operation.
type: object
properties:
provider:
description: Name of the provider for display purposes
type: string
resource:
description: ResourceType for which this Operation can be performed.
type: string
operation:
description: Operations Name itself.
type: string
description:
description: >-
Description of the operation having details of what operation is
about.
type: string
ClientDiscoveryForLogSpecification:
description: Class to represent shoebox log specification in json client discovery.
type: object
properties:
name:
description: Name for shoebox log specification.
type: string
displayName:
description: Localized display name
type: string
blobDuration:
description: blob duration of shoebox log specification
type: string
ClientDiscoveryForProperties:
description: Class to represent shoebox properties in json client discovery.
type: object
properties:
serviceSpecification:
$ref: '#/definitions/ClientDiscoveryForServiceSpecification'
description: Operation properties.
ClientDiscoveryForServiceSpecification:
description: Class to represent shoebox service specification in json client discovery.
type: object
properties:
logSpecifications:
description: List of log specifications of this operation.
type: array
items:
$ref: '#/definitions/ClientDiscoveryForLogSpecification'
x-ms-identifiers: []
ClientDiscoveryResponse:
description: Operations List response which contains list of available APIs.
type: object
properties:
value:
description: List of available operations.
type: array
items:
$ref: '#/definitions/ClientDiscoveryValueForSingleApi'
x-ms-identifiers: []
nextLink:
description: Link to the next chunk of Response.
type: string
ClientDiscoveryValueForSingleApi:
description: Available operation details.
type: object
properties:
name:
description: Name of the Operation.
type: string
display:
$ref: '#/definitions/ClientDiscoveryDisplay'
description: >-
Contains the localized display information for this particular
operation
origin:
description: >-
The intended executor of the operation;governs the display of the
operation in the RBAC UX and the audit logs UX
type: string
properties:
$ref: '#/definitions/ClientDiscoveryForProperties'
description: ShoeBox properties for the given operation.
DiskInformation:
description: Disk information
type: object
properties:
lun:
format: int32
type: integer
name:
type: string
DailyRetentionFormat:
description: Daily retention format.
type: object
properties:
daysOfTheMonth:
description: List of days of the month.
type: array
items:
$ref: '#/definitions/Day'
x-ms-identifiers: []
DailyRetentionSchedule:
description: Daily retention schedule.
type: object
properties:
retentionTimes:
description: Retention times of retention policy.
type: array
items:
format: date-time
type: string
retentionDuration:
$ref: '#/definitions/RetentionDuration'
description: Retention duration of retention Policy.
Day:
description: Day of the week.
type: object
properties:
date:
format: int32
description: Date of the month
type: integer
isLast:
description: Whether Date is last date of month
type: boolean
DpmErrorInfo:
description: DPM workload-specific error information.
type: object
properties:
errorString:
description: Localized error string.
type: string
recommendations:
description: List of localized recommendations for above error code.
type: array
items:
type: string
DpmJob:
description: DPM workload-specific job object.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
duration:
format: duration
description: Time elapsed for job.
type: string
dpmServerName:
description: DPM server name managing the backup item or backup job.
type: string
containerName:
description: Name of cluster/server protecting current backup item, if any.
type: string
containerType:
description: Type of container.
type: string
workloadType:
description: Type of backup item.
type: string
actionsInfo:
description: The state/actions applicable on this job like cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
errorDetails:
description: The errors.
type: array
items:
$ref: '#/definitions/DpmErrorInfo'
x-ms-identifiers: []
extendedInfo:
$ref: '#/definitions/DpmJobExtendedInfo'
description: Additional information for this job.
x-ms-discriminator-value: DpmJob
BackupResourceConfigResource:
description: The resource storage details.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupResourceConfig'
description: BackupResourceConfigResource properties
BackupResourceConfig:
description: The resource storage details.
type: object
properties:
storageModelType:
description: Storage type
enum:
- Invalid
- GeoRedundant
- LocallyRedundant
- ZoneRedundant
- ReadAccessGeoZoneRedundant
type: string
x-ms-enum:
name: StorageType
modelAsString: true
storageType:
description: Storage type.
enum:
- Invalid
- GeoRedundant
- LocallyRedundant
- ZoneRedundant
- ReadAccessGeoZoneRedundant
type: string
x-ms-enum:
name: StorageType
modelAsString: true
storageTypeState:
description: >-
Locked or Unlocked. Once a machine is registered against a resource,
the storageTypeState is always Locked.
enum:
- Invalid
- Locked
- Unlocked
type: string
x-ms-enum:
name: StorageTypeState
modelAsString: true
crossRegionRestoreFlag:
description: Opt in details of Cross Region Restore feature.
type: boolean
dedupState:
description: Vault Dedup state
enum:
- Invalid
- Enabled
- Disabled
type: string
x-ms-enum:
name: dedupState
modelAsString: true
xcoolState:
description: Vault x-cool state
enum:
- Invalid
- Enabled
- Disabled
type: string
x-ms-enum:
name: xcoolState
modelAsString: true
DpmJobExtendedInfo:
description: Additional information on the DPM workload-specific job.
type: object
properties:
tasksList:
description: List of tasks associated with this job.
type: array
items:
$ref: '#/definitions/DpmJobTaskDetails'
x-ms-identifiers:
- taskId
propertyBag:
description: The job properties.
type: object
additionalProperties:
type: string
dynamicErrorMessage:
description: Non localized error message on job execution.
type: string
DpmJobTaskDetails:
description: DPM workload-specific job task details.
type: object
properties:
taskId:
description: The task display name.
type: string
startTime:
format: date-time
description: The start time.
type: string
endTime:
format: date-time
description: The end time.
type: string
duration:
format: duration
description: Time elapsed for task.
type: string
status:
description: The status.
type: string
DPMProtectedItem:
description: Additional information on Backup engine specific backup item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of the managed item
type: string
backupEngineName:
description: Backup Management server protecting this backup item
type: string
protectionState:
description: Protection state of the backup engine
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectedItemState
modelAsString: true
extendedInfo:
$ref: '#/definitions/DPMProtectedItemExtendedInfo'
description: Extended info of the backup item.
x-ms-discriminator-value: DPMProtectedItem
DPMProtectedItemExtendedInfo:
description: Additional information of DPM Protected item.
type: object
properties:
protectableObjectLoadPath:
description: Attribute to provide information on various DBs.
type: object
additionalProperties:
type: string
protected:
description: To check if backup item is disk protected.
type: boolean
isPresentOnCloud:
description: To check if backup item is cloud protected.
type: boolean
lastBackupStatus:
description: Last backup status information on backup item.
type: string
lastRefreshedAt:
format: date-time
description: Last refresh time on backup item.
type: string
oldestRecoveryPoint:
format: date-time
description: Oldest cloud recovery point time.
type: string
recoveryPointCount:
format: int32
description: cloud recovery point count.
type: integer
onPremiseOldestRecoveryPoint:
format: date-time
description: Oldest disk recovery point time.
type: string
onPremiseLatestRecoveryPoint:
format: date-time
description: latest disk recovery point time.
type: string
onPremiseRecoveryPointCount:
format: int32
description: disk recovery point count.
type: integer
isCollocated:
description: To check if backup item is collocated.
type: boolean
protectionGroupName:
description: Protection group name of the backup item.
type: string
diskStorageUsedInBytes:
description: Used Disk storage in bytes.
type: string
totalDiskStorageSizeInBytes:
description: total Disk storage in bytes.
type: string
EncryptionDetails:
description: Details needed if the VM was encrypted at the time of backup.
type: object
properties:
encryptionEnabled:
description: >-
Identifies whether this backup copy represents an encrypted VM at the
time of backup.
type: boolean
kekUrl:
description: Key Url.
type: string
secretKeyUrl:
description: Secret Url.
type: string
kekVaultId:
description: ID of Key Vault where KEK is stored.
type: string
secretKeyVaultId:
description: ID of Key Vault where Secret is stored.
type: string
ErrorDetail:
description: Error Detail class which encapsulates Code, Message and Recommendations.
type: object
properties:
code:
description: Error code.
type: string
readOnly: true
message:
description: Error Message related to the Code.
type: string
readOnly: true
recommendations:
description: List of recommendation strings.
type: array
items:
type: string
readOnly: true
ExportJobsOperationResultInfo:
description: This class is used to send blob details after exporting jobs.
type: object
allOf:
- $ref: '#/definitions/OperationResultInfoBase'
properties:
blobUrl:
description: >-
URL of the blob into which the serialized string of list of jobs is
exported.
type: string
blobSasKey:
description: SAS key to access the blob. It expires in 15 mins.
type: string
excelFileBlobUrl:
description: URL of the blob into which the ExcelFile is uploaded.
type: string
excelFileBlobSasKey:
description: SAS key to access the blob. It expires in 15 mins.
type: string
x-ms-discriminator-value: ExportJobsOperationResultInfo
ExtendedProperties:
description: Extended Properties for Azure IaasVM Backup.
type: object
properties:
diskExclusionProperties:
$ref: '#/definitions/DiskExclusionProperties'
description: Extended Properties for Disk Exclusion.
linuxVmApplicationName:
description: Linux VM name
type: string
GenericProtectionPolicy:
description: Azure VM (Mercury) workload-specific backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
subProtectionPolicy:
description: List of sub-protection policies which includes schedule and retention
type: array
items:
$ref: '#/definitions/SubProtectionPolicy'
x-ms-identifiers: []
timeZone:
description: >-
TimeZone optional input as string. For example: TimeZone = "Pacific
Standard Time".
type: string
fabricName:
description: Name of this policy's fabric.
type: string
x-ms-discriminator-value: GenericProtectionPolicy
HourlySchedule:
type: object
properties:
interval:
format: int32
description: "Interval at which backup needs to be triggered. For hourly the value\r\n can be 4/6/8/12"
type: integer
scheduleWindowStartTime:
format: date-time
description: To specify start time of the backup window
type: string
scheduleWindowDuration:
format: int32
description: To specify duration of the backup window
type: integer
DailySchedule:
type: object
properties:
scheduleRunTimes:
description: List of times of day this schedule has to be run.
type: array
items:
format: date-time
type: string
WeeklySchedule:
type: object
properties:
scheduleRunDays:
type: array
items:
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
x-ms-enum:
name: DayOfWeek
modelAsString: false
scheduleRunTimes:
description: List of times of day this schedule has to be run.
type: array
items:
format: date-time
type: string
IdentityBasedRestoreDetails:
description: >-
IaaS VM workload specific restore details for restores using managed
identity
type: object
properties:
objectType:
description: Gets the class type.
type: string
targetStorageAccountId:
description: Fully qualified ARM ID of the target storage account.
type: string
IdentityInfo:
description: Encapsulates Managed Identity related information
type: object
properties:
isSystemAssignedIdentity:
description: >-
To differentiate if the managed identity is system assigned or user
assigned
type: boolean
managedIdentityResourceId:
description: "Managed Identity Resource Id\r\nOptional: Might not be required in the case of system assigned managed identity"
type: string
InstantRPAdditionalDetails:
type: object
properties:
azureBackupRGNamePrefix:
type: string
azureBackupRGNameSuffix:
type: string
GenericProtectedItem:
description: Base class for backup items.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of the container.
type: string
policyState:
description: >-
Indicates consistency of policy object and policy applied to this
backup item.
type: string
protectionState:
description: Backup state of this backup item.
enum:
- Invalid
- IRPending
- Protected
- ProtectionError
- ProtectionStopped
- ProtectionPaused
type: string
x-ms-enum:
name: ProtectionState
modelAsString: true
protectedItemId:
format: int64
description: Data Plane Service ID of the protected item.
type: integer
sourceAssociations:
description: >-
Loosely coupled (type, value) associations (example - parent of a
protected item)
type: object
additionalProperties:
type: string
fabricName:
description: Name of this backup item's fabric.
type: string
x-ms-discriminator-value: GenericProtectedItem
GenericRecoveryPoint:
description: Generic backup copy.
type: object
allOf:
- $ref: '#/definitions/RecoveryPoint'
properties:
friendlyName:
description: Friendly name of the backup copy.
type: string
recoveryPointType:
description: Type of the backup copy.
type: string
recoveryPointTime:
format: date-time
description: Time at which this backup copy was created.
type: string
recoveryPointAdditionalInfo:
description: Additional information associated with this backup copy.
type: string
x-ms-discriminator-value: GenericRecoveryPoint
GetProtectedItemQueryObject:
description: Filters to list backup items.
type: object
properties:
expand:
description: >-
Specifies if the additional information should be provided for this
item.
type: string
IaasVMRecoveryPoint:
description: IaaS VM workload specific backup copy.
type: object
allOf:
- $ref: '#/definitions/RecoveryPoint'
properties:
recoveryPointType:
description: Type of the backup copy.
type: string
recoveryPointTime:
format: date-time
description: Time at which this backup copy was created.
type: string
recoveryPointAdditionalInfo:
description: Additional information associated with this backup copy.
type: string
sourceVMStorageType:
description: Storage type of the VM whose backup copy is created.
type: string
isSourceVMEncrypted:
description: >-
Identifies whether the VM was encrypted when the backup copy is
created.
type: boolean
keyAndSecret:
$ref: '#/definitions/KeyAndSecretDetails'
description: >-
Required details for recovering an encrypted VM. Applicable only when
IsSourceVMEncrypted is true.
isInstantIlrSessionActive:
description: Is the session to recover items from this backup copy still active.
type: boolean
recoveryPointTierDetails:
description: Recovery point tier information.
type: array
items:
$ref: '#/definitions/RecoveryPointTierInformationV2'
x-ms-identifiers: []
isManagedVirtualMachine:
description: Whether VM is with Managed Disks
type: boolean
virtualMachineSize:
description: Virtual Machine Size
type: string
originalStorageAccountOption:
description: Original Storage Account Option
type: boolean
osType:
description: OS type
type: string
recoveryPointDiskConfiguration:
$ref: '#/definitions/RecoveryPointDiskConfiguration'
description: Disk configuration
zones:
description: >-
Identifies the zone of the VM at the time of backup. Applicable only
for zone-pinned Vms
type: array
items:
type: string
recoveryPointMoveReadinessInfo:
description: Eligibility of RP to be moved to another tier
type: object
additionalProperties:
$ref: '#/definitions/RecoveryPointMoveReadinessInfo'
x-ms-discriminator-value: IaasVMRecoveryPoint
IaasVMRestoreRequest:
description: IaaS VM workload-specific restore.
type: object
allOf:
- $ref: '#/definitions/RestoreRequest'
properties:
recoveryPointId:
description: Recovery Point ID Name of the backup copy to be recovered.
type: string
recoveryType:
description: Type of this recovery.
enum:
- Invalid
- OriginalLocation
- AlternateLocation
- RestoreDisks
- Offline
type: string
x-ms-enum:
name: RecoveryType
modelAsString: true
sourceResourceId:
description: Fully qualified ARM ID of the VM which is being recovered.
type: string
targetVirtualMachineId:
description: "This is the complete ARM Id of the VM that will be created.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}"
type: string
targetResourceGroupId:
description: "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}"
type: string
storageAccountId:
description: >-
Fully qualified ARM ID of the storage account to which the VM has to
be restored.
type: string
virtualNetworkId:
description: "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\nUser will be validated for join action permissions in the linked access."
type: string
subnetId:
description: "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\nthe subnet."
type: string
targetDomainNameId:
description: "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\nVirtual Machines."
type: string
region:
description: Region in which the virtual machine is restored.
type: string
affinityGroup:
description: >-
Affinity group associated to VM to be restored. Used only for Classic
Compute Virtual Machines.
type: string
createNewCloudService:
description: "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\ncloud service as it was at the time of backup."
type: boolean
originalStorageAccountOption:
description: Original Storage Account Option
type: boolean
encryptionDetails:
$ref: '#/definitions/EncryptionDetails'
description: Details needed if the VM was encrypted at the time of backup.
restoreDiskLunList:
description: List of Disk LUNs for partial restore
type: array
items:
format: int32
type: integer
restoreWithManagedDisks:
description: >-
Flag to denote of an Unmanaged disk VM should be restored with Managed
disks.
type: boolean
diskEncryptionSetId:
description: >-
DiskEncryptionSet's ID - needed if the VM needs to be encrypted at
rest during restore with customer managed key.
type: string
zones:
description: Target zone where the VM and its disks should be restored.
type: array
items:
type: string
identityInfo:
$ref: '#/definitions/IdentityInfo'
description: >-
Managed Identity information required to access customer storage
account.
identityBasedRestoreDetails:
$ref: '#/definitions/IdentityBasedRestoreDetails'
description: >-
IaaS VM workload specific restore details for restores using managed
identity.
x-ms-discriminator-value: IaasVMRestoreRequest
Job:
description: Defines workload agnostic properties for a job.
required:
- jobType
type: object
properties:
entityFriendlyName:
description: Friendly name of the entity on which the current job is executing.
type: string
backupManagementType:
description: Backup management type to execute the current job.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
operation:
description: The operation name.
type: string
status:
description: Job status.
type: string
startTime:
format: date-time
description: The start time.
type: string
endTime:
format: date-time
description: The end time.
type: string
activityId:
description: ActivityId of job.
type: string
jobType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: jobType
JobQueryObject:
description: Filters to list the jobs.
type: object
properties:
status:
description: Status of the job.
enum:
- Invalid
- InProgress
- Completed
- Failed
- CompletedWithWarnings
- Cancelled
- Cancelling
type: string
x-ms-enum:
name: JobStatus
modelAsString: true
backupManagementType:
description: Type of backup management for the job.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
operation:
description: Type of operation.
enum:
- Invalid
- Register
- UnRegister
- ConfigureBackup
- Backup
- Restore
- DisableBackup
- DeleteBackupData
- CrossRegionRestore
- Undelete
- UpdateCustomerManagedKey
type: string
x-ms-enum:
name: JobOperationType
modelAsString: true
jobId:
description: JobID represents the job uniquely.
type: string
startTime:
format: date-time
description: Job has started at this time. Value is in UTC.
type: string
endTime:
format: date-time
description: Job has ended at this time. Value is in UTC.
type: string
JobResource:
description: Defines workload agnostic properties for a job.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/Job'
description: JobResource properties
JobResourceList:
description: List of Job resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/JobResource'
KEKDetails:
description: KEK is encryption key for BEK.
type: object
properties:
keyUrl:
description: Key is KEK.
type: string
keyVaultId:
description: Key Vault ID where this Key is stored.
type: string
keyBackupData:
description: KEK data.
type: string
KeyAndSecretDetails:
description: "BEK is bitlocker key.\r\nKEK is encryption key for BEK\r\nIf the VM was encrypted then we will store following details :\r\n1. Secret(BEK) - Url + Backup Data + vaultId.\r\n2. Key(KEK) - Url + Backup Data + vaultId.\r\n3. EncryptionMechanism\r\nBEK and KEK can potentially have different vault ids."
type: object
properties:
kekDetails:
$ref: '#/definitions/KEKDetails'
description: KEK is encryption key for BEK.
bekDetails:
$ref: '#/definitions/BEKDetails'
description: BEK is bitlocker encryption key.
encryptionMechanism:
description: 'Encryption mechanism: None/ SinglePass/ DoublePass'
type: string
LogSchedulePolicy:
description: Log policy schedule.
type: object
allOf:
- $ref: '#/definitions/SchedulePolicy'
properties:
scheduleFrequencyInMins:
format: int32
description: Frequency of the log schedule operation of this policy in minutes.
type: integer
x-ms-discriminator-value: LogSchedulePolicy
LongTermRetentionPolicy:
description: Long term retention policy.
type: object
allOf:
- $ref: '#/definitions/RetentionPolicy'
properties:
dailySchedule:
$ref: '#/definitions/DailyRetentionSchedule'
description: Daily retention schedule of the protection policy.
weeklySchedule:
$ref: '#/definitions/WeeklyRetentionSchedule'
description: Weekly retention schedule of the protection policy.
monthlySchedule:
$ref: '#/definitions/MonthlyRetentionSchedule'
description: Monthly retention schedule of the protection policy.
yearlySchedule:
$ref: '#/definitions/YearlyRetentionSchedule'
description: Yearly retention schedule of the protection policy.
x-ms-discriminator-value: LongTermRetentionPolicy
LongTermSchedulePolicy:
description: Long term policy schedule.
type: object
allOf:
- $ref: '#/definitions/SchedulePolicy'
x-ms-discriminator-value: LongTermSchedulePolicy
MabErrorInfo:
description: MAB workload-specific error information.
type: object
properties:
errorString:
description: Localized error string.
type: string
readOnly: true
recommendations:
description: List of localized recommendations.
type: array
items:
type: string
readOnly: true
MabFileFolderProtectedItem:
description: MAB workload-specific backup item.
type: object
allOf:
- $ref: '#/definitions/ProtectedItem'
properties:
friendlyName:
description: Friendly name of this backup item.
type: string
computerName:
description: Name of the computer associated with this backup item.
type: string
lastBackupStatus:
description: Status of last backup operation.
type: string
lastBackupTime:
format: date-time
description: Timestamp of the last backup operation on this backup item.
type: string
protectionState:
description: Protected, ProtectionStopped, IRPending or ProtectionError
type: string
deferredDeleteSyncTimeInUTC:
format: int64
description: Sync time for deferred deletion in UTC
type: integer
extendedInfo:
$ref: '#/definitions/MabFileFolderProtectedItemExtendedInfo'
description: Additional information with this backup item.
x-ms-discriminator-value: MabFileFolderProtectedItem
MabFileFolderProtectedItemExtendedInfo:
description: Additional information on the backed up item.
type: object
properties:
lastRefreshedAt:
format: date-time
description: Last time when the agent data synced to service.
type: string
oldestRecoveryPoint:
format: date-time
description: The oldest backup copy available.
type: string
recoveryPointCount:
format: int32
description: Number of backup copies associated with the backup item.
type: integer
MabJob:
description: MAB workload-specific job.
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
duration:
format: duration
description: Time taken by job to run.
type: string
actionsInfo:
description: The state/actions applicable on jobs like cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
mabServerName:
description: Name of server protecting the DS.
type: string
mabServerType:
description: Server type of MAB container.
enum:
- Invalid
- Unknown
- IaasVMContainer
- IaasVMServiceContainer
- DPMContainer
- AzureBackupServerContainer
- MABContainer
- Cluster
- AzureSqlContainer
- Windows
- VCenter
- VMAppContainer
- SQLAGWorkLoadContainer
- StorageContainer
- GenericContainer
type: string
x-ms-enum:
name: MabServerType
modelAsString: true
workloadType:
description: Workload type of backup item.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
errorDetails:
description: The errors.
type: array
items:
$ref: '#/definitions/MabErrorInfo'
x-ms-identifiers: []
extendedInfo:
$ref: '#/definitions/MabJobExtendedInfo'
description: Additional information on the job.
x-ms-discriminator-value: MabJob
MabJobExtendedInfo:
description: Additional information for the MAB workload-specific job.
type: object
properties:
tasksList:
description: List of tasks for this job.
type: array
items:
$ref: '#/definitions/MabJobTaskDetails'
x-ms-identifiers:
- taskId
propertyBag:
description: The job properties.
type: object
additionalProperties:
type: string
dynamicErrorMessage:
description: Non localized error message specific to this job.
type: string
MabJobTaskDetails:
description: MAB workload-specific job task details.
type: object
properties:
taskId:
description: The task display name.
type: string
startTime:
format: date-time
description: The start time.
type: string
endTime:
format: date-time
description: The end time.
type: string
duration:
format: duration
description: Time elapsed for task.
type: string
status:
description: The status.
type: string
MabProtectionPolicy:
description: Mab container-specific backup policy.
type: object
allOf:
- $ref: '#/definitions/ProtectionPolicy'
properties:
schedulePolicy:
$ref: '#/definitions/SchedulePolicy'
description: Backup schedule of backup policy.
retentionPolicy:
$ref: '#/definitions/RetentionPolicy'
description: Retention policy details.
x-ms-discriminator-value: MAB
MonthlyRetentionSchedule:
description: Monthly retention schedule.
type: object
properties:
retentionScheduleFormatType:
description: Retention schedule format type for monthly retention policy.
enum:
- Invalid
- Daily
- Weekly
type: string
x-ms-enum:
name: RetentionScheduleFormat
modelAsString: true
retentionScheduleDaily:
$ref: '#/definitions/DailyRetentionFormat'
description: Daily retention format for monthly retention policy.
retentionScheduleWeekly:
$ref: '#/definitions/WeeklyRetentionFormat'
description: Weekly retention format for monthly retention policy.
retentionTimes:
description: Retention times of retention policy.
type: array
items:
format: date-time
type: string
retentionDuration:
$ref: '#/definitions/RetentionDuration'
description: Retention duration of retention Policy.
OperationResultInfo:
description: Operation result info.
type: object
allOf:
- $ref: '#/definitions/OperationResultInfoBase'
properties:
jobList:
description: List of jobs created by this operation.
type: array
items:
type: string
x-ms-discriminator-value: OperationResultInfo
OperationResultInfoBase:
description: Base class for operation result info.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
KPIResourceHealthDetails:
description: KPI Resource Health Details
type: object
properties:
resourceHealthStatus:
description: Resource Health Status
enum:
- Healthy
- TransientDegraded
- PersistentDegraded
- TransientUnhealthy
- PersistentUnhealthy
- Invalid
type: string
x-ms-enum:
name: ResourceHealthStatus
modelAsString: true
resourceHealthDetails:
description: Resource Health Status
type: array
items:
$ref: '#/definitions/ResourceHealthDetails'
x-ms-identifiers:
- code
PrepareDataMoveRequest:
description: Prepare DataMove Request
required:
- targetResourceId
- targetRegion
- dataMoveLevel
type: object
properties:
targetResourceId:
description: ARM Id of target vault
type: string
targetRegion:
description: Target Region
type: string
dataMoveLevel:
description: DataMove Level
enum:
- Invalid
- Vault
- Container
type: string
x-ms-enum:
name: DataMoveLevel
modelAsString: true
sourceContainerArmIds:
description: "Source Container ArmIds\r\nThis needs to be populated only if DataMoveLevel is set to container"
type: array
items:
type: string
ignoreMoved:
description: Ignore the artifacts which are already moved.
type: boolean
PrepareDataMoveResponse:
description: Prepare DataMove Response
type: object
allOf:
- $ref: '#/definitions/VaultStorageConfigOperationResultResponse'
properties:
correlationId:
description: Co-relationId for move operation
type: string
sourceVaultProperties:
description: Source Vault Properties
type: object
additionalProperties:
type: string
x-ms-discriminator-value: PrepareDataMoveResponse
VaultStorageConfigOperationResultResponse:
description: Operation result response for Vault Storage Config
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
TriggerDataMoveRequest:
description: Trigger DataMove Request
required:
- sourceResourceId
- sourceRegion
- dataMoveLevel
- correlationId
type: object
properties:
sourceResourceId:
description: ARM Id of source vault
type: string
sourceRegion:
description: Source Region
type: string
dataMoveLevel:
description: DataMove Level
enum:
- Invalid
- Vault
- Container
type: string
x-ms-enum:
name: DataMoveLevel
modelAsString: true
correlationId:
description: Correlation Id
type: string
sourceContainerArmIds:
description: Source Container ArmIds
type: array
items:
type: string
pauseGC:
description: Pause GC
type: boolean
OperationResultInfoBaseResource:
description: Base class for operation result info.
allOf:
- $ref: '#/definitions/OperationWorkerResponse'
properties:
operation:
$ref: '#/definitions/OperationResultInfoBase'
description: OperationResultInfoBaseResource operation
OperationWorkerResponse:
description: This is the base class for operation result responses.
type: object
properties:
statusCode:
description: HTTP Status Code of the operation.
enum:
- Continue
- SwitchingProtocols
- OK
- Created
- Accepted
- NonAuthoritativeInformation
- NoContent
- ResetContent
- PartialContent
- MultipleChoices
- Ambiguous
- MovedPermanently
- Moved
- Found
- Redirect
- SeeOther
- RedirectMethod
- NotModified
- UseProxy
- Unused
- TemporaryRedirect
- RedirectKeepVerb
- BadRequest
- Unauthorized
- PaymentRequired
- Forbidden
- NotFound
- MethodNotAllowed
- NotAcceptable
- ProxyAuthenticationRequired
- RequestTimeout
- Conflict
- Gone
- LengthRequired
- PreconditionFailed
- RequestEntityTooLarge
- RequestUriTooLong
- UnsupportedMediaType
- RequestedRangeNotSatisfiable
- ExpectationFailed
- UpgradeRequired
- InternalServerError
- NotImplemented
- BadGateway
- ServiceUnavailable
- GatewayTimeout
- HttpVersionNotSupported
type: string
x-ms-enum:
name: HttpStatusCode
modelAsString: false
headers:
description: HTTP headers associated with this operation.
type: object
additionalProperties:
type: array
items:
type: string
PointInTimeRange:
description: Provides details for log ranges
type: object
properties:
startTime:
format: date-time
description: Start time of the time range for log recovery.
type: string
endTime:
format: date-time
description: End time of the time range for log recovery.
type: string
ProtectedItem:
description: Base class for backup items.
required:
- protectedItemType
type: object
properties:
protectedItemType:
description: backup item type.
type: string
backupManagementType:
description: Type of backup management for the backed up item.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
readOnly: true
workloadType:
description: Type of workload this item represents.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: DataSourceType
modelAsString: true
readOnly: true
containerName:
description: Unique name of container
type: string
sourceResourceId:
description: ARM ID of the resource to be backed up.
type: string
policyId:
description: ID of the backup policy with which this item is backed up.
type: string
lastRecoveryPoint:
format: date-time
description: >-
Timestamp when the last (latest) backup copy was created for this
backup item.
type: string
backupSetName:
description: Name of the backup set the backup item belongs to
type: string
createMode:
description: >-
Create mode to indicate recovery of existing soft deleted data source
or creation of new data source.
enum:
- Invalid
- Default
- Recover
type: string
x-ms-enum:
name: CreateMode
modelAsString: true
deferredDeleteTimeInUTC:
format: date-time
description: Time for deferred deletion in UTC
type: string
isScheduledForDeferredDelete:
description: Flag to identify whether the DS is scheduled for deferred delete
type: boolean
deferredDeleteTimeRemaining:
description: >-
Time remaining before the DS marked for deferred delete is permanently
deleted
type: string
isDeferredDeleteScheduleUpcoming:
description: Flag to identify whether the deferred deleted DS is to be purged soon
type: boolean
isRehydrate:
description: >-
Flag to identify that deferred deleted DS is to be moved into Pause
state
type: boolean
resourceGuardOperationRequests:
description: ResourceGuardOperationRequests on which LAC check will be performed
type: array
items:
type: string
isArchiveEnabled:
description: Flag to identify whether datasource is protected in archive
type: boolean
policyName:
description: Name of the policy used for protection
type: string
softDeleteRetentionPeriod:
format: int32
description: Soft delete retention period in days
type: integer
discriminator: protectedItemType
ProtectedItemQueryObject:
description: Filters to list backup items.
type: object
properties:
healthState:
description: Health State for the backed up item.
enum:
- Passed
- ActionRequired
- ActionSuggested
- Invalid
type: string
x-ms-enum:
name: HealthState
modelAsString: true
backupManagementType:
description: Backup management type for the backed up item.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
itemType:
description: Type of workload this item represents.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: DataSourceType
modelAsString: true
policyName:
description: Backup policy name associated with the backup item.
type: string
containerName:
description: Name of the container.
type: string
backupEngineName:
description: Backup Engine name
type: string
friendlyName:
description: Friendly name of protected item
type: string
fabricName:
description: Name of the fabric.
type: string
backupSetName:
description: Name of the backup set.
type: string
ProtectedItemResource:
description: Base class for backup items.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ProtectedItem'
description: ProtectedItemResource properties
ProtectedItemResourceList:
description: List of ProtectedItem resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ProtectedItemResource'
ProtectionPolicy:
description: >-
Base class for backup policy. Workload-specific backup policies are
derived from this class.
required:
- backupManagementType
type: object
properties:
protectedItemsCount:
format: int32
description: Number of items associated with this policy.
type: integer
backupManagementType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
resourceGuardOperationRequests:
description: ResourceGuard Operation Requests
type: array
items:
type: string
discriminator: backupManagementType
ProtectionPolicyQueryObject:
description: Filters the list backup policies API.
type: object
properties:
backupManagementType:
description: Backup management type for the backup policy.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
fabricName:
description: Fabric name for filter
type: string
workloadType:
description: Workload type for the backup policy.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
ProtectionPolicyResource:
description: >-
Base class for backup policy. Workload-specific backup policies are
derived from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ProtectionPolicy'
description: ProtectionPolicyResource properties
ProtectionPolicyResourceList:
description: List of ProtectionPolicy resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ProtectionPolicyResource'
RecoveryPoint:
description: >-
Base class for backup copies. Workload-specific backup copies are derived
from this class.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
RecoveryPointDiskConfiguration:
description: Disk configuration
type: object
properties:
numberOfDisksIncludedInBackup:
format: int32
description: Number of disks included in backup
type: integer
numberOfDisksAttachedToVm:
format: int32
description: Number of disks attached to the VM
type: integer
includedDiskList:
description: Information of disks included in backup
type: array
items:
$ref: '#/definitions/DiskInformation'
x-ms-identifiers: []
excludedDiskList:
description: Information of disks excluded from backup
type: array
items:
$ref: '#/definitions/DiskInformation'
x-ms-identifiers: []
RecoveryPointResource:
description: >-
Base class for backup copies. Workload-specific backup copies are derived
from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/RecoveryPoint'
description: RecoveryPointResource properties
RecoveryPointResourceList:
description: List of RecoveryPoint resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/RecoveryPointResource'
RecoveryPointTierInformation:
description: Recovery point tier information.
type: object
properties:
type:
description: Recovery point tier type.
enum:
- Invalid
- InstantRP
- HardenedRP
- ArchivedRP
type: string
x-ms-enum:
name: RecoveryPointTierType
modelAsString: false
status:
description: Recovery point tier status.
enum:
- Invalid
- Valid
- Disabled
- Deleted
- Rehydrated
type: string
x-ms-enum:
name: RecoveryPointTierStatus
modelAsString: false
extendedInfo:
description: Recovery point tier status.
type: object
additionalProperties:
type: string
RecoveryPointTierInformationV2:
description: RecoveryPoint Tier Information V2
type: object
allOf:
- $ref: '#/definitions/RecoveryPointTierInformation'
properties:
type:
description: Recovery point tier type.
enum:
- Invalid
- InstantRP
- HardenedRP
- ArchivedRP
type: string
x-ms-enum:
name: RecoveryPointTierType
modelAsString: true
status:
description: Recovery point tier status.
enum:
- Invalid
- Valid
- Disabled
- Deleted
- Rehydrated
type: string
x-ms-enum:
name: RecoveryPointTierStatus
modelAsString: true
Resource:
description: ARM Resource.
type: object
properties:
id:
description: Resource Id represents the complete path to the resource.
type: string
readOnly: true
name:
description: Resource name associated with the resource.
type: string
readOnly: true
type:
description: >-
Resource type represents the complete path of the form
Namespace/ResourceType/ResourceType/...
type: string
readOnly: true
location:
description: Resource location.
type: string
tags:
description: Resource tags.
type: object
additionalProperties:
type: string
eTag:
description: Optional ETag.
type: string
x-ms-azure-resource: true
ResourceList:
description: Base for all lists of resources.
type: object
properties:
nextLink:
description: >-
The uri to fetch the next page of resources. Call ListNext() fetches
next page of resources.
type: string
RestoreFileSpecs:
description: Restore file specs like file path, type and target folder path info.
type: object
properties:
path:
description: Source File/Folder path
type: string
fileSpecType:
description: Indicates what the Path variable stands for
type: string
targetFolderPath:
description: Destination folder path in target FileShare
type: string
RestoreRequest:
description: >-
Base class for restore request. Workload-specific restore requests are
derived from this class.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
RestoreRequestResource:
description: >-
Base class for restore request. Workload-specific restore requests are
derived from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/RestoreRequest'
description: RestoreRequestResource properties
RetentionDuration:
description: Retention duration.
type: object
properties:
count:
format: int32
description: "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\nFor example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks."
type: integer
durationType:
description: Retention duration type of retention policy.
enum:
- Invalid
- Days
- Weeks
- Months
- Years
type: string
x-ms-enum:
name: RetentionDurationType
modelAsString: true
RetentionPolicy:
description: Base class for retention policy.
required:
- retentionPolicyType
type: object
properties:
retentionPolicyType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: retentionPolicyType
SchedulePolicy:
description: Base class for backup schedule.
required:
- schedulePolicyType
type: object
properties:
schedulePolicyType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: schedulePolicyType
Settings:
description: Common settings field for backup management
type: object
properties:
timeZone:
description: >-
TimeZone optional input as string. For example: TimeZone = "Pacific
Standard Time".
type: string
issqlcompression:
description: SQL compression flag
type: boolean
isCompression:
description: "Workload compression flag. This has been added so that 'isSqlCompression'\r\nwill be deprecated once clients upgrade to consider this flag."
type: boolean
SimpleRetentionPolicy:
description: Simple policy retention.
type: object
allOf:
- $ref: '#/definitions/RetentionPolicy'
properties:
retentionDuration:
$ref: '#/definitions/RetentionDuration'
description: Retention duration of the protection policy.
x-ms-discriminator-value: SimpleRetentionPolicy
SimpleSchedulePolicy:
description: Simple policy schedule.
type: object
allOf:
- $ref: '#/definitions/SchedulePolicy'
properties:
scheduleRunFrequency:
description: Frequency of the schedule operation of this policy.
enum:
- Invalid
- Daily
- Weekly
- Hourly
type: string
x-ms-enum:
name: ScheduleRunType
modelAsString: true
scheduleRunDays:
description: List of days of week this schedule has to be run.
type: array
items:
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
x-ms-enum:
name: DayOfWeek
modelAsString: false
scheduleRunTimes:
description: List of times of day this schedule has to be run.
type: array
items:
format: date-time
type: string
hourlySchedule:
$ref: '#/definitions/HourlySchedule'
description: Hourly Schedule of this Policy
scheduleWeeklyFrequency:
format: int32
description: At every number weeks this schedule has to be run.
type: integer
x-ms-discriminator-value: SimpleSchedulePolicy
SimpleSchedulePolicyV2:
description: The V2 policy schedule for IaaS that supports hourly backups.
type: object
allOf:
- $ref: '#/definitions/SchedulePolicy'
properties:
scheduleRunFrequency:
description: Frequency of the schedule operation of this policy.
enum:
- Invalid
- Daily
- Weekly
- Hourly
type: string
x-ms-enum:
name: ScheduleRunType
modelAsString: true
hourlySchedule:
$ref: '#/definitions/HourlySchedule'
description: hourly schedule of this policy
dailySchedule:
$ref: '#/definitions/DailySchedule'
description: Daily schedule of this policy
weeklySchedule:
$ref: '#/definitions/WeeklySchedule'
description: Weekly schedule of this policy
x-ms-discriminator-value: SimpleSchedulePolicyV2
SubProtectionPolicy:
description: Sub-protection policy which includes schedule and retention
type: object
properties:
policyType:
description: Type of backup policy type
enum:
- Invalid
- Full
- Differential
- Log
- CopyOnlyFull
- Incremental
- SnapshotFull
- SnapshotCopyOnlyFull
type: string
x-ms-enum:
name: PolicyType
modelAsString: true
schedulePolicy:
$ref: '#/definitions/SchedulePolicy'
description: Backup schedule specified as part of backup policy.
retentionPolicy:
$ref: '#/definitions/RetentionPolicy'
description: Retention policy with the details on backup copy retention ranges.
tieringPolicy:
description: "Tiering policy to automatically move RPs to another tier.\r\nKey is Target Tier, defined in RecoveryPointTierType enum.\r\nTiering policy specifies the criteria to move RP to the target tier."
type: object
additionalProperties:
$ref: '#/definitions/TieringPolicy'
SQLDataDirectory:
description: SQLDataDirectory info
type: object
properties:
type:
description: Type of data directory mapping
enum:
- Invalid
- Data
- Log
type: string
x-ms-enum:
name: SQLDataDirectoryType
modelAsString: true
path:
description: File path
type: string
logicalName:
description: Logical name of the file
type: string
SQLDataDirectoryMapping:
description: Encapsulates information regarding data directory
type: object
properties:
mappingType:
description: Type of data directory mapping
enum:
- Invalid
- Data
- Log
type: string
x-ms-enum:
name: SQLDataDirectoryType
modelAsString: true
sourceLogicalName:
description: Restore source logical name path
type: string
sourcePath:
description: Restore source path
type: string
targetPath:
description: Target path
type: string
TargetAFSRestoreInfo:
description: Target Azure File Share Info.
type: object
properties:
name:
description: File share name
type: string
targetResourceId:
description: Target file share resource ARM ID
type: string
TargetRestoreInfo:
description: Details about target workload during restore operation.
type: object
properties:
overwriteOption:
description: Can Overwrite if Target DataBase already exists
enum:
- Invalid
- FailOnConflict
- Overwrite
type: string
x-ms-enum:
name: OverwriteOptions
modelAsString: true
containerId:
description: Resource Id name of the container in which Target DataBase resides
type: string
databaseName:
description: >-
Database name InstanceName/DataBaseName for SQL or System/DbName for
SAP Hana
type: string
targetDirectoryForFileRestore:
description: Target directory location for restore as files.
type: string
ValidateIaasVMRestoreOperationRequest:
description: AzureRestoreValidation request.
type: object
allOf:
- $ref: '#/definitions/ValidateRestoreOperationRequest'
x-ms-discriminator-value: ValidateIaasVMRestoreOperationRequest
ValidateOperationRequest:
description: Base class for validate operation request.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
ValidateOperationResponse:
description: Base class for validate operation response.
type: object
properties:
validationResults:
description: Gets the validation result
type: array
items:
$ref: '#/definitions/ErrorDetail'
x-ms-identifiers:
- code
ValidateOperationsResponse:
type: object
properties:
validateOperationResponse:
$ref: '#/definitions/ValidateOperationResponse'
ValidateRestoreOperationRequest:
description: AzureRestoreValidation request.
type: object
allOf:
- $ref: '#/definitions/ValidateOperationRequest'
properties:
restoreRequest:
$ref: '#/definitions/RestoreRequest'
description: Sets restore request to be validated
x-ms-discriminator-value: ValidateRestoreOperationRequest
WeeklyRetentionFormat:
description: Weekly retention format.
type: object
properties:
daysOfTheWeek:
description: List of days of the week.
type: array
items:
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
x-ms-enum:
name: DayOfWeek
modelAsString: false
weeksOfTheMonth:
description: List of weeks of month.
type: array
items:
enum:
- First
- Second
- Third
- Fourth
- Last
- Invalid
type: string
x-ms-enum:
name: WeekOfMonth
modelAsString: false
WeeklyRetentionSchedule:
description: Weekly retention schedule.
type: object
properties:
daysOfTheWeek:
description: List of days of week for weekly retention policy.
type: array
items:
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
type: string
x-ms-enum:
name: DayOfWeek
modelAsString: false
retentionTimes:
description: Retention times of retention policy.
type: array
items:
format: date-time
type: string
retentionDuration:
$ref: '#/definitions/RetentionDuration'
description: Retention duration of retention Policy.
BackupResourceVaultConfigResource:
description: Backup resource vault config details.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupResourceVaultConfig'
description: BackupResourceVaultConfigResource properties
BackupResourceVaultConfig:
description: Backup resource vault config details.
type: object
properties:
storageModelType:
description: Storage type.
enum:
- Invalid
- GeoRedundant
- LocallyRedundant
- ZoneRedundant
- ReadAccessGeoZoneRedundant
type: string
x-ms-enum:
name: StorageType
modelAsString: true
storageType:
description: Storage type.
enum:
- Invalid
- GeoRedundant
- LocallyRedundant
- ZoneRedundant
- ReadAccessGeoZoneRedundant
type: string
x-ms-enum:
name: StorageType
modelAsString: true
storageTypeState:
description: >-
Locked or Unlocked. Once a machine is registered against a resource,
the storageTypeState is always Locked.
enum:
- Invalid
- Locked
- Unlocked
type: string
x-ms-enum:
name: StorageTypeState
modelAsString: true
enhancedSecurityState:
description: Enabled or Disabled.
enum:
- Invalid
- Enabled
- Disabled
type: string
x-ms-enum:
name: EnhancedSecurityState
modelAsString: true
softDeleteFeatureState:
description: Soft Delete feature state
enum:
- Invalid
- Enabled
- Disabled
type: string
x-ms-enum:
name: SoftDeleteFeatureState
modelAsString: true
resourceGuardOperationRequests:
description: ResourceGuard Operation Requests
type: array
items:
type: string
isSoftDeleteFeatureStateEditable:
description: Is soft delete feature state editable
type: boolean
YearlyRetentionSchedule:
description: Yearly retention schedule.
type: object
properties:
retentionScheduleFormatType:
description: Retention schedule format for yearly retention policy.
enum:
- Invalid
- Daily
- Weekly
type: string
x-ms-enum:
name: RetentionScheduleFormat
modelAsString: true
monthsOfYear:
description: List of months of year of yearly retention policy.
type: array
items:
enum:
- Invalid
- January
- February
- March
- April
- May
- June
- July
- August
- September
- October
- November
- December
type: string
x-ms-enum:
name: MonthOfYear
modelAsString: false
retentionScheduleDaily:
$ref: '#/definitions/DailyRetentionFormat'
description: Daily retention format for yearly retention policy.
retentionScheduleWeekly:
$ref: '#/definitions/WeeklyRetentionFormat'
description: Weekly retention format for yearly retention policy.
retentionTimes:
description: Retention times of retention policy.
type: array
items:
format: date-time
type: string
retentionDuration:
$ref: '#/definitions/RetentionDuration'
description: Retention duration of retention Policy.
VaultJob:
description: Vault level Job
type: object
allOf:
- $ref: '#/definitions/Job'
properties:
duration:
format: duration
description: Time elapsed during the execution of this job.
type: string
actionsInfo:
description: >-
Gets or sets the state/actions applicable on this job like
cancel/retry.
type: array
items:
enum:
- Invalid
- Cancellable
- Retriable
type: string
x-ms-enum:
name: JobSupportedAction
modelAsString: false
errorDetails:
description: Error details on execution of this job.
type: array
items:
$ref: '#/definitions/VaultJobErrorInfo'
x-ms-identifiers:
- errorCode
extendedInfo:
$ref: '#/definitions/VaultJobExtendedInfo'
description: Additional information about the job.
x-ms-discriminator-value: VaultJob
VaultJobErrorInfo:
description: Vault Job specific error information
type: object
properties:
errorCode:
format: int32
description: Error code.
type: integer
errorString:
description: Localized error string.
type: string
recommendations:
description: List of localized recommendations for above error code.
type: array
items:
type: string
VaultJobExtendedInfo:
description: Vault Job for CMK - has CMK specific info.
type: object
properties:
propertyBag:
description: Job properties.
type: object
additionalProperties:
type: string
AzureBackupServerContainer:
description: AzureBackupServer (DPMVenus) workload-specific protection container.
type: object
allOf:
- $ref: '#/definitions/DpmContainer'
x-ms-discriminator-value: AzureBackupServerContainer
AzureBackupServerEngine:
description: Backup engine type when Azure Backup Server is used to manage the backups.
type: object
allOf:
- $ref: '#/definitions/BackupEngineBase'
x-ms-discriminator-value: AzureBackupServerEngine
AzureFileShareBackupRequest:
description: AzureFileShare workload-specific backup request.
type: object
allOf:
- $ref: '#/definitions/BackupRequest'
properties:
recoveryPointExpiryTimeInUTC:
format: date-time
description: Backup copy will expire after the time specified (UTC).
type: string
x-ms-discriminator-value: AzureFileShareBackupRequest
AzureFileShareProtectableItem:
description: Protectable item for Azure Fileshare workloads.
type: object
allOf:
- $ref: '#/definitions/WorkloadProtectableItem'
properties:
parentContainerFabricId:
description: >-
Full Fabric ID of container to which this protectable item belongs.
For example, ARM ID.
type: string
parentContainerFriendlyName:
description: Friendly name of container to which this protectable item belongs.
type: string
azureFileShareType:
description: File Share type XSync or XSMB.
enum:
- Invalid
- XSMB
- XSync
type: string
x-ms-enum:
name: AzureFileShareType
modelAsString: true
x-ms-discriminator-value: AzureFileShare
AzureFileShareProvisionILRRequest:
description: >-
Update snapshot Uri with the correct friendly Name of the source Azure
file share.
type: object
allOf:
- $ref: '#/definitions/ILRRequest'
properties:
recoveryPointId:
description: Recovery point ID.
type: string
sourceResourceId:
description: Source Storage account ARM Id
type: string
x-ms-discriminator-value: AzureFileShareProvisionILRRequest
AzureIaaSClassicComputeVMContainer:
description: >-
IaaS VM workload-specific backup item representing a classic virtual
machine.
type: object
allOf:
- $ref: '#/definitions/IaaSVMContainer'
x-ms-discriminator-value: Microsoft.ClassicCompute/virtualMachines
AzureIaaSClassicComputeVMProtectableItem:
description: IaaS VM workload-specific backup item representing the Classic Compute VM.
type: object
allOf:
- $ref: '#/definitions/IaaSVMProtectableItem'
x-ms-discriminator-value: Microsoft.ClassicCompute/virtualMachines
AzureIaaSComputeVMContainer:
description: >-
IaaS VM workload-specific backup item representing an Azure Resource
Manager virtual machine.
type: object
allOf:
- $ref: '#/definitions/IaaSVMContainer'
x-ms-discriminator-value: Microsoft.Compute/virtualMachines
AzureIaaSComputeVMProtectableItem:
description: >-
IaaS VM workload-specific backup item representing the Azure Resource
Manager VM.
type: object
allOf:
- $ref: '#/definitions/IaaSVMProtectableItem'
x-ms-discriminator-value: Microsoft.Compute/virtualMachines
AzureSQLAGWorkloadContainerProtectionContainer:
description: Container for SQL workloads under SQL Availability Group.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadContainer'
x-ms-discriminator-value: SQLAGWorkLoadContainer
AzureSqlContainer:
description: Azure Sql workload-specific container.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
x-ms-discriminator-value: AzureSqlContainer
AzureStorageContainer:
description: Azure Storage Account workload-specific container.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
sourceResourceId:
description: Fully qualified ARM url.
type: string
storageAccountVersion:
description: Storage account version.
type: string
resourceGroup:
description: Resource group name of Recovery Services Vault.
type: string
protectedItemCount:
format: int64
description: Number of items backed up in this container.
type: integer
acquireStorageAccountLock:
description: >-
Whether storage account lock is to be acquired for this container or
not.
enum:
- Acquire
- NotAcquire
type: string
x-ms-enum:
name: AcquireStorageAccountLock
modelAsString: true
x-ms-discriminator-value: StorageContainer
AzureStorageProtectableContainer:
description: Azure Storage-specific protectable containers
type: object
allOf:
- $ref: '#/definitions/ProtectableContainer'
x-ms-discriminator-value: StorageContainer
AzureVMAppContainerProtectableContainer:
description: Azure workload-specific container
type: object
allOf:
- $ref: '#/definitions/ProtectableContainer'
x-ms-discriminator-value: VMAppContainer
AzureVMAppContainerProtectionContainer:
description: Container for SQL workloads under Azure Virtual Machines.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadContainer'
x-ms-discriminator-value: VMAppContainer
AzureVmWorkloadItem:
description: Azure VM workload-specific workload item.
type: object
allOf:
- $ref: '#/definitions/WorkloadItem'
properties:
parentName:
description: Name for instance or AG
type: string
serverName:
description: Host/Cluster Name for instance or AG
type: string
isAutoProtectable:
description: Indicates if workload item is auto-protectable
type: boolean
subinquireditemcount:
format: int32
description: For instance or AG, indicates number of DB's present
type: integer
subWorkloadItemCount:
format: int32
description: For instance or AG, indicates number of DB's to be protected
type: integer
x-ms-discriminator-value: AzureVmWorkloadItem
AzureVmWorkloadProtectableItem:
description: Azure VM workload-specific protectable item.
type: object
allOf:
- $ref: '#/definitions/WorkloadProtectableItem'
properties:
parentName:
description: Name for instance or AG
type: string
parentUniqueName:
description: "Parent Unique Name is added to provide the service formatted URI Name of the Parent\r\nOnly Applicable for data bases where the parent would be either Instance or a SQL AG."
type: string
serverName:
description: Host/Cluster Name for instance or AG
type: string
isAutoProtectable:
description: Indicates if protectable item is auto-protectable
type: boolean
isAutoProtected:
description: Indicates if protectable item is auto-protected
type: boolean
subinquireditemcount:
format: int32
description: For instance or AG, indicates number of DB's present
type: integer
subprotectableitemcount:
format: int32
description: For instance or AG, indicates number of DB's to be protected
type: integer
prebackupvalidation:
$ref: '#/definitions/PreBackupValidation'
description: Pre-backup validation for protectable objects
x-ms-discriminator-value: AzureVmWorkloadProtectableItem
AzureVmWorkloadSAPAseDatabaseWorkloadItem:
description: Azure VM workload-specific workload item representing SAP ASE Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
x-ms-discriminator-value: SAPAseDatabase
AzureVmWorkloadSAPAseSystemProtectableItem:
description: Azure VM workload-specific protectable item representing SAP ASE System.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SAPAseSystem
AzureVmWorkloadSAPAseSystemWorkloadItem:
description: Azure VM workload-specific workload item representing SAP ASE System.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
x-ms-discriminator-value: SAPAseSystem
AzureVmWorkloadSAPHanaDatabaseProtectableItem:
description: >-
Azure VM workload-specific protectable item representing SAP HANA
Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SAPHanaDatabase
AzureVmWorkloadSAPHanaDatabaseWorkloadItem:
description: Azure VM workload-specific workload item representing SAP HANA Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
x-ms-discriminator-value: SAPHanaDatabase
AzureVmWorkloadSAPHanaSystemProtectableItem:
description: Azure VM workload-specific protectable item representing SAP HANA System.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SAPHanaSystem
AzureVmWorkloadSAPHanaDBInstance:
description: >-
Azure VM workload-specific protectable item representing SAP HANA
Dbinstance.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SAPHanaDBInstance
AzureVmWorkloadSAPHanaHSR:
description: >-
Azure VM workload-specific protectable item representing SAP HANA
Dbinstance.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SAPHanaHSR
AzureVmWorkloadSAPHanaSystemWorkloadItem:
description: Azure VM workload-specific workload item representing SAP HANA System.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
x-ms-discriminator-value: SAPHanaSystem
AzureVmWorkloadSQLAvailabilityGroupProtectableItem:
description: >-
Azure VM workload-specific protectable item representing SQL Availability
Group.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SQLAvailabilityGroupContainer
AzureVmWorkloadSQLDatabaseProtectableItem:
description: Azure VM workload-specific protectable item representing SQL Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SQLDataBase
AzureVmWorkloadSQLDatabaseWorkloadItem:
description: Azure VM workload-specific workload item representing SQL Database.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
x-ms-discriminator-value: SQLDataBase
AzureVmWorkloadSQLInstanceProtectableItem:
description: Azure VM workload-specific protectable item representing SQL Instance.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadProtectableItem'
x-ms-discriminator-value: SQLInstance
AzureVmWorkloadSQLInstanceWorkloadItem:
description: Azure VM workload-specific workload item representing SQL Instance.
type: object
allOf:
- $ref: '#/definitions/AzureVmWorkloadItem'
properties:
dataDirectoryPaths:
description: Data Directory Paths for default directories
type: array
items:
$ref: '#/definitions/SQLDataDirectory'
x-ms-identifiers: []
x-ms-discriminator-value: SQLInstance
AzureWorkloadBackupRequest:
description: AzureWorkload workload-specific backup request.
type: object
allOf:
- $ref: '#/definitions/BackupRequest'
properties:
backupType:
description: Type of backup, viz. Full, Differential, Log or CopyOnlyFull
enum:
- Invalid
- Full
- Differential
- Log
- CopyOnlyFull
- Incremental
- SnapshotFull
- SnapshotCopyOnlyFull
type: string
x-ms-enum:
name: backupType
modelAsString: true
enableCompression:
description: Bool for Compression setting
type: boolean
recoveryPointExpiryTimeInUTC:
format: date-time
description: Backup copy will expire after the time specified (UTC).
type: string
x-ms-discriminator-value: AzureWorkloadBackupRequest
AzureBackupGoalFeatureSupportRequest:
description: Azure backup goal feature specific request.
type: object
allOf:
- $ref: '#/definitions/FeatureSupportRequest'
x-ms-discriminator-value: AzureBackupGoals
AzureRecoveryServiceVaultProtectionIntent:
description: Azure Recovery Services Vault specific protection intent item.
type: object
allOf:
- $ref: '#/definitions/ProtectionIntent'
x-ms-discriminator-value: RecoveryServiceVaultItem
AzureResourceProtectionIntent:
description: IaaS VM specific backup protection intent item.
type: object
allOf:
- $ref: '#/definitions/ProtectionIntent'
properties:
friendlyName:
description: Friendly name of the VM represented by this backup item.
type: string
x-ms-discriminator-value: AzureResourceItem
AzureVMResourceFeatureSupportRequest:
description: AzureResource(IaaS VM) Specific feature support request
type: object
allOf:
- $ref: '#/definitions/FeatureSupportRequest'
properties:
vmSize:
description: 'Size of the resource: VM size(A/D series etc) in case of IaasVM'
type: string
vmSku:
description: SKUs (Premium/Managed etc) in case of IaasVM
type: string
x-ms-discriminator-value: AzureVMResourceBackup
AzureVMResourceFeatureSupportResponse:
description: Response for feature support requests for Azure IaasVm
type: object
properties:
supportStatus:
description: Support status of feature
enum:
- Invalid
- Supported
- DefaultOFF
- DefaultON
- NotSupported
type: string
x-ms-enum:
name: SupportStatus
modelAsString: true
AzureWorkloadContainerAutoProtectionIntent:
description: Azure workload specific protection intent item.
type: object
allOf:
- $ref: '#/definitions/ProtectionIntent'
x-ms-discriminator-value: AzureWorkloadContainerAutoProtectionIntent
AzureWorkloadAutoProtectionIntent:
description: Azure Recovery Services Vault specific protection intent item.
type: object
allOf:
- $ref: '#/definitions/AzureRecoveryServiceVaultProtectionIntent'
x-ms-discriminator-value: AzureWorkloadAutoProtectionIntent
AzureWorkloadSQLAutoProtectionIntent:
description: Azure Workload SQL Auto Protection intent item.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadAutoProtectionIntent'
properties:
workloadItemType:
description: Workload item type of the item for which intent is to be set
enum:
- Invalid
- SQLInstance
- SQLDataBase
- SAPHanaSystem
- SAPHanaDatabase
- SAPAseSystem
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadItemType
modelAsString: true
x-ms-discriminator-value: AzureWorkloadSQLAutoProtectionIntent
BackupManagementUsage:
description: Backup management usages of a vault.
type: object
properties:
unit:
description: Unit of the usage.
enum:
- Count
- Bytes
- Seconds
- Percent
- CountPerSecond
- BytesPerSecond
type: string
x-ms-enum:
name: UsagesUnit
modelAsString: true
quotaPeriod:
description: Quota period of usage.
type: string
nextResetTime:
format: date-time
description: Next reset time of usage.
type: string
currentValue:
format: int64
description: Current value of usage.
type: integer
limit:
format: int64
description: Limit of usage.
type: integer
name:
$ref: '#/definitions/NameInfo'
description: Name of usage.
BackupManagementUsageList:
description: Backup management usage for vault.
type: object
properties:
value:
description: The list of backup management usages for the given vault.
type: array
items:
$ref: '#/definitions/BackupManagementUsage'
x-ms-identifiers: []
BackupStatusRequest:
description: BackupStatus request.
type: object
properties:
resourceType:
description: Container Type - VM, SQLPaaS, DPM, AzureFileShare...
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: DataSourceType
modelAsString: true
resourceId:
description: Entire ARM resource id of the resource
type: string
poLogicalName:
description: Protectable Item Logical Name
type: string
BackupStatusResponse:
description: BackupStatus response.
type: object
properties:
protectionStatus:
description: Specifies whether the container is registered or not
enum:
- Invalid
- NotProtected
- Protecting
- Protected
- ProtectionFailed
type: string
x-ms-enum:
name: ProtectionStatus
modelAsString: true
vaultId:
description: Specifies the arm resource id of the vault
type: string
fabricName:
description: Specifies the fabric name - Azure or AD
enum:
- Invalid
- Azure
type: string
x-ms-enum:
name: FabricName
modelAsString: true
containerName:
description: >-
Specifies the product specific container name. E.g.
iaasvmcontainer;iaasvmcontainer;csname;vmname.
type: string
protectedItemName:
description: >-
Specifies the product specific ds name. E.g.
vm;iaasvmcontainer;csname;vmname.
type: string
errorCode:
description: ErrorCode in case of intent failed
type: string
errorMessage:
description: ErrorMessage in case of intent failed.
type: string
policyName:
description: Specifies the policy name which is used for protection
type: string
registrationStatus:
description: Container registration status
type: string
BMSBackupSummariesQueryObject:
description: Query parameters to fetch backup summaries.
type: object
properties:
type:
description: Backup management type for this container.
enum:
- Invalid
- BackupProtectedItemCountSummary
- BackupProtectionContainerCountSummary
type: string
x-ms-enum:
name: Type
modelAsString: true
FeatureSupportRequest:
description: Base class for feature request
required:
- featureType
type: object
properties:
featureType:
description: backup support feature type.
type: string
discriminator: featureType
NameInfo:
description: The name of usage.
type: object
properties:
value:
description: Value of usage.
type: string
localizedValue:
description: Localized value of usage.
type: string
PreValidateEnableBackupRequest:
description: "Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.\r\nIt will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties."
type: object
properties:
resourceType:
description: ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: DataSourceType
modelAsString: true
resourceId:
description: ARM Virtual Machine Id
type: string
vaultId:
description: ARM id of the Recovery Services Vault
type: string
properties:
description: Configuration of VM if any needs to be validated like OS type etc
type: string
PreValidateEnableBackupResponse:
description: Response contract for enable backup validation request
type: object
properties:
status:
description: Validation Status
enum:
- Invalid
- Succeeded
- Failed
type: string
x-ms-enum:
name: ValidationStatus
modelAsString: true
errorCode:
description: Response error code
type: string
errorMessage:
description: Response error message
type: string
recommendation:
description: Recommended action for user
type: string
containerName:
description: "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\nfor portal"
type: string
protectedItemName:
description: >-
Specifies the product specific ds name. E.g.
vm;iaasvmcontainer;rgname;vmname. This is required for portal
type: string
ProtectionIntent:
description: Base class for backup ProtectionIntent.
required:
- protectionIntentItemType
type: object
properties:
protectionIntentItemType:
description: backup protectionIntent type.
enum:
- Invalid
- AzureResourceItem
- RecoveryServiceVaultItem
- AzureWorkloadContainerAutoProtectionIntent
- AzureWorkloadAutoProtectionIntent
- AzureWorkloadSQLAutoProtectionIntent
type: string
x-ms-enum:
name: ProtectionIntentItemType
modelAsString: true
backupManagementType:
description: Type of backup management for the backed up item.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
sourceResourceId:
description: ARM ID of the resource to be backed up.
type: string
itemId:
description: >-
ID of the item which is getting protected, In case of Azure Vm , it is
ProtectedItemId
type: string
policyId:
description: ID of the backup policy with which this item is backed up.
type: string
protectionState:
description: Backup state of this backup item.
enum:
- Invalid
- NotProtected
- Protecting
- Protected
- ProtectionFailed
type: string
x-ms-enum:
name: ProtectionStatus
modelAsString: true
discriminator: protectionIntentItemType
ProtectionIntentQueryObject:
description: Filters to list protection intent.
type: object
properties:
backupManagementType:
description: Backup management type for the backed up item
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
itemType:
description: Type of workload this item represents
enum:
- Invalid
- SQLInstance
- SQLAvailabilityGroupContainer
type: string
x-ms-enum:
name: IntentItemType
modelAsString: true
parentName:
description: Parent name of the intent
type: string
itemName:
description: Item name of the intent
type: string
ProtectionIntentResource:
description: Base class for backup ProtectionIntent.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ProtectionIntent'
description: ProtectionIntentResource properties
ProtectionIntentResourceList:
description: List of ProtectionIntent resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ProtectionIntentResource'
AzureWorkloadContainer:
description: >-
Container for the workloads running inside Azure Compute or Classic
Compute.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
sourceResourceId:
description: >-
ARM ID of the virtual machine represented by this Azure Workload
Container
type: string
lastUpdatedTime:
format: date-time
description: Time stamp when this container was updated.
type: string
extendedInfo:
$ref: '#/definitions/AzureWorkloadContainerExtendedInfo'
description: Additional details of a workload container.
workloadType:
description: Workload type for which registration was sent.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
operationType:
description: Re-Do Operation
enum:
- Invalid
- Register
- Reregister
type: string
x-ms-enum:
name: OperationType
modelAsString: true
x-ms-discriminator-value: AzureWorkloadContainer
AzureWorkloadContainerExtendedInfo:
description: Extended information of the container.
type: object
properties:
hostServerName:
description: >-
Host Os Name in case of Stand Alone and Cluster Name in case of
distributed container.
type: string
inquiryInfo:
$ref: '#/definitions/InquiryInfo'
description: Inquiry Status for the container.
nodesList:
description: List of the nodes in case of distributed container.
type: array
items:
$ref: '#/definitions/DistributedNodesInfo'
x-ms-identifiers: []
BackupEngineBase:
description: >-
The base backup engine class. All workload specific backup engines derive
from this class.
type: object
required:
- backupEngineType
properties:
friendlyName:
description: Friendly name of the backup engine.
type: string
backupManagementType:
description: Type of backup management for the backup engine.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
registrationStatus:
description: >-
Registration status of the backup engine with the Recovery Services
Vault.
type: string
backupEngineState:
description: >-
Status of the backup engine with the Recovery Services Vault. =
{Active/Deleting/DeleteFailed}
type: string
healthStatus:
description: Backup status of the backup engine.
type: string
backupEngineType:
description: Type of the backup engine.
enum:
- Invalid
- DpmBackupEngine
- AzureBackupServerEngine
type: string
x-ms-enum:
name: BackupEngineType
modelAsString: true
canReRegister:
description: >-
Flag indicating if the backup engine be registered, once already
registered.
type: boolean
backupEngineId:
description: ID of the backup engine.
type: string
dpmVersion:
description: Backup engine version
type: string
azureBackupAgentVersion:
description: Backup agent version
type: string
isAzureBackupAgentUpgradeAvailable:
description: To check if backup agent upgrade available
type: boolean
isDpmUpgradeAvailable:
description: To check if backup engine upgrade available
type: boolean
extendedInfo:
$ref: '#/definitions/BackupEngineExtendedInfo'
description: Extended info of the backupengine
discriminator: backupEngineType
BackupEngineBaseResource:
description: >-
The base backup engine class. All workload specific backup engines derive
from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupEngineBase'
description: BackupEngineBaseResource properties
BackupEngineBaseResourceList:
description: List of BackupEngineBase resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/BackupEngineBaseResource'
BackupEngineExtendedInfo:
description: Additional information on backup engine.
type: object
properties:
databaseName:
description: Database name of backup engine.
type: string
protectedItemsCount:
format: int32
description: Number of protected items in the backup engine.
type: integer
protectedServersCount:
format: int32
description: Number of protected servers in the backup engine.
type: integer
diskCount:
format: int32
description: Number of disks in the backup engine.
type: integer
usedDiskSpace:
format: double
description: Disk space used in the backup engine.
type: number
availableDiskSpace:
format: double
description: Disk space currently available in the backup engine.
type: number
refreshedAt:
format: date-time
description: Last refresh time in the backup engine.
type: string
azureProtectedInstances:
format: int32
description: Protected instances in the backup engine.
type: integer
BackupRequest:
description: >-
Base class for backup request. Workload-specific backup requests are
derived from this class.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
BackupRequestResource:
description: >-
Base class for backup request. Workload-specific backup requests are
derived from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/BackupRequest'
description: BackupRequestResource properties
BMSBackupEngineQueryObject:
description: Query parameters to fetch list of backup engines.
type: object
properties:
expand:
description: attribute to add extended info
type: string
BMSBackupEnginesQueryObject:
description: Query parameters to fetch list of backup engines.
type: object
properties:
backupManagementType:
description: Backup management type for the backup engine.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
friendlyName:
description: Friendly name of the backup engine.
type: string
expand:
description: Attribute to add extended info.
type: string
BMSContainerQueryObject:
description: The query filters that can be used with the list containers API.
required:
- backupManagementType
type: object
properties:
backupManagementType:
description: Backup management type for this container.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
containerType:
description: Type of container for filter
enum:
- Invalid
- Unknown
- IaasVMContainer
- IaasVMServiceContainer
- DPMContainer
- AzureBackupServerContainer
- MABContainer
- Cluster
- AzureSqlContainer
- Windows
- VCenter
- VMAppContainer
- SQLAGWorkLoadContainer
- StorageContainer
- GenericContainer
- HanaHSRContainer
type: string
x-ms-enum:
name: ContainerType
modelAsString: true
backupEngineName:
description: Backup engine name
type: string
fabricName:
description: Fabric name for filter
type: string
status:
description: >-
Status of registration of this container with the Recovery Services
Vault.
type: string
friendlyName:
description: Friendly name of this container.
type: string
BMSContainersInquiryQueryObject:
description: The query filters that can be used with the inquire container API.
type: object
properties:
backupManagementType:
description: Backup management type for this container.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
workloadType:
description: Workload type for this container.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
BMSPOQueryObject:
description: Filters to list items that can be backed up.
type: object
properties:
backupManagementType:
description: Backup management type.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureSql
- AzureBackupServer
- AzureWorkload
- AzureStorage
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
workloadType:
description: Workload type
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
containerName:
description: >-
Full name of the container whose Protectable Objects should be
returned.
type: string
status:
description: Backup status query parameter.
type: string
friendlyName:
description: Friendly name.
type: string
BMSRefreshContainersQueryObject:
description: The query filters that can be used with the refresh container API.
type: object
properties:
backupManagementType:
description: Backup management type for this container.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
BMSWorkloadItemQueryObject:
description: Filters to list items that can be backed up.
type: object
properties:
backupManagementType:
description: Backup management type.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureSql
- AzureBackupServer
- AzureWorkload
- AzureStorage
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
workloadItemType:
description: Workload Item type
enum:
- Invalid
- SQLInstance
- SQLDataBase
- SAPHanaSystem
- SAPHanaDatabase
- SAPAseSystem
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadItemType
modelAsString: true
workloadType:
description: Workload type
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: WorkloadType
modelAsString: true
protectionStatus:
description: Backup status query parameter.
enum:
- Invalid
- NotProtected
- Protecting
- Protected
- ProtectionFailed
type: string
x-ms-enum:
name: ProtectionStatus
modelAsString: true
ClientScriptForConnect:
description: Client script details for file / folder restore.
type: object
properties:
scriptContent:
description: File content of the client script for file / folder restore.
type: string
scriptExtension:
description: >-
File extension of the client script for file / folder restore - .ps1 ,
.sh , etc.
type: string
osType:
description: >-
OS type - Windows, Linux etc. for which this file / folder restore
client script works.
type: string
url:
description: >-
URL of Executable from where to source the content. If this is not
null then ScriptContent should not be used
type: string
scriptNameSuffix:
description: "Mandatory suffix that should be added to the name of script that is given for download to user.\r\nIf its null or empty then , ignore it."
type: string
ContainerIdentityInfo:
description: Container identity information
type: object
properties:
uniqueName:
description: Unique name of the container
type: string
aadTenantId:
description: Protection container identity - AAD Tenant
type: string
servicePrincipalClientId:
description: Protection container identity - AAD Service Principal
type: string
audience:
description: Protection container identity - Audience
type: string
DistributedNodesInfo:
description: This is used to represent the various nodes of the distributed container.
type: object
properties:
nodeName:
description: Name of the node under a distributed container.
type: string
status:
description: "Status of this Node.\r\nFailed | Succeeded"
type: string
errorDetail:
$ref: '#/definitions/ErrorDetail'
description: Error Details if the Status is non-success.
DpmBackupEngine:
description: Data Protection Manager (DPM) specific backup engine.
type: object
allOf:
- $ref: '#/definitions/BackupEngineBase'
x-ms-discriminator-value: DpmBackupEngine
DpmContainer:
description: DPM workload-specific protection container.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
canReRegister:
description: Specifies whether the container is re-registrable.
type: boolean
containerId:
description: ID of container.
type: string
protectedItemCount:
format: int64
description: Number of protected items in the BackupEngine
type: integer
dpmAgentVersion:
description: Backup engine Agent version
type: string
dpmServers:
description: List of BackupEngines protecting the container
type: array
items:
type: string
upgradeAvailable:
description: To check if upgrade available
type: boolean
protectionStatus:
description: Protection status of the container.
type: string
extendedInfo:
$ref: '#/definitions/DPMContainerExtendedInfo'
description: Extended Info of the container.
x-ms-discriminator-value: DPMContainer
DPMContainerExtendedInfo:
description: Additional information of the DPMContainer.
type: object
properties:
lastRefreshedAt:
format: date-time
description: Last refresh time of the DPMContainer.
type: string
GenericContainer:
description: Base class for generic container of backup items
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
fabricName:
description: Name of the container's fabric
type: string
extendedInformation:
$ref: '#/definitions/GenericContainerExtendedInfo'
description: Extended information (not returned in List container API calls)
x-ms-discriminator-value: GenericContainer
GenericContainerExtendedInfo:
description: Container extended information
type: object
properties:
rawCertData:
description: Public key of container cert
type: string
containerIdentityInfo:
$ref: '#/definitions/ContainerIdentityInfo'
description: Container identity information
serviceEndpoints:
description: Azure Backup Service Endpoints for the container
type: object
additionalProperties:
type: string
IaasVMBackupRequest:
description: IaaS VM workload-specific backup request.
type: object
allOf:
- $ref: '#/definitions/BackupRequest'
properties:
recoveryPointExpiryTimeInUTC:
format: date-time
description: Backup copy will expire after the time specified (UTC).
type: string
x-ms-discriminator-value: IaasVMBackupRequest
IaaSVMContainer:
description: IaaS VM workload-specific container.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
virtualMachineId:
description: >-
Fully qualified ARM url of the virtual machine represented by this
Azure IaaS VM container.
type: string
virtualMachineVersion:
description: >-
Specifies whether the container represents a Classic or an Azure
Resource Manager VM.
type: string
resourceGroup:
description: Resource group name of Recovery Services Vault.
type: string
x-ms-discriminator-value: IaasVMContainer
IaasVMILRRegistrationRequest:
description: Restore files/folders from a backup copy of IaaS VM.
type: object
allOf:
- $ref: '#/definitions/ILRRequest'
properties:
recoveryPointId:
description: >-
ID of the IaaS VM backup copy from where the files/folders have to be
restored.
type: string
virtualMachineId:
description: >-
Fully qualified ARM ID of the virtual machine whose the files /
folders have to be restored.
type: string
initiatorName:
description: iSCSI initiator name.
type: string
renewExistingRegistration:
description: Whether to renew existing registration with the iSCSI server.
type: boolean
x-ms-discriminator-value: IaasVMILRRegistrationRequest
IaaSVMProtectableItem:
description: IaaS VM workload-specific backup item.
type: object
allOf:
- $ref: '#/definitions/WorkloadProtectableItem'
properties:
virtualMachineId:
description: Fully qualified ARM ID of the virtual machine.
type: string
virtualMachineVersion:
description: >-
Specifies whether the container represents a Classic or an Azure
Resource Manager VM.
type: string
resourceGroup:
description: Resource group name of Recovery Services Vault.
type: string
x-ms-discriminator-value: IaaSVMProtectableItem
ILRRequest:
description: Parameters to Provision ILR API.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
ILRRequestResource:
description: Parameters to Provision ILR API.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ILRRequest'
description: ILRRequestResource properties
InquiryInfo:
description: Details about inquired protectable items under a given container.
type: object
properties:
status:
description: "Inquiry Status for this container such as\r\nInProgress | Failed | Succeeded"
type: string
errorDetail:
$ref: '#/definitions/ErrorDetail'
description: Error Details if the Status is non-success.
inquiryDetails:
description: "Inquiry Details which will have workload specific details.\r\nFor e.g. - For SQL and oracle this will contain different details."
type: array
items:
$ref: '#/definitions/WorkloadInquiryDetails'
x-ms-identifiers: []
InquiryValidation:
description: Validation for inquired protectable items under a given container.
type: object
properties:
status:
description: Status for the Inquiry Validation.
type: string
errorDetail:
$ref: '#/definitions/ErrorDetail'
description: Error Detail in case the status is non-success.
additionalDetail:
description: Error Additional Detail in case the status is non-success.
type: string
readOnly: true
InstantItemRecoveryTarget:
description: Target details for file / folder restore.
type: object
properties:
clientScripts:
description: List of client scripts.
type: array
items:
$ref: '#/definitions/ClientScriptForConnect'
x-ms-identifiers: []
MabContainer:
description: Container with items backed up using MAB backup engine.
type: object
allOf:
- $ref: '#/definitions/ProtectionContainer'
properties:
canReRegister:
description: Can the container be registered one more time.
type: boolean
containerId:
format: int64
description: ContainerID represents the container.
type: integer
protectedItemCount:
format: int64
description: Number of items backed up in this container.
type: integer
agentVersion:
description: Agent version of this container.
type: string
extendedInfo:
$ref: '#/definitions/MabContainerExtendedInfo'
description: Additional information for this container
mabContainerHealthDetails:
description: Health details on this mab container.
type: array
items:
$ref: '#/definitions/MABContainerHealthDetails'
x-ms-identifiers:
- code
containerHealthState:
description: Health state of mab container.
type: string
x-ms-discriminator-value: Windows
MabContainerExtendedInfo:
description: Additional information of the container.
type: object
properties:
lastRefreshedAt:
format: date-time
description: Time stamp when this container was refreshed.
type: string
backupItemType:
description: Type of backup items associated with this container.
enum:
- Invalid
- VM
- FileFolder
- AzureSqlDb
- SQLDB
- Exchange
- Sharepoint
- VMwareVM
- SystemState
- Client
- GenericDataSource
- SQLDataBase
- AzureFileShare
- SAPHanaDatabase
- SAPAseDatabase
- SAPHanaDBInstance
type: string
x-ms-enum:
name: BackupItemType
modelAsString: true
backupItems:
description: List of backup items associated with this container.
type: array
items:
type: string
policyName:
description: Backup policy associated with this container.
type: string
lastBackupStatus:
description: Latest backup status of this container.
type: string
MABContainerHealthDetails:
description: MAB workload-specific Health Details.
type: object
properties:
code:
format: int32
description: Health Code
type: integer
title:
description: Health Title
type: string
message:
description: Health Message
type: string
recommendations:
description: Health Recommended Actions
type: array
items:
type: string
OperationStatus:
description: Operation status.
type: object
properties:
id:
description: ID of the operation.
type: string
name:
description: Name of the operation.
type: string
status:
description: Operation status.
enum:
- Invalid
- InProgress
- Succeeded
- Failed
- Canceled
type: string
x-ms-enum:
name: OperationStatusValues
modelAsString: true
startTime:
format: date-time
description: 'Operation start time. Format: ISO-8601.'
type: string
endTime:
format: date-time
description: 'Operation end time. Format: ISO-8601.'
type: string
error:
$ref: '#/definitions/OperationStatusError'
description: Error information related to this operation.
properties:
$ref: '#/definitions/OperationStatusExtendedInfo'
description: Additional information associated with this operation.
OperationStatusError:
description: Error information associated with operation status call.
type: object
properties:
code:
description: Error code of the operation failure.
type: string
message:
description: Error message displayed if the operation failure.
type: string
OperationStatusExtendedInfo:
description: Base class for additional information of operation status.
required:
- objectType
type: object
properties:
objectType:
description: >-
This property will be used as the discriminator for deciding the
specific types in the polymorphic chain of types.
type: string
discriminator: objectType
OperationStatusJobExtendedInfo:
description: Operation status job extended info.
type: object
allOf:
- $ref: '#/definitions/OperationStatusExtendedInfo'
properties:
jobId:
description: ID of the job created for this protected item.
type: string
x-ms-discriminator-value: OperationStatusJobExtendedInfo
OperationStatusJobsExtendedInfo:
description: Operation status extended info for list of jobs.
type: object
allOf:
- $ref: '#/definitions/OperationStatusExtendedInfo'
properties:
jobIds:
description: IDs of the jobs created for the protected item.
type: array
items:
type: string
failedJobsError:
description: Stores all the failed jobs along with the corresponding error codes.
type: object
additionalProperties:
type: string
x-ms-discriminator-value: OperationStatusJobsExtendedInfo
OperationStatusProvisionILRExtendedInfo:
description: Operation status extended info for ILR provision action.
type: object
allOf:
- $ref: '#/definitions/OperationStatusExtendedInfo'
properties:
recoveryTarget:
$ref: '#/definitions/InstantItemRecoveryTarget'
description: Target details for file / folder restore.
x-ms-discriminator-value: OperationStatusProvisionILRExtendedInfo
OperationStatusValidateOperationExtendedInfo:
description: Operation status extended info for ValidateOperation action.
type: object
allOf:
- $ref: '#/definitions/OperationStatusExtendedInfo'
properties:
validateOperationResponse:
$ref: '#/definitions/ValidateOperationResponse'
description: Gets the validation operation response
x-ms-discriminator-value: OperationStatusValidateOperationExtendedInfo
PreBackupValidation:
description: Pre-backup validation for Azure VM Workload provider.
type: object
properties:
status:
description: Status of protectable item, i.e. InProgress,Succeeded,Failed
enum:
- Invalid
- Success
- Failed
type: string
x-ms-enum:
name: InquiryStatus
modelAsString: true
code:
description: Error code of protectable item
type: string
message:
description: Message corresponding to the error code for the protectable item
type: string
ProtectableContainer:
description: Protectable Container Class.
type: object
required:
- protectableContainerType
properties:
friendlyName:
description: Friendly name of the container.
type: string
backupManagementType:
description: Type of backup management for the container.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
protectableContainerType:
description: "Type of the container. The value of this property for\r\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines"
enum:
- Invalid
- Unknown
- IaasVMContainer
- IaasVMServiceContainer
- DPMContainer
- AzureBackupServerContainer
- MABContainer
- Cluster
- AzureSqlContainer
- Windows
- VCenter
- VMAppContainer
- SQLAGWorkLoadContainer
- StorageContainer
- GenericContainer
- Microsoft.ClassicCompute/virtualMachines
- Microsoft.Compute/virtualMachines
- AzureWorkloadContainer
type: string
readOnly: false
x-ms-enum:
name: protectableContainerType
modelAsString: false
healthStatus:
description: Status of health of the container.
type: string
containerId:
description: Fabric Id of the container such as ARM Id.
type: string
discriminator: protectableContainerType
ProtectableContainerResource:
description: Protectable Container Class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ProtectableContainer'
description: ProtectableContainerResource properties
ProtectableContainerResourceList:
description: List of ProtectableContainer resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ProtectableContainerResource'
ProtectionContainer:
description: >-
Base class for container with backup items. Containers with specific
workloads are derived from this class.
type: object
required:
- containerType
properties:
friendlyName:
description: Friendly name of the container.
type: string
backupManagementType:
description: Type of backup management for the container.
enum:
- Invalid
- AzureIaasVM
- MAB
- DPM
- AzureBackupServer
- AzureSql
- AzureStorage
- AzureWorkload
- DefaultBackup
type: string
x-ms-enum:
name: BackupManagementType
modelAsString: true
registrationStatus:
description: >-
Status of registration of the container with the Recovery Services
Vault.
type: string
healthStatus:
description: Status of health of the container.
type: string
containerType:
description: "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
enum:
- Invalid
- Unknown
- IaasVMContainer
- IaasVMServiceContainer
- DPMContainer
- AzureBackupServerContainer
- MABContainer
- Cluster
- AzureSqlContainer
- Windows
- VCenter
- VMAppContainer
- SQLAGWorkLoadContainer
- StorageContainer
- GenericContainer
- Microsoft.ClassicCompute/virtualMachines
- Microsoft.Compute/virtualMachines
- AzureWorkloadContainer
type: string
x-ms-enum:
name: protectableContainerType
modelAsString: true
protectableObjectType:
description: Type of the protectable object associated with this container
type: string
discriminator: containerType
ProtectionContainerResource:
description: >-
Base class for container with backup items. Containers with specific
workloads are derived from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/ProtectionContainer'
description: ProtectionContainerResource properties
ProtectionContainerResourceList:
description: List of ProtectionContainer resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ProtectionContainerResource'
SecurityPinBase:
description: Base class for get security pin request body
type: object
properties:
resourceGuardOperationRequests:
description: ResourceGuard Operation Requests
type: array
items:
type: string
TokenInformation:
description: The token information details.
type: object
properties:
token:
description: Token value.
type: string
expiryTimeInUtcTicks:
format: int64
description: Expiry time of token.
type: integer
securityPIN:
description: Security PIN
type: string
WorkloadInquiryDetails:
description: Details of an inquired protectable item.
type: object
properties:
type:
description: Type of the Workload such as SQL, Oracle etc.
type: string
itemCount:
format: int64
description: Contains the protectable item Count inside this Container.
type: integer
inquiryValidation:
$ref: '#/definitions/InquiryValidation'
description: Inquiry validation such as permissions and other backup validations.
WorkloadItem:
description: >-
Base class for backup item. Workload-specific backup items are derived
from this class.
type: object
required:
- workloadItemType
properties:
backupManagementType:
description: Type of backup management to backup an item.
type: string
workloadType:
description: Type of workload for the backup management
type: string
workloadItemType:
description: Type of the backup item.
type: string
friendlyName:
description: Friendly name of the backup item.
type: string
protectionState:
description: State of the back up item.
enum:
- Invalid
- NotProtected
- Protecting
- Protected
- ProtectionFailed
type: string
x-ms-enum:
name: ProtectionStatus
modelAsString: true
discriminator: workloadItemType
WorkloadItemResource:
description: >-
Base class for backup item. Workload-specific backup items are derived
from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/WorkloadItem'
description: WorkloadItemResource properties
WorkloadItemResourceList:
description: List of WorkloadItem resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/WorkloadItemResource'
WorkloadProtectableItem:
description: >-
Base class for backup item. Workload-specific backup items are derived
from this class.
type: object
required:
- protectableItemType
properties:
backupManagementType:
description: Type of backup management to backup an item.
type: string
workloadType:
description: Type of workload for the backup management
type: string
protectableItemType:
description: Type of the backup item.
type: string
friendlyName:
description: Friendly name of the backup item.
type: string
protectionState:
description: State of the back up item.
enum:
- Invalid
- NotProtected
- Protecting
- Protected
- ProtectionFailed
type: string
x-ms-enum:
name: ProtectionStatus
modelAsString: true
discriminator: protectableItemType
WorkloadProtectableItemResource:
description: >-
Base class for backup item. Workload-specific backup items are derived
from this class.
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
$ref: '#/definitions/WorkloadProtectableItem'
description: WorkloadProtectableItemResource properties
WorkloadProtectableItemResourceList:
description: List of WorkloadProtectableItem resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/WorkloadProtectableItemResource'
AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest:
description: >-
AzureWorkload SAP Hana-specific restore with integrated rehydration of
recovery point.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSAPHanaPointInTimeRestoreRequest'
properties:
recoveryPointRehydrationInfo:
$ref: '#/definitions/RecoveryPointRehydrationInfo'
description: RP Rehydration Info
x-ms-discriminator-value: AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest
AzureWorkloadSAPHanaRestoreWithRehydrateRequest:
description: >-
AzureWorkload SAP Hana-specific restore with integrated rehydration of
recovery point.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSAPHanaRestoreRequest'
properties:
recoveryPointRehydrationInfo:
$ref: '#/definitions/RecoveryPointRehydrationInfo'
description: RP Rehydration Info
x-ms-discriminator-value: AzureWorkloadSAPHanaRestoreWithRehydrateRequest
AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest:
description: >-
AzureWorkload SQL-specific restore with integrated rehydration of recovery
point.
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSQLPointInTimeRestoreRequest'
properties:
recoveryPointRehydrationInfo:
$ref: '#/definitions/RecoveryPointRehydrationInfo'
description: RP Rehydration Info
x-ms-discriminator-value: AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest
AzureWorkloadSQLRestoreWithRehydrateRequest:
description: >-
AzureWorkload SQL-specific restore with integrated rehydration of recovery
point
type: object
allOf:
- $ref: '#/definitions/AzureWorkloadSQLRestoreRequest'
properties:
recoveryPointRehydrationInfo:
$ref: '#/definitions/RecoveryPointRehydrationInfo'
description: RP Rehydration Info
x-ms-discriminator-value: AzureWorkloadSQLRestoreWithRehydrateRequest
IaasVMRestoreWithRehydrationRequest:
description: >-
IaaS VM workload-specific restore with integrated rehydration of recovery
point.
type: object
allOf:
- $ref: '#/definitions/IaasVMRestoreRequest'
properties:
recoveryPointRehydrationInfo:
$ref: '#/definitions/RecoveryPointRehydrationInfo'
description: RP Rehydration Info
x-ms-discriminator-value: IaasVMRestoreWithRehydrationRequest
MoveRPAcrossTiersRequest:
type: object
properties:
objectType:
description: Gets the class type.
type: string
sourceTierType:
description: Source tier from where RP needs to be moved
enum:
- Invalid
- InstantRP
- HardenedRP
- ArchivedRP
type: string
x-ms-enum:
name: RecoveryPointTierType
modelAsString: false
targetTierType:
description: Target tier where RP needs to be moved
enum:
- Invalid
- InstantRP
- HardenedRP
- ArchivedRP
type: string
x-ms-enum:
name: RecoveryPointTierType
modelAsString: false
RecoveryPointMoveReadinessInfo:
type: object
properties:
isReadyForMove:
type: boolean
additionalInfo:
type: string
RecoveryPointRehydrationInfo:
description: RP Rehydration Info
type: object
properties:
rehydrationRetentionDuration:
description: "How long the rehydrated RP should be kept\r\nShould be ISO8601 Duration format e.g. \"P7D\""
type: string
rehydrationPriority:
description: Rehydration Priority
enum:
- Standard
- High
type: string
x-ms-enum:
name: RehydrationPriority
modelAsString: true
ListRecoveryPointsRecommendedForMoveRequest:
description: ListRecoveryPointsRecommendedForMoveRequest Request
type: object
properties:
objectType:
description: Gets the class type.
type: string
excludedRPList:
description: List of Recovery Points excluded from Move
type: array
items:
type: string
UnlockDeleteRequest:
description: Request body of unlock delete API.
type: object
properties:
resourceGuardOperationRequests:
type: array
items:
type: string
resourceToBeDeleted:
type: string
UnlockDeleteResponse:
description: Response of Unlock Delete API.
type: object
properties:
unlockDeleteExpiryTime:
description: This is the time when unlock delete privileges will get expired.
type: string
ResourceGuardOperationDetail:
type: object
properties:
vaultCriticalOperation:
type: string
defaultResourceRequest:
type: string
ResourceGuardProxyBase:
type: object
properties:
resourceGuardResourceId:
type: string
resourceGuardOperationDetails:
type: array
items:
$ref: '#/definitions/ResourceGuardOperationDetail'
x-ms-identifiers: []
lastUpdatedTime:
type: string
description:
type: string
ResourceGuardProxyBaseResource:
allOf:
- $ref: '#/definitions/Resource'
type: object
properties:
properties:
$ref: '#/definitions/ResourceGuardProxyBase'
description: ResourceGuardProxyBaseResource properties
ResourceGuardProxyBaseResourceList:
description: List of ResourceGuardProxyBase resources
type: object
allOf:
- $ref: '#/definitions/ResourceList'
properties:
value:
description: List of resources.
type: array
items:
$ref: '#/definitions/ResourceGuardProxyBaseResource'
TieringPolicy:
description: "Tiering Policy for a target tier.\r\nIf the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier"
type: object
properties:
tieringMode:
description: "Tiering Mode to control automatic tiering of recovery points. Supported values are:\r\n1. TierRecommended: Tier all recovery points recommended to be tiered\r\n2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.\r\n3. DoNotTier: Do not tier any recovery points"
enum:
- Invalid
- TierRecommended
- TierAfter
- DoNotTier
type: string
x-ms-enum:
name: TieringMode
modelAsString: true
duration:
format: int32
description: "Number of days/weeks/months/years to retain backups in current tier before tiering.\r\nUsed only if TieringMode is set to TierAfter"
type: integer
durationType:
description: "Retention duration type: days/weeks/months/years\r\nUsed only if TieringMode is set to TierAfter"
enum:
- Invalid
- Days
- Weeks
- Months
- Years
type: string
x-ms-enum:
name: RetentionDurationType
modelAsString: true
parameters:
SubscriptionId:
name: subscriptionId
in: path
description: The subscription Id.
required: true
type: string
AzureRegion:
name: azureRegion
in: path
description: Azure region to hit Api
required: true
type: string
x-ms-parameter-location: method
ResourceGroupName:
name: resourceGroupName
in: path
description: >-
The name of the resource group where the recovery services vault is
present.
required: true
type: string
x-ms-parameter-location: method
VaultName:
name: vaultName
in: path
description: The name of the recovery services vault.
required: true
type: string
x-ms-parameter-location: method
ApiVersion:
name: api-version
in: query
description: Client Api Version.
required: true
type: string
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account.
security:
- azure_auth:
- user_impersonation
tags:
- name: BackupEngines
- name: BackupJobs
- name: BackupOperationResults
- name: BackupOperationStatuses
- name: BackupPolicies
- name: BackupProtectableItems
- name: BackupProtectedItems
- name: BackupProtectionContainers
- name: BackupProtectionIntent
- name: BackupResourceEncryptionConfigs
- name: BackupResourceStorageConfigsNonCRR
- name: BackupResourceVaultConfigs
- name: Backups
- name: BackupStatus
- name: BackupUsageSummaries
- name: BackupWorkloadItems
- name: BMSPrepareDataMoveOperationResult
- name: DataMove
- name: ExportJobsOperationResults
- name: FeatureSupport
- name: ItemLevelRecoveryConnections
- name: JobCancellations
- name: JobDetails
- name: JobOperationResults
- name: Jobs
- name: Operation
- name: Operations
- name: PrivateEndpoint
- name: PrivateEndpointConnection
- name: ProtectableContainers
- name: ProtectedItemOperationResults
- name: ProtectedItemOperationStatuses
- name: ProtectedItems
- name: ProtectionContainerOperationResults
- name: ProtectionContainerRefreshOperationResults
- name: ProtectionContainers
- name: ProtectionIntent
- name: ProtectionPolicies
- name: ProtectionPolicyOperationResults
- name: ProtectionPolicyOperationStatuses
- name: RecoveryPoint
- name: RecoveryPoints
- name: RecoveryPointsRecommendedForMove
- name: ResourceGuardProxies
- name: ResourceGuardProxy
- name: Restores
- name: SecurityPINs
- name: SoftDeletedContainers
- name: ValidateOperation
- name: ValidateOperationResults
- name: ValidateOperationStatuses