你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Backup Instances - Trigger Restore

服务:: Data Protection

API 版本:: 2025-09-01

触发 BackupInstance 的还原

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

URI 参数

名称	在	必需	类型	说明
backupInstanceName	path	True	string	BackupInstanceResource 的名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
vaultName	path	True	string minLength: 2 maxLength: 50 pattern: ^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$	备份保管库的名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求头

名称	必需	类型	说明
x-ms-authorization-auxiliary		string

请求正文

请求正文可以为下列任一内容：

名称	说明
AzureBackupRecoveryPointBasedRestoreRequest	基于 Azure 备份恢复点的还原请求
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime 基于还原请求
AzureBackupRestoreWithRehydrationRequest	使用解除冻结请求还原 AzureBackup

AzureBackupRecoveryPointBasedRestoreRequest

基于 Azure 备份恢复点的还原请求

名称	必需	类型	说明
objectType	True	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	True	string
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	True	SourceDataStoreType	获取或设置源数据存储的类型。
identityDetails		IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
resourceGuardOperationRequests		string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
sourceResourceId		string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackup RecoveryPointTime 基于还原请求

名称	必需	类型	说明
objectType	True	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	True	string	ISO 8601 格式的恢复时间示例 - 2020-08-14T17：30：00.0000000Z。
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	True	SourceDataStoreType	获取或设置源数据存储的类型。
identityDetails		IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
resourceGuardOperationRequests		string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
sourceResourceId		string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

AzureBackupRestoreWithRehydrationRequest

使用解除冻结请求还原 AzureBackup

名称	必需	类型	说明
objectType	True	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	True	string
rehydrationPriority	True	RehydrationPriority	用于解除冻结的优先级。值高或标准
rehydrationRetentionDuration	True	string	ISO 8601 格式（即 P10D）的保留持续时间。
restoreTargetInfo	True	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	True	SourceDataStoreType	获取或设置源数据存储的类型。
identityDetails		IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
resourceGuardOperationRequests		string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
sourceResourceId		string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

响应

名称	类型	说明
200 OK	OperationJobExtendedInfo	Azure作已成功完成。
202 Accepted		已接受资源作。标头 Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	意外的错误响应。

名称

类型

说明

200 OK

OperationJobExtendedInfo

Azure作已成功完成。

202 Accepted

已接受资源作。

标头

Azure-AsyncOperation: string
Location: string

Other Status Codes

CloudError

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Trigger Restore

Trigger Restore As Files

Trigger Restore With Rehydration

Trigger Restore

示例请求

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"
}

示例响应

状态代码:: 200

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

状态代码:: 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

示例请求

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"
}

示例响应

状态代码:: 200

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

状态代码:: 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

示例请求

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"
}

示例响应

状态代码:: 200

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

状态代码:: 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

定义

