The Microsoft Azure Recovery Services Backup Client is a tool that provides backup and recovery solutions for protecting data stored on Windows machines. It allows users to easily schedule regular backups of their files, applications, and system settings to Azure cloud storage. In the event of a data loss or system failure, the Backup Client offers a fast and reliable way to restore the most recent copies of files and data.
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,<br>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 Resourcegr
# --- truncated at 32 KB (317 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/recoveryservicesbackupclient-openapi-original.yml