Backup Instances - Trigger Restore

Service:: Data Protection

API Version:: 2025-09-01

Triggers restore for a BackupInstance

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore?api-version=2025-09-01

URI Parameters

Name	In	Required	Type	Description
backupInstanceName	path	True	string	The name of the BackupInstanceResource
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	path	True	string minLength: 2 maxLength: 50 pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$	The name of the backup vault.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-authorization-auxiliary		string

Request Body

The request body can be one of the following:

Name	Description
AzureBackupRecoveryPointBasedRestoreRequest	Azure backup recoveryPoint based restore request
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime Based Restore Request
AzureBackupRestoreWithRehydrationRequest	AzureBackup Restore with Rehydration Request

AzureBackupRecoveryPointBasedRestoreRequest

Azure backup recoveryPoint based restore request

Name	Required	Type	Description
objectType	True	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	True	string
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	True	SourceDataStoreType	Gets or sets the type of the source data store.
identityDetails		IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests on which LAC check will be performed
sourceResourceId		string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackup RecoveryPointTime Based Restore Request

Name	Required	Type	Description
objectType	True	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	True	string	The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	True	SourceDataStoreType	Gets or sets the type of the source data store.
identityDetails		IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests on which LAC check will be performed
sourceResourceId		string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

AzureBackupRestoreWithRehydrationRequest

AzureBackup Restore with Rehydration Request

Name	Required	Type	Description
objectType	True	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	True	string
rehydrationPriority	True	RehydrationPriority	Priority to be used for rehydration. Values High or Standard
rehydrationRetentionDuration	True	string	Retention duration in ISO 8601 format i.e P10D .
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	True	SourceDataStoreType	Gets or sets the type of the source data store.
identityDetails		IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests		string[]	ResourceGuardOperationRequests on which LAC check will be performed
sourceResourceId		string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

Responses

Name	Type	Description
200 OK	OperationJobExtendedInfo	Azure operation completed successfully.
202 Accepted		Resource operation accepted. Headers Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	An unexpected error response.

Name

Type

Description

200 OK

OperationJobExtendedInfo

Azure operation completed successfully.

202 Accepted

Resource operation accepted.

Headers

Azure-AsyncOperation: string
Location: string

Other Status Codes

CloudError

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Trigger Restore

Trigger Restore As Files

Trigger Restore With Rehydration

Trigger Restore

Sample request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2025-09-01

