swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector BackupInstances API schemes: - https tags: - name: BackupInstances paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances : get: tags: - BackupInstances description: Gets a backup instances belonging to a backup vault operationId: microsoftAzureBackupinstancesList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' responses: '200': description: OK schema: $ref: '#/definitions/BackupInstanceResourceList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List BackupInstances in a Vault: $ref: ./examples/BackupInstanceOperations/ListBackupInstances.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName} : get: tags: - BackupInstances description: Gets a backup instance with name in a backup vault operationId: microsoftAzureBackupinstancesGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' responses: '200': description: OK schema: $ref: '#/definitions/BackupInstanceResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get BackupInstance: $ref: ./examples/BackupInstanceOperations/GetBackupInstance.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename put: tags: - BackupInstances description: Create or update a backup instance in a backup vault operationId: microsoftAzureBackupinstancesCreateorupdate produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/BackupInstanceResource' responses: '200': description: OK schema: $ref: '#/definitions/BackupInstanceResource' '201': description: Created schema: $ref: '#/definitions/BackupInstanceResource' '202': description: Accepted headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Create BackupInstance: $ref: ./examples/BackupInstanceOperations/PutBackupInstance.json Create BackupInstance with GenericParameters: $ref: ./examples/BackupInstanceOperations/PutBackupInstanceWithGenericParameters.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename delete: tags: - BackupInstances description: Delete a backup instance in a backup vault operationId: microsoftAzureBackupinstancesDelete produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' responses: '200': description: Ok '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Delete BackupInstance: $ref: ./examples/BackupInstanceOperations/DeleteBackupInstance.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup : post: tags: - BackupInstances description: 'Trigger adhoc backup ' operationId: microsoftAzureBackupinstancesAdhocbackup produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/TriggerBackupRequest' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Trigger Adhoc Backup: $ref: ./examples/BackupInstanceOperations/TriggerBackup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Backup ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup : post: tags: - BackupInstances description: Validate whether adhoc backup will be successful or not operationId: microsoftAzureBackupinstancesValidateforbackup produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/ValidateForBackupRequest' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Validate For Backup: $ref: ./examples/BackupInstanceOperations/ValidateForBackup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Validateforbackup ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup : post: tags: - BackupInstances description: Validate whether update for backup instance will be successful or not operationId: microsoftAzureBackupinstancesValidateformodifybackup produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/RestrictedVaultName' - $ref: '#/parameters/BackupInstanceName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/ValidateForModifyBackupRequest' responses: '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Validate For Modify Backup: $ref: ./examples/BackupInstanceOperations/ValidateForModifyBackup.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Validateformodifybackup ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId} : get: tags: - BackupInstances description: Get result of backup instance creation operation operationId: microsoftAzureBackupinstancesGetbackupinstanceoperationresult produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - name: operationId in: path required: true type: string - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/BackupInstanceResource' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-examples: Get BackupInstanceOperationResult: $ref: ./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Operationresults Operationid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore : post: tags: - BackupInstances description: Triggers Cross Region Restore for BackupInstance. operationId: microsoftAzureBackupinstancesTriggercrossregionrestore produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - name: parameters in: body description: Request body for trigger CRR operation required: true schema: $ref: '#/definitions/CrossRegionRestoreRequestObject' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Trigger Cross Region Restore: $ref: ./examples/CrossRegionRestore/TriggerCrossRegionRestore.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Locations Location Crossregionrestore ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore : post: tags: - BackupInstances description: Validates whether Cross Region Restore can be triggered for DataSource. operationId: microsoftAzureBackupinstancesValidatecrossregionrestore produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/ValidateCrossRegionRestoreRequestObject' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true x-ms-examples: Validate Cross Region Restore: $ref: ./examples/CrossRegionRestore/ValidateCrossRegionRestore.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Locations Location Validatecrossregionrestore ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate : post: description: rehydrate recovery point for restore for a BackupInstance operationId: microsoftAzureBackupinstancesTriggerrehydrate parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/VaultName' - description: Request body for operation in: body name: parameters required: true schema: $ref: '#/definitions/AzureBackupRehydrationRequest' - $ref: '#/parameters/BackupInstanceName' produces: - application/json responses: '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 '204': description: NoContent default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' tags: - BackupInstances x-ms-examples: Trigger Rehydrate: $ref: ./examples/BackupInstanceOperations/TriggerRehydrate.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Rehydrate ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore : post: tags: - BackupInstances description: Triggers restore for a BackupInstance operationId: microsoftAzureBackupinstancesTriggerrestore produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/AzureBackupRestoreRequest' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Trigger Restore: $ref: ./examples/BackupInstanceOperations/TriggerRestore.json Trigger Restore As Files: $ref: ./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json Trigger Restore With Rehydration: $ref: ./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json Trigger Restore With GenericRestoreDatasourceCriteria: $ref: ./examples/BackupInstanceOperations/TriggerRestoreWithGenericParameters.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Restore ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups : post: tags: - BackupInstances description: This operation will resume backups for backup instance operationId: microsoftAzureBackupinstancesResumebackups produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: ResumeBackups: $ref: ./examples/BackupInstanceOperations/ResumeBackups.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Resumebackups ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection : post: tags: - BackupInstances description: This operation will resume protection for a stopped backup instance operationId: microsoftAzureBackupinstancesResumeprotection produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: ResumeProtection: $ref: ./examples/BackupInstanceOperations/ResumeProtection.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Resumeprotection ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection : post: tags: - BackupInstances description: This operation will stop protection of a backup instance and data will be held forever operationId: microsoftAzureBackupinstancesStopprotection produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: StopProtection: $ref: ./examples/BackupInstanceOperations/StopProtection.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Stopprotection ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups : post: tags: - BackupInstances description: This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever) operationId: microsoftAzureBackupinstancesSuspendbackups produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: OK '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: SuspendBackups: $ref: ./examples/BackupInstanceOperations/SuspendBackups.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Suspendbackups ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync : post: tags: - BackupInstances description: Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state operationId: microsoftAzureBackupinstancesSyncbackupinstance produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/SyncBackupInstanceRequest' responses: '200': description: OK '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Sync BackupInstance: $ref: ./examples/BackupInstanceOperations/SyncBackupInstance.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Sync ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore : post: tags: - BackupInstances description: Validates if Restore can be triggered for a DataSource operationId: microsoftAzureBackupinstancesValidateforrestore produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultName' - $ref: '#/parameters/BackupInstanceName' - name: parameters in: body description: Request body for operation required: true schema: $ref: '#/definitions/ValidateRestoreRequestObject' responses: '200': description: Contains additional information like job Id schema: $ref: '#/definitions/OperationJobExtendedInfo' '202': description: The operation will be completed asynchronously. headers: Location: description: The URL of the resource used to check the status of the asynchronous operation. type: string Azure-AsyncOperation: description: The URL of the resource used to check the status of the asynchronous operation. type: string Retry-After: description: Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. type: integer format: int32 default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Validate Restore: $ref: ./examples/BackupInstanceOperations/ValidateRestore.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dataprotection Backupvaults Vaultname Backupinstances Backupinstancename Validaterestore definitions: BackupInstanceResourceList: allOf: - $ref: '#/definitions/DppResourceList' description: BackupInstance Resource list response properties: value: description: List of resources. items: $ref: '#/definitions/BackupInstanceResource' type: array title: BackupInstanceResourceList type: object ValidateCrossRegionRestoreRequestObject: description: Cross Region Restore Request Object required: - restoreRequestObject - crossRegionRestoreDetails type: object properties: restoreRequestObject: $ref: '#/definitions/AzureBackupRestoreRequest' description: Gets or sets the restore request object. crossRegionRestoreDetails: $ref: '#/definitions/CrossRegionRestoreDetails' description: Cross region restore details. BackupInstanceResource: allOf: - $ref: '#/definitions/DppProxyResource' description: BackupInstance Resource properties: properties: $ref: '#/definitions/BackupInstance' description: BackupInstanceResource properties title: BackupInstanceResource ErrorAdditionalInfo: description: The resource management error additional info. properties: info: description: The additional info. readOnly: true type: object type: description: The additional info type. readOnly: true type: string OperationJobExtendedInfo: allOf: - $ref: '#/definitions/OperationExtendedInfo' description: Operation Job Extended Info properties: jobId: description: Name or Arm Id of the job created for this operation. type: string title: OperationJobExtendedInfo type: object x-ms-discriminator-value: OperationJobExtendedInfo IdentityDetails: type: object properties: useSystemAssignedIdentity: description: Specifies if the BI is protected by System Identity. type: boolean userAssignedIdentityArmUrl: description: ARM URL for User Assigned Identity. type: string InnerError: description: Inner Error properties: additionalInfo: additionalProperties: type: string description: Any Key value pairs that can be provided to the client for additional verbose information. type: object code: description: Unique code for this error type: string embeddedInnerError: $ref: '#/definitions/InnerError' description: Child Inner Error, to allow Nesting. title: InnerError type: object DppResourceList: description: ListResource properties: nextLink: description: The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. type: string title: List Resource type: object CrossRegionRestoreRequestObject: description: Cross Region Restore Request Object required: - restoreRequestObject - crossRegionRestoreDetails type: object properties: restoreRequestObject: $ref: '#/definitions/AzureBackupRestoreRequest' description: Gets or sets the restore request object. crossRegionRestoreDetails: $ref: '#/definitions/CrossRegionRestoreDetails' description: Cross region restore details. PolicyParameters: description: Parameters in Policy type: object x-ms-mutability: - create - read properties: dataStoreParametersList: description: Gets or sets the DataStore Parameters type: array items: $ref: '#/definitions/DataStoreParameters' x-ms-identifiers: [] backupDatasourceParametersList: description: Gets or sets the Backup Data Source Parameters type: array items: $ref: '#/definitions/BackupDatasourceParameters' x-ms-identifiers: [] AzureBackupRehydrationRequest: description: Azure Backup Rehydrate Request properties: recoveryPointId: description: Id of the recovery point to be recovered type: string rehydrationPriority: description: Priority to be used for rehydration. Values High or Standard $ref: '#/definitions/RehydrationPriority' rehydrationRetentionDuration: description: Retention duration in ISO 8601 format i.e P10D . type: string required: - recoveryPointId - rehydrationRetentionDuration title: AzureBackupRehydrationRequest type: object DatasourceSet: description: DatasourceSet details of datasource to be backed up properties: datasourceType: description: DatasourceType of the resource. type: string objectType: description: Type of Datasource object, used to initialize the right inherited type type: string resourceID: description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. type: string resourceLocation: description: Location of datasource. type: string resourceName: description: Unique identifier of the resource in the context of parent. type: string resourceType: description: Resource Type of Datasource. type: string resourceUri: description: Uri of the resource. type: string resourceProperties: $ref: '#/definitions/BaseResourceProperties' description: Properties specific to data source set required: - resourceID title: DatasourceSet type: object OperationExtendedInfo: description: Operation Extended Info properties: objectType: description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. type: string title: OperationExtendedInfo discriminator: objectType type: object required: - objectType BackupDatasourceParameters: description: Parameters for Backup Datasource required: - objectType type: object properties: objectType: description: Type of the specific object - used for deserializing type: string readOnly: false discriminator: objectType CrossRegionRestoreDetails: description: Cross Region Restore details required: - sourceRegion - sourceBackupInstanceId type: object properties: sourceRegion: type: string sourceBackupInstanceId: type: string AzureBackupRestoreRequest: description: Azure backup restore request discriminator: objectType properties: objectType: type: string restoreTargetInfo: $ref: '#/definitions/RestoreTargetInfoBase' description: Gets or sets the restore target information. sourceDataStoreType: description: Gets or sets the type of the source data store. enum: - ArchiveStore - SnapshotStore - OperationalStore - VaultStore type: string x-ms-enum: modelAsString: true name: SourceDataStoreType sourceResourceId: description: Fully qualified Azure Resource Manager ID of the datasource which is being recovered. type: string identityDetails: $ref: '#/definitions/IdentityDetails' description: "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned." required: - objectType - restoreTargetInfo - sourceDataStoreType title: AzureBackupRestoreRequest type: object BaseResourceProperties: description: Properties which are specific to datasource/datasourceSets required: - objectType type: object properties: objectType: description: Type of the specific object - used for deserializing type: string readOnly: false enum: - DefaultResourceProperties x-ms-enum: name: ResourcePropertiesObjectType modelAsString: true discriminator: objectType BackupInstance: description: Backup Instance required: - dataSourceInfo - policyInfo - objectType type: object properties: friendlyName: description: Gets or sets the Backup Instance friendly name. type: string dataSourceInfo: $ref: '#/definitions/Datasource' description: Gets or sets the data source information. dataSourceSetInfo: $ref: '#/definitions/DatasourceSet' description: Gets or sets the data source set information. policyInfo: $ref: '#/definitions/PolicyInfo' description: Gets or sets the policy information. protectionStatus: $ref: '#/definitions/ProtectionStatusDetails' description: Specifies the protection status of the resource readOnly: true currentProtectionState: description: Specifies the current protection state of the resource enum: - Invalid - NotProtected - ConfiguringProtection - ProtectionConfigured - BackupSchedulesSuspended - RetentionSchedulesSuspended - ProtectionStopped - ProtectionError - ConfiguringProtectionFailed - SoftDeleting - SoftDeleted - UpdatingProtection type: string readOnly: true x-ms-enum: name: CurrentProtectionState modelAsString: true protectionErrorDetails: $ref: '#/definitions/UserFacingError' description: Specifies the protection error of the resource readOnly: true provisioningState: description: Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed type: string readOnly: true datasourceAuthCredentials: $ref: '#/definitions/AuthCredentials' description: Credentials to use to authenticate with data source provider. validationType: description: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. enum: - ShallowValidation - DeepValidation type: string x-ms-enum: name: ValidationType modelAsString: true identityDetails: $ref: '#/definitions/IdentityDetails' description: "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned." objectType: type: string RestoreTargetInfoBase: description: Base class common to RestoreTargetInfo and RestoreFilesTargetInfo discriminator: objectType properties: objectType: description: Type of Datasource object, used to initialize the right inherited type type: string recoveryOption: description: Recovery Option enum: - FailIfExists type: string x-ms-enum: modelAsString: true name: RecoveryOption restoreLocation: description: Target Restore region type: string required: - objectType - recoveryOption type: object ValidateRestoreRequestObject: description: Validate restore request object properties: restoreRequestObject: $ref: '#/definitions/AzureBackupRestoreRequest' description: Gets or sets the restore request object. required: - restoreRequestObject title: ValidateRestoreRequestObject type: object RehydrationPriority: description: Priority to be used for rehydration. Values High or Standard enum: - Invalid - High - Standard type: string x-ms-enum: modelAsString: true name: RehydrationPriority TriggerBackupRequest: description: Trigger backup request properties: backupRuleOptions: $ref: '#/definitions/AdHocBackupRuleOptions' description: Name for the Rule of the Policy which needs to be applied for this backup required: - backupRuleOptions title: TriggerBackupRequest type: object Error: description: The resource management error response. properties: additionalInfo: description: The error additional info. items: $ref: '#/definitions/ErrorAdditionalInfo' x-ms-identifiers: [] readOnly: true type: array code: description: The error code. readOnly: true type: string details: description: The error details. items: $ref: '#/definitions/Error' x-ms-identifiers: [] readOnly: true type: array message: description: The error message. readOnly: true type: string target: description: The error target. readOnly: true type: string AuthCredentials: description: Base class for different types of authentication credentials. required: - objectType type: object properties: objectType: description: Type of the specific object - used for deserializing type: string readOnly: false discriminator: objectType SyncBackupInstanceRequest: description: Sync BackupInstance Request type: object properties: syncType: description: Field indicating sync type e.g. to sync only in case of failure or in all cases enum: - Default - ForceResync type: string x-ms-enum: name: SyncType modelAsString: true ProtectionStatusDetails: description: Protection status details properties: errorDetails: $ref: '#/definitions/UserFacingError' description: Specifies the protection status error of the resource status: description: Specifies the protection status of the resource enum: - ConfiguringProtection - ConfiguringProtectionFailed - ProtectionConfigured - ProtectionStopped - SoftDeleted - SoftDeleting type: string x-ms-enum: modelAsString: true name: Status title: ProtectionStatusDetails type: object AdhocBackupTriggerOption: description: Adhoc backup trigger option properties: retentionTagOverride: type: string title: AdhocBackupTriggerOption type: object DppProxyResource: properties: id: description: Proxy Resource Id represents the complete path to the resource. readOnly: true type: string name: description: Proxy Resource name associated with the resource. readOnly: true type: string type: description: Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... readOnly: true type: string tags: additionalProperties: type: string description: Proxy Resource tags. type: object systemData: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData type: object x-ms-azure-resource: true ValidateForModifyBackupRequest: description: Validate for modify backup request properties: backupInstance: $ref: '#/definitions/BackupInstance' required: - backupInstance title: ValidateForModifyBackupRequest type: object CloudError: description: An error response from Azure Backup. properties: error: $ref: '#/definitions/Error' title: CloudError x-ms-external: true ValidateForBackupRequest: description: Validate for backup request properties: backupInstance: $ref: '#/definitions/BackupInstance' required: - backupInstance title: ValidateForBackupRequest type: object AdHocBackupRuleOptions: description: Adhoc backup rules properties: ruleName: type: string triggerOption: $ref: '#/definitions/AdhocBackupTriggerOption' required: - ruleName - triggerOption title: AdHocBackupRuleOptions type: object DataStoreParameters: description: Parameters for DataStore required: - objectType - dataStoreType type: object properties: objectType: description: Type of the specific object - used for deserializing type: string readOnly: false dataStoreType: description: type of datastore; Operational/Vault/Archive enum: - OperationalStore - VaultStore - ArchiveStore type: string x-ms-enum: name: DataStoreTypes modelAsString: true discriminator: objectType PolicyInfo: description: Policy Info in backupInstance properties: policyId: type: string policyVersion: readOnly: true type: string policyParameters: $ref: '#/definitions/PolicyParameters' description: Policy parameters for the backup instance required: - policyId title: PolicyInfo type: object Datasource: description: Datasource to be backed up properties: datasourceType: description: DatasourceType of the resource. type: string objectType: description: Type of Datasource object, used to initialize the right inherited type type: string resourceID: description: Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. type: string resourceLocation: description: Location of datasource. type: string resourceName: description: Unique identifier of the resource in the context of parent. type: string resourceType: description: Resource Type of Datasource. type: string resourceUri: description: Uri of the resource. type: string resourceProperties: $ref: '#/definitions/BaseResourceProperties' description: Properties specific to data source required: - resourceID title: Datasource type: object UserFacingError: description: Error object used by layers that have access to localized content, and propagate that to user properties: code: description: Unique code for this error type: string details: description: Additional related Errors items: $ref: '#/definitions/UserFacingError' x-ms-identifiers: [] type: array innerError: $ref: '#/definitions/InnerError' description: Inner Error isRetryable: description: Whether the operation will be retryable or not type: boolean isUserError: description: Whether the operation is due to a user error or service error type: boolean properties: description: Any key value pairs that can be injected inside error object type: object additionalProperties: type: string message: type: string recommendedAction: description: RecommendedAction � localized. items: type: string type: array target: description: Target of the error. type: string type: object parameters: BackupInstanceName: name: backupInstanceName in: path description: The name of the backup instance. required: true type: string x-ms-parameter-location: method VaultName: name: vaultName in: path description: The name of the backup vault. required: true type: string x-ms-parameter-location: method RestrictedVaultName: name: vaultName in: path description: The name of the backup vault. required: true type: string x-ms-parameter-location: method pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$ minLength: 2 maxLength: 50 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'