名称	说明
AzureBackupRecoveryPointBasedRestoreRequest	基于 Azure 备份恢复点的还原请求
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime 基于还原请求
AzureBackupRestoreWithRehydrationRequest	使用解除冻结请求还原 AzureBackup
CloudError	Azure 备份的错误响应。
Datasource	要备份的数据源
DatasourceSet	要备份的数据源的 DatasourceSet 详细信息
DefaultResourceProperties	默认源属性
Error	资源管理错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ExistingResourcePolicy	获取或设置冲突策略属性。此属性在还原期间设置资源冲突期间的策略。
IdentityDetails
ItemLevelRestoreTargetInfo	项级还原作的还原目标信息
ItemPathBasedRestoreCriteria	在还原期间要使用的前缀条件
KubernetesClusterRestoreCriteria	用于还原作的 kubernetes 群集备份目标信息
KubernetesClusterVaultTierRestoreCriteria	用于从保管库还原作的 kubernetes 群集备份目标信息
KubernetesPVRestoreCriteria	用于还原作的项级别 kubernetes 永久性卷目标信息
KubernetesStorageClassRestoreCriteria	用于还原作的项级 kubernetes 存储类目标信息
NamespacedNameResource	引用包含命名空间和名称的资源的类
OperationJobExtendedInfo	操作作业扩展信息
PersistentVolumeRestoreMode	获取或设置 PV （永久性卷）还原模式属性。此属性设置是否需要还原卷。
RangeBasedItemLevelRestoreCriteria	还原作的项级别目标信息
RecoveryOption	恢复选项
RehydrationPriority	用于解除冻结的优先级。值高或标准
ResourcePropertiesObjectType	特定对象的类型 - 用于反序列化
RestoreFilesTargetInfo	将还原封装为文件目标参数的类
RestoreTargetInfo	封装还原目标参数的类
RestoreTargetLocationType	表示将还原数据的目标位置，枚举 {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 的字符串值
SecretStoreBasedAuthCredentials	基于机密存储的身份验证凭据。
SecretStoreResource	表示机密存储资源的类。
SecretStoreType	获取或设置机密存储的类型
SourceDataStoreType	获取或设置源数据存储的类型。
TargetDetails	封装目标详细信息的类，用于目标不是数据源

AzureBackupRecoveryPointBasedRestoreRequest

Object

基于 Azure 备份恢复点的还原请求

名称	类型	说明
identityDetails	IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
resourceGuardOperationRequests	string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

AzureBackupRecoveryTimeBasedRestoreRequest

Object

AzureBackup RecoveryPointTime 基于还原请求

名称	类型	说明
identityDetails	IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
objectType	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	string	ISO 8601 格式的恢复时间示例 - 2020-08-14T17：30：00.0000000Z。
resourceGuardOperationRequests	string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

AzureBackupRestoreWithRehydrationRequest

Object

使用解除冻结请求还原 AzureBackup

名称	类型	说明
identityDetails	IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
objectType	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	string
rehydrationPriority	RehydrationPriority	用于解除冻结的优先级。值高或标准
rehydrationRetentionDuration	string	ISO 8601 格式（即 P10D）的保留持续时间。
resourceGuardOperationRequests	string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	正在恢复的数据源的完全限定的 Azure 资源管理器 ID。

CloudError

Object

Azure 备份的错误响应。

名称	类型	说明
error	Error	资源管理错误响应。

Datasource

Object

要备份的数据源

名称	类型	说明
datasourceType	string	资源的 DatasourceType。
objectType	string	Datasource 对象的类型，用于初始化正确的继承类型
resourceID	string	资源的完整 ARM ID。对于 Azure 资源，这是 ARM ID。对于非 Azure 资源，这是通过 Fabric/Vault 备份服务创建的 ID。
resourceLocation	string	数据源的位置。
resourceName	string	父上下文中资源的唯一标识符。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	特定于数据源的属性
resourceType	string	数据源的资源类型。
resourceUri	string	资源的 URI。

DatasourceSet

Object

要备份的数据源的 DatasourceSet 详细信息

名称	类型	说明
datasourceType	string	资源的 DatasourceType。
objectType	string	Datasource 对象的类型，用于初始化正确的继承类型
resourceID	string	资源的完整 ARM ID。对于 Azure 资源，这是 ARM ID。对于非 Azure 资源，这是通过 Fabric/Vault 备份服务创建的 ID。
resourceLocation	string	数据源的位置。
resourceName	string	父上下文中资源的唯一标识符。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	特定于数据源集的属性
resourceType	string	数据源的资源类型。
resourceUri	string	资源的 URI。

DefaultResourceProperties

Object

默认源属性

名称	类型	说明
objectType	string: DefaultResourceProperties	特定对象的类型 - 用于反序列化

Error

Object

资源管理错误响应。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	Error[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ExistingResourcePolicy

枚举

获取或设置冲突策略属性。此属性在还原期间设置资源冲突期间的策略。

值	说明
Skip
Patch

IdentityDetails

Object

名称	类型	说明
useSystemAssignedIdentity	boolean	指定 BI 是否受系统标识保护。
userAssignedIdentityArmUrl	string	用户分配标识的 ARM URL。

ItemLevelRestoreTargetInfo

Object

项级还原作的还原目标信息

名称	类型	说明
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	用于向数据源提供程序进行身份验证的凭据。
datasourceInfo	Datasource	目标 DS 的信息
datasourceSetInfo	DatasourceSet	目标 DS 集的信息
objectType	string: ItemLevelRestoreTargetInfo	Datasource 对象的类型，用于初始化正确的继承类型
recoveryOption	RecoveryOption	恢复选项
restoreCriteria	ItemLevelRestoreCriteria[]: ItemPathBasedRestoreCriteria[] KubernetesClusterRestoreCriteria[] KubernetesClusterVaultTierRestoreCriteria[] KubernetesPVRestoreCriteria[] KubernetesStorageClassRestoreCriteria[] RangeBasedItemLevelRestoreCriteria[]	还原条件
restoreLocation	string	目标还原区域

ItemPathBasedRestoreCriteria

Object

在还原期间要使用的前缀条件

名称	类型	说明
isPathRelativeToBackupItem	boolean	用于指定路径是否相对于备份项或完整路径的标志
itemPath	string	要还原的项的路径。它可以是项的完整路径，也可以是相对于备份项的路径
objectType	string: ItemPathBasedRestoreCriteria	特定对象的类型 - 用于反序列化
renameTo	string	重命名要还原的项目。如果指定了值，则 Restore 会将 itemPath 重命名为此新名称，否则 itemPath 将恢复为相同的名称。
subItemPathPrefix	string[]	在还原期间用作筛选器条件的前缀字符串列表。这些项相对于指定的项路径。

KubernetesClusterRestoreCriteria

Object

用于还原作的 kubernetes 群集备份目标信息

名称	类型	说明
conflictPolicy	ExistingResourcePolicy	获取或设置冲突策略属性。此属性在还原期间设置资源冲突期间的策略。
excludedNamespaces	string[]	获取或设置 exclude 命名空间属性。此属性设置在还原期间要排除的命名空间。
excludedResourceTypes	string[]	获取或设置排除资源类型属性。此属性设置在还原期间要排除的资源类型。
includeClusterScopeResources	boolean	获取或设置 include 群集资源属性。如果启用此属性，则会在还原期间包括群集范围资源。
includedNamespaces	string[]	获取或设置 include 命名空间属性。此属性设置还原期间要包括的命名空间。
includedResourceTypes	string[]	获取或设置 include 资源类型属性。此属性设置在还原期间要包含的资源类型。
labelSelectors	string[]	获取或设置 LabelSelectors 属性。此属性设置在还原期间要包含的具有此类标签选择器的资源。
namespaceMappings	object	获取或设置命名空间映射属性。此属性设置在还原期间是否需要更改命名空间。
objectType	string: KubernetesClusterRestoreCriteria	特定对象的类型 - 用于反序列化
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	获取或设置 PV （永久性卷）还原模式属性。此属性设置是否需要还原卷。
resourceModifierReference	NamespacedNameResource	获取或设置资源修饰符引用。此属性设置还原期间资源修饰符的引用。
restoreHookReferences	NamespacedNameResource[]	获取或设置还原挂钩引用。此属性设置在还原期间要执行的挂钩引用。

KubernetesClusterVaultTierRestoreCriteria

Object

用于从保管库还原作的 kubernetes 群集备份目标信息

名称	类型	说明
conflictPolicy	ExistingResourcePolicy	获取或设置冲突策略属性。此属性设置从保管库还原期间资源冲突期间的策略。
excludedNamespaces	string[]	获取或设置 exclude 命名空间属性。此属性设置从保管库还原期间要排除的命名空间。
excludedResourceTypes	string[]	获取或设置排除资源类型属性。此属性设置从保管库还原期间要排除的资源类型。
includeClusterScopeResources	boolean	获取或设置 include 群集资源属性。如果启用此属性，则会在从保管库还原期间包括群集范围资源。
includedNamespaces	string[]	获取或设置 include 命名空间属性。此属性设置从保管库还原期间要包括的命名空间。
includedResourceTypes	string[]	获取或设置 include 资源类型属性。此属性设置从保管库还原期间要包含的资源类型。
labelSelectors	string[]	获取或设置 LabelSelectors 属性。此属性设置在从保管库还原期间要包含的此类标签选择器的资源。
namespaceMappings	object	获取或设置命名空间映射属性。此属性设置是否需要在从保管库还原期间更改命名空间。
objectType	string: KubernetesClusterVaultTierRestoreCriteria	特定对象的类型 - 用于反序列化
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	获取或设置 PV （永久性卷）还原模式属性。此属性设置是否需要从保管库还原卷。
resourceModifierReference	NamespacedNameResource	获取或设置资源修饰符引用。此属性设置还原期间资源修饰符的引用。
restoreHookReferences	NamespacedNameResource[]	获取或设置还原挂钩引用。此属性设置从保管库还原期间要执行的挂钩引用。
stagingResourceGroupId	string (arm-id)	获取或设置用于在从保管库还原期间创建临时磁盘和快照的暂存 RG ID。
stagingStorageAccountId	string (arm-id)	获取或设置用于在从保管库还原期间创建备份扩展对象存储数据的暂存存储帐户 ID。

KubernetesPVRestoreCriteria

Object

用于还原作的项级别 kubernetes 永久性卷目标信息

名称	类型	说明
name	string	所选永久性卷声明名称
objectType	string: KubernetesPVRestoreCriteria	特定对象的类型 - 用于反序列化
storageClassName	string	用于还原作的所选存储类名称

KubernetesStorageClassRestoreCriteria

Object

用于还原作的项级 kubernetes 存储类目标信息

名称	类型	说明
objectType	string: KubernetesStorageClassRestoreCriteria	特定对象的类型 - 用于反序列化
provisioner	string	存储类的预配程序
selectedStorageClassName	string	所选存储类名称

NamespacedNameResource

Object

引用包含命名空间和名称的资源的类

名称	类型	说明
name	string	资源的名称
namespace	string	资源所在的命名空间

OperationJobExtendedInfo

Object

操作作业扩展信息

名称	类型	说明
jobId	string	为此作创建的作业的名称或 Arm ID。
objectType	string: OperationJobExtendedInfo	此属性将用作用于确定类型多态链中特定类型的鉴别器。

PersistentVolumeRestoreMode

枚举

获取或设置 PV （永久性卷）还原模式属性。此属性设置是否需要还原卷。

值	说明
RestoreWithVolumeData
RestoreWithoutVolumeData

RangeBasedItemLevelRestoreCriteria

Object

还原作的项级别目标信息

名称	类型	说明
maxMatchingValue	string	范围前缀匹配的最大值
minMatchingValue	string	范围前缀匹配的最小值
objectType	string: RangeBasedItemLevelRestoreCriteria	特定对象的类型 - 用于反序列化

RecoveryOption

枚举

恢复选项

值	说明
FailIfExists

RehydrationPriority

枚举

用于解除冻结的优先级。值高或标准

值	说明
Invalid
High
Standard

ResourcePropertiesObjectType

枚举

特定对象的类型 - 用于反序列化

值	说明
DefaultResourceProperties

RestoreFilesTargetInfo

Object

将还原封装为文件目标参数的类

名称	类型	说明
objectType	string: RestoreFilesTargetInfo	Datasource 对象的类型，用于初始化正确的继承类型
recoveryOption	RecoveryOption	恢复选项
restoreLocation	string	目标还原区域
targetDetails	TargetDetails	RestoreAsFiles作的目标，当目标不是数据源时

RestoreTargetInfo

Object

封装还原目标参数的类

名称	类型	说明
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	用于向数据源提供程序进行身份验证的凭据。
datasourceInfo	Datasource	目标 DS 的信息
datasourceSetInfo	DatasourceSet	目标 DS 集的信息
objectType	string: RestoreTargetInfo	Datasource 对象的类型，用于初始化正确的继承类型
recoveryOption	RecoveryOption	恢复选项
restoreLocation	string	目标还原区域

RestoreTargetLocationType

枚举

表示将还原数据的目标位置，枚举 {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 的字符串值

值	说明
Invalid
AzureBlobs
AzureFiles

SecretStoreBasedAuthCredentials

Object

基于机密存储的身份验证凭据。

名称	类型	说明
objectType	string: SecretStoreBasedAuthCredentials	特定对象的类型 - 用于反序列化
secretStoreResource	SecretStoreResource	机密存储资源

SecretStoreResource

Object

表示机密存储资源的类。

名称	类型	说明
secretStoreType	SecretStoreType	获取或设置机密存储的类型
uri	string	用于访问资源的 URI
value	string	获取或设置存储在机密存储资源中的值

SecretStoreType

枚举

获取或设置机密存储的类型

值	说明
Invalid
AzureKeyVault

SourceDataStoreType

枚举

获取或设置源数据存储的类型。

值	说明
ArchiveStore
SnapshotStore
OperationalStore
VaultStore

TargetDetails

Object

封装目标详细信息的类，用于目标不是数据源

名称	类型	说明
filePrefix	string	还原作可能会在 Url 下面指向的位置内创建多个文件，将是所有这些文件的通用前缀
restoreTargetLocationType	RestoreTargetLocationType	表示将还原数据的目标位置，枚举 {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 的字符串值
targetResourceArmId	string	表示还原目标的完整 ARM ID。它是指向容器/文件共享的 ARM ID。如果可以使用 URL 字段标识目标订阅，则这是可选的。否则，如果 BackupVault 的 CrossSubscriptionRestore 字段处于任何禁用状态，则需要此字段
url	string	表示还原目标的 URL。它可以指向容器/文件共享等

通过

Backup Instances - Trigger Restore

URI 参数

请求头

请求正文

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRestoreWithRehydrationRequest

响应

安全性

azure_auth

作用域

示例

Trigger Restore

示例请求

示例响应

Trigger Restore As Files

示例请求

示例响应

Trigger Restore With Rehydration

示例请求

示例响应

定义

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