{
  "identityDetails": {
    "useSystemAssignedIdentity": false,
    "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourcegroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
  },
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "restoreTargetInfo": {
    "datasourceAuthCredentials": {
      "objectType": "SecretStoreBasedAuthCredentials",
      "secretStoreResource": {
        "secretStoreType": "AzureKeyVault",
        "uri": "https://samplevault.vault.azure.net/secrets/credentials"
      }
    },
    "datasourceInfo": {
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb",
      "resourceLocation": "",
      "resourceName": "targetdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": ""
    },
    "datasourceSetInfo": {
      "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": ""
    },
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia"
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Sample response

Status code:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

Trigger Restore As Files

Sample request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2025-09-01

{
  "objectType": "AzureBackupRecoveryPointBasedRestoreRequest",
  "recoveryPointId": "hardcodedRP",
  "restoreTargetInfo": {
    "objectType": "RestoreFilesTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia",
    "targetDetails": {
      "filePrefix": "restoredblob",
      "restoreTargetLocationType": "AzureBlobs",
      "url": "https://teststorage.blob.core.windows.net/restoretest"
    }
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Sample response

Status code:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

Trigger Restore With Rehydration

Sample request

HTTP

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/restore?api-version=2025-09-01

{
  "objectType": "AzureBackupRestoreWithRehydrationRequest",
  "recoveryPointId": "hardcodedRP",
  "rehydrationPriority": "High",
  "rehydrationRetentionDuration": "7D",
  "restoreTargetInfo": {
    "datasourceInfo": {
      "datasourceType": "OssDB",
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceLocation": "",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": ""
    },
    "datasourceSetInfo": {
      "datasourceType": "OssDB",
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceLocation": "",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": ""
    },
    "objectType": "RestoreTargetInfo",
    "recoveryOption": "FailIfExists",
    "restoreLocation": "southeastasia"
  },
  "sourceDataStoreType": "VaultStore",
  "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"
}

Sample response

Status code:: 200

{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

Definitions

Name	Description
AzureBackupRecoveryPointBasedRestoreRequest	Azure backup recoveryPoint based restore request
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime Based Restore Request
AzureBackupRestoreWithRehydrationRequest	AzureBackup Restore with Rehydration Request
CloudError	An error response from Azure Backup.
Datasource	Datasource to be backed up
DatasourceSet	DatasourceSet details of datasource to be backed up
DefaultResourceProperties	Default source properties
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
ExistingResourcePolicy	Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.
IdentityDetails
ItemLevelRestoreTargetInfo	Restore target info for Item level restore operation
ItemPathBasedRestoreCriteria	Prefix criteria to be used to during restore
KubernetesClusterRestoreCriteria	kubernetes Cluster Backup target info for restore operation
KubernetesClusterVaultTierRestoreCriteria	kubernetes Cluster Backup target info for restore operation from vault
KubernetesPVRestoreCriteria	Item Level kubernetes persistent volume target info for restore operation
KubernetesStorageClassRestoreCriteria	Item Level kubernetes storage class target info for restore operation
NamespacedNameResource	Class to refer resources which contains namespace and name
OperationJobExtendedInfo	Operation Job Extended Info
PersistentVolumeRestoreMode	Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.
RangeBasedItemLevelRestoreCriteria	Item Level target info for restore operation
RecoveryOption	Recovery Option
RehydrationPriority	Priority to be used for rehydration. Values High or Standard
ResourcePropertiesObjectType	Type of the specific object - used for deserializing
RestoreFilesTargetInfo	Class encapsulating restore as files target parameters
RestoreTargetInfo	Class encapsulating restore target parameters
RestoreTargetLocationType	Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
SecretStoreBasedAuthCredentials	Secret store based authentication credentials.
SecretStoreResource	Class representing a secret store resource.
SecretStoreType	Gets or sets the type of secret store
SourceDataStoreType	Gets or sets the type of the source data store.
TargetDetails	Class encapsulating target details, used where the destination is not a datasource

AzureBackupRecoveryPointBasedRestoreRequest

Object

Azure backup recoveryPoint based restore request

Name	Type	Description
identityDetails	IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	SourceDataStoreType	Gets or sets the type of the source data store.
sourceResourceId	string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

AzureBackupRecoveryTimeBasedRestoreRequest

Object

AzureBackup RecoveryPointTime Based Restore Request

Name	Type	Description
identityDetails	IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
objectType	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	string	The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	SourceDataStoreType	Gets or sets the type of the source data store.
sourceResourceId	string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

AzureBackupRestoreWithRehydrationRequest

Object

AzureBackup Restore with Rehydration Request

Name	Type	Description
identityDetails	IdentityDetails	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
objectType	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	string
rehydrationPriority	RehydrationPriority	Priority to be used for rehydration. Values High or Standard
rehydrationRetentionDuration	string	Retention duration in ISO 8601 format i.e P10D .
resourceGuardOperationRequests	string[]	ResourceGuardOperationRequests on which LAC check will be performed
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	Gets or sets the restore target information.
sourceDataStoreType	SourceDataStoreType	Gets or sets the type of the source data store.
sourceResourceId	string	Fully qualified Azure Resource Manager ID of the datasource which is being recovered.

CloudError

Object

An error response from Azure Backup.

Name	Type	Description
error	Error	The resource management error response.

Datasource

Object

Datasource to be backed up

Name	Type	Description
datasourceType	string	DatasourceType of the resource.
objectType	string	Type of Datasource object, used to initialize the right inherited type
resourceID	string	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.
resourceLocation	string	Location of datasource.
resourceName	string	Unique identifier of the resource in the context of parent.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Properties specific to data source
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DatasourceSet

Object

DatasourceSet details of datasource to be backed up

Name	Type	Description
datasourceType	string	DatasourceType of the resource.
objectType	string	Type of Datasource object, used to initialize the right inherited type
resourceID	string	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.
resourceLocation	string	Location of datasource.
resourceName	string	Unique identifier of the resource in the context of parent.
resourceProperties	BaseResourceProperties: DefaultResourceProperties	Properties specific to data source set
resourceType	string	Resource Type of Datasource.
resourceUri	string	Uri of the resource.

DefaultResourceProperties

Object

Default source properties

Name	Type	Description
objectType	string: DefaultResourceProperties	Type of the specific object - used for deserializing

Error

Object

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ExistingResourcePolicy

Enumeration

Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.

Value	Description
Skip
Patch

IdentityDetails

Object

Name	Type	Description
useSystemAssignedIdentity	boolean	Specifies if the BI is protected by System Identity.
userAssignedIdentityArmUrl	string	ARM URL for User Assigned Identity.

ItemLevelRestoreTargetInfo

Object

Restore target info for Item level restore operation

Name	Type	Description
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credentials to use to authenticate with data source provider.
datasourceInfo	Datasource	Information of target DS
datasourceSetInfo	DatasourceSet	Information of target DS Set
objectType	string: ItemLevelRestoreTargetInfo	Type of Datasource object, used to initialize the right inherited type
recoveryOption	RecoveryOption	Recovery Option
restoreCriteria	ItemLevelRestoreCriteria[]: ItemPathBasedRestoreCriteria[] KubernetesClusterRestoreCriteria[] KubernetesClusterVaultTierRestoreCriteria[] KubernetesPVRestoreCriteria[] KubernetesStorageClassRestoreCriteria[] RangeBasedItemLevelRestoreCriteria[]	Restore Criteria
restoreLocation	string	Target Restore region

ItemPathBasedRestoreCriteria

Object

Prefix criteria to be used to during restore

Name	Type	Description
isPathRelativeToBackupItem	boolean	Flag to specify if the path is relative to backup item or full path
itemPath	string	The path of the item to be restored. It could be the full path of the item or the path relative to the backup item
objectType	string: ItemPathBasedRestoreCriteria	Type of the specific object - used for deserializing
renameTo	string	Rename the item to be restored. Restore will rename the itemPath to this new name if the value is specified otherwise the itemPath will be restored as same name.
subItemPathPrefix	string[]	The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.

KubernetesClusterRestoreCriteria

Object

kubernetes Cluster Backup target info for restore operation

Name	Type	Description
conflictPolicy	ExistingResourcePolicy	Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.
excludedNamespaces	string[]	Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.
excludedResourceTypes	string[]	Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.
includeClusterScopeResources	boolean	Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.
includedNamespaces	string[]	Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.
includedResourceTypes	string[]	Gets or sets the include resource types property. This property sets the resource types to be included during restore.
labelSelectors	string[]	Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.
namespaceMappings	object	Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.
objectType	string: KubernetesClusterRestoreCriteria	Type of the specific object - used for deserializing
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.
resourceModifierReference	NamespacedNameResource	Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.
restoreHookReferences	NamespacedNameResource[]	Gets or sets the restore hook references. This property sets the hook reference to be executed during restore.

KubernetesClusterVaultTierRestoreCriteria

Object

kubernetes Cluster Backup target info for restore operation from vault

Name	Type	Description
conflictPolicy	ExistingResourcePolicy	Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore from vault.
excludedNamespaces	string[]	Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore from vault.
excludedResourceTypes	string[]	Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore from vault.
includeClusterScopeResources	boolean	Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore from vault.
includedNamespaces	string[]	Gets or sets the include namespaces property. This property sets the namespaces to be included during restore from vault.
includedResourceTypes	string[]	Gets or sets the include resource types property. This property sets the resource types to be included during restore from vault.
labelSelectors	string[]	Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore from vault.
namespaceMappings	object	Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore from vault.
objectType	string: KubernetesClusterVaultTierRestoreCriteria	Type of the specific object - used for deserializing
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored from vault.
resourceModifierReference	NamespacedNameResource	Gets or sets the resource modifier reference. This property sets the reference for resource modifier during restore.
restoreHookReferences	NamespacedNameResource[]	Gets or sets the restore hook references. This property sets the hook reference to be executed during restore from vault.
stagingResourceGroupId	string (arm-id)	Gets or sets the staging RG Id for creating staging disks and snapshots during restore from vault.
stagingStorageAccountId	string (arm-id)	Gets or sets the staging Storage Account Id for creating backup extension object store data during restore from vault.

KubernetesPVRestoreCriteria

Object

Item Level kubernetes persistent volume target info for restore operation

Name	Type	Description
name	string	Selected persistent volume claim name
objectType	string: KubernetesPVRestoreCriteria	Type of the specific object - used for deserializing
storageClassName	string	Selected storage class name for restore operation

KubernetesStorageClassRestoreCriteria

Object

Item Level kubernetes storage class target info for restore operation

Name	Type	Description
objectType	string: KubernetesStorageClassRestoreCriteria	Type of the specific object - used for deserializing
provisioner	string	Provisioner of the storage class
selectedStorageClassName	string	Selected storage class name

NamespacedNameResource

Object

Class to refer resources which contains namespace and name

Name	Type	Description
name	string	Name of the resource
namespace	string	Namespace in which the resource exists

OperationJobExtendedInfo

Object

Operation Job Extended Info

Name	Type	Description
jobId	string	Name or Arm Id of the job created for this operation.
objectType	string: OperationJobExtendedInfo	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

PersistentVolumeRestoreMode

Enumeration

Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.

Value	Description
RestoreWithVolumeData
RestoreWithoutVolumeData

RangeBasedItemLevelRestoreCriteria

Object

Item Level target info for restore operation

Name	Type	Description
maxMatchingValue	string	maximum value for range prefix match
minMatchingValue	string	minimum value for range prefix match
objectType	string: RangeBasedItemLevelRestoreCriteria	Type of the specific object - used for deserializing

RecoveryOption

Enumeration

Recovery Option

Value	Description
FailIfExists

RehydrationPriority

Enumeration

Priority to be used for rehydration. Values High or Standard

Value	Description
Invalid
High
Standard

ResourcePropertiesObjectType

Enumeration

Type of the specific object - used for deserializing

Value	Description
DefaultResourceProperties

RestoreFilesTargetInfo

Object

Class encapsulating restore as files target parameters

Name	Type	Description
objectType	string: RestoreFilesTargetInfo	Type of Datasource object, used to initialize the right inherited type
recoveryOption	RecoveryOption	Recovery Option
restoreLocation	string	Target Restore region
targetDetails	TargetDetails	Destination of RestoreAsFiles operation, when destination is not a datasource

RestoreTargetInfo

Object

Class encapsulating restore target parameters

Name	Type	Description
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	Credentials to use to authenticate with data source provider.
datasourceInfo	Datasource	Information of target DS
datasourceSetInfo	DatasourceSet	Information of target DS Set
objectType	string: RestoreTargetInfo	Type of Datasource object, used to initialize the right inherited type
recoveryOption	RecoveryOption	Recovery Option
restoreLocation	string	Target Restore region

RestoreTargetLocationType

Enumeration

Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}

Value	Description
Invalid
AzureBlobs
AzureFiles

SecretStoreBasedAuthCredentials

Object

Secret store based authentication credentials.

Name	Type	Description
objectType	string: SecretStoreBasedAuthCredentials	Type of the specific object - used for deserializing
secretStoreResource	SecretStoreResource	Secret store resource

SecretStoreResource

Object

Class representing a secret store resource.

Name	Type	Description
secretStoreType	SecretStoreType	Gets or sets the type of secret store
uri	string	Uri to get to the resource
value	string	Gets or sets value stored in secret store resource

SecretStoreType

Enumeration

Gets or sets the type of secret store

Value	Description
Invalid
AzureKeyVault

SourceDataStoreType

Enumeration

Gets or sets the type of the source data store.

Value	Description
ArchiveStore
SnapshotStore
OperationalStore
VaultStore

TargetDetails

Object

Class encapsulating target details, used where the destination is not a datasource

Name	Type	Description
filePrefix	string	Restore operation may create multiple files inside location pointed by Url Below will be the common prefix for all of them
restoreTargetLocationType	RestoreTargetLocationType	Denotes the target location where the data will be restored, string value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}
targetResourceArmId	string	Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share This is optional if the target subscription can be identified with the URL field. If not then this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states
url	string	Url denoting the restore destination. It can point to container / file share etc

Share via

Backup Instances - Trigger Restore

URI Parameters

Request Header

Request Body

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRestoreWithRehydrationRequest

Responses

Security

azure_auth

Scopes

Examples

Trigger Restore

Sample request

Sample response

Trigger Restore As Files

Sample request

Sample response

Trigger Restore With Rehydration

Sample request

Sample response

Definitions

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRestoreWithRehydrationRequest

CloudError

Datasource

DatasourceSet

DefaultResourceProperties

Error

ErrorAdditionalInfo

ExistingResourcePolicy

IdentityDetails

ItemLevelRestoreTargetInfo

ItemPathBasedRestoreCriteria

KubernetesClusterRestoreCriteria

KubernetesClusterVaultTierRestoreCriteria

KubernetesPVRestoreCriteria

KubernetesStorageClassRestoreCriteria

NamespacedNameResource

OperationJobExtendedInfo

PersistentVolumeRestoreMode

RangeBasedItemLevelRestoreCriteria

RecoveryOption

RehydrationPriority

ResourcePropertiesObjectType

RestoreFilesTargetInfo

RestoreTargetInfo

RestoreTargetLocationType

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

SourceDataStoreType

TargetDetails