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

Backup Instances - Validate For Restore

参考

Service:: Data Protection

API Version:: 2023-01-01

验证是否可以为 DataSource 触发还原

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

URI 参数

名称	在	必需	类型	说明
backupInstanceName	path	True	string	备份实例的名称。
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
vaultName	path	True	string	备份保管库的名称。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
restoreRequestObject	True	AzureBackupRestoreRequest: AzureBackupRecoveryPointBasedRestoreRequest AzureBackupRecoveryTimeBasedRestoreRequest AzureBackupRestoreWithRehydrationRequest	AzureBackupRestoreRequest 获取或设置还原请求对象。

响应

名称	类型	说明
200 OK	OperationJobExtendedInfo	包含其他信息，如作业 ID
202 Accepted		操作将以异步方式完成。 Headers Location: string Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	描述操作失败原因的错误响应。

名称

类型

说明

200 OK

OperationJobExtendedInfo

包含其他信息，如作业 ID

202 Accepted

操作将以异步方式完成。

Headers

Location: string
Azure-AsyncOperation: string
Retry-After: integer

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟你的用户帐户。

示例

Validate Restore

Sample Request

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

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

import com.azure.resourcemanager.dataprotection.models.AzureBackupRecoveryPointBasedRestoreRequest;
import com.azure.resourcemanager.dataprotection.models.Datasource;
import com.azure.resourcemanager.dataprotection.models.DatasourceSet;
import com.azure.resourcemanager.dataprotection.models.RecoveryOption;
import com.azure.resourcemanager.dataprotection.models.RestoreTargetInfo;
import com.azure.resourcemanager.dataprotection.models.SecretStoreBasedAuthCredentials;
import com.azure.resourcemanager.dataprotection.models.SecretStoreResource;
import com.azure.resourcemanager.dataprotection.models.SecretStoreType;
import com.azure.resourcemanager.dataprotection.models.SourceDataStoreType;
import com.azure.resourcemanager.dataprotection.models.ValidateRestoreRequestObject;

/** Samples for BackupInstances ValidateForRestore. */
public final class Main {
    /*
     * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
     */
    /**
     * Sample code: Validate Restore.
     *
     * @param manager Entry point to DataProtectionManager.
     */
    public static void validateRestore(com.azure.resourcemanager.dataprotection.DataProtectionManager manager) {
        manager
            .backupInstances()
            .validateForRestore(
                "000pikumar",
                "PratikPrivatePreviewVault1",
                "testInstance1",
                new ValidateRestoreRequestObject()
                    .withRestoreRequestObject(
                        new AzureBackupRecoveryPointBasedRestoreRequest()
                            .withRestoreTargetInfo(
                                new RestoreTargetInfo()
                                    .withRecoveryOption(RecoveryOption.FAIL_IF_EXISTS)
                                    .withRestoreLocation("southeastasia")
                                    .withDatasourceInfo(
                                        new Datasource()
                                            .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                            .withObjectType("Datasource")
                                            .withResourceId(
                                                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb")
                                            .withResourceLocation("")
                                            .withResourceName("targetdb")
                                            .withResourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                            .withResourceUri(""))
                                    .withDatasourceSetInfo(
                                        new DatasourceSet()
                                            .withDatasourceType("Microsoft.DBforPostgreSQL/servers/databases")
                                            .withObjectType("DatasourceSet")
                                            .withResourceId(
                                                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest")
                                            .withResourceLocation("")
                                            .withResourceName("viveksipgtest")
                                            .withResourceType("Microsoft.DBforPostgreSQL/servers")
                                            .withResourceUri(""))
                                    .withDatasourceAuthCredentials(
                                        new SecretStoreBasedAuthCredentials()
                                            .withSecretStoreResource(
                                                new SecretStoreResource()
                                                    .withUri("https://samplevault.vault.azure.net/secrets/credentials")
                                                    .withSecretStoreType(SecretStoreType.AZURE_KEY_VAULT))))
                            .withSourceDataStoreType(SourceDataStoreType.VAULT_STORE)
                            .withSourceResourceId(
                                "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb")
                            .withRecoveryPointId("hardcodedRP")),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.dataprotection import DataProtectionMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-dataprotection
# USAGE
    python validate_restore.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataProtectionMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="04cf684a-d41f-4550-9f70-7708a3a2283b",
    )

    response = client.backup_instances.begin_validate_for_restore(
        resource_group_name="000pikumar",
        vault_name="PratikPrivatePreviewVault1",
        backup_instance_name="testInstance1",
        parameters={
            "restoreRequestObject": {
                "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",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdataprotection_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1b33e81bbdc28fcd6644a1315b8d7b1b6d030590/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
func ExampleBackupInstancesClient_BeginValidateForRestore() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdataprotection.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupInstancesClient().BeginValidateForRestore(ctx, "000pikumar", "PratikPrivatePreviewVault1", "testInstance1", armdataprotection.ValidateRestoreRequestObject{
		RestoreRequestObject: &armdataprotection.AzureBackupRecoveryPointBasedRestoreRequest{
			ObjectType: to.Ptr("AzureBackupRecoveryPointBasedRestoreRequest"),
			RestoreTargetInfo: &armdataprotection.RestoreTargetInfo{
				ObjectType:      to.Ptr("RestoreTargetInfo"),
				RecoveryOption:  to.Ptr(armdataprotection.RecoveryOptionFailIfExists),
				RestoreLocation: to.Ptr("southeastasia"),
				DatasourceAuthCredentials: &armdataprotection.SecretStoreBasedAuthCredentials{
					ObjectType: to.Ptr("SecretStoreBasedAuthCredentials"),
					SecretStoreResource: &armdataprotection.SecretStoreResource{
						SecretStoreType: to.Ptr(armdataprotection.SecretStoreTypeAzureKeyVault),
						URI:             to.Ptr("https://samplevault.vault.azure.net/secrets/credentials"),
					},
				},
				DatasourceInfo: &armdataprotection.Datasource{
					DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
					ObjectType:       to.Ptr("Datasource"),
					ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb"),
					ResourceLocation: to.Ptr(""),
					ResourceName:     to.Ptr("targetdb"),
					ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
					ResourceURI:      to.Ptr(""),
				},
				DatasourceSetInfo: &armdataprotection.DatasourceSet{
					DatasourceType:   to.Ptr("Microsoft.DBforPostgreSQL/servers/databases"),
					ObjectType:       to.Ptr("DatasourceSet"),
					ResourceID:       to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest"),
					ResourceLocation: to.Ptr(""),
					ResourceName:     to.Ptr("viveksipgtest"),
					ResourceType:     to.Ptr("Microsoft.DBforPostgreSQL/servers"),
					ResourceURI:      to.Ptr(""),
				},
			},
			SourceDataStoreType: to.Ptr(armdataprotection.SourceDataStoreTypeVaultStore),
			SourceResourceID:    to.Ptr("/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb"),
			RecoveryPointID:     to.Ptr("hardcodedRP"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OperationJobExtendedInfo = armdataprotection.OperationJobExtendedInfo{
	// 	ObjectType: to.Ptr("OperationJobExtendedInfo"),
	// 	JobID: to.Ptr("c60cb49-63e8-4b21-b9bd-26277b3fdfae"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DataProtectionClient } = require("@azure/arm-dataprotection");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Validates if Restore can be triggered for a DataSource
 *
 * @summary Validates if Restore can be triggered for a DataSource
 * x-ms-original-file: specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/examples/BackupInstanceOperations/ValidateRestore.json
 */
async function validateRestore() {
  const subscriptionId =
    process.env["DATAPROTECTION_SUBSCRIPTION_ID"] || "04cf684a-d41f-4550-9f70-7708a3a2283b";
  const resourceGroupName = process.env["DATAPROTECTION_RESOURCE_GROUP"] || "000pikumar";
  const vaultName = "PratikPrivatePreviewVault1";
  const backupInstanceName = "testInstance1";
  const parameters = {
    restoreRequestObject: {
      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",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataProtectionClient(credential, subscriptionId);
  const result = await client.backupInstances.beginValidateForRestoreAndWait(
    resourceGroupName,
    vaultName,
    backupInstanceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 202

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

Status code:: 200

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

定义

名称	说明
AzureBackupRecoveryPointBasedRestoreRequest	AzureBackupRecoveryPointBasedRestoreRequest
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackupRecoveryTimeBasedRestoreRequest
AzureBackupRestoreWithRehydrationRequest	AzureBackupRestoreWithRehydrationRequest
CloudError	CloudError
Datasource	数据源
DatasourceSet	DatasourceSet
Error	资源管理错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
ExistingResourcePolicy	获取或设置“冲突策略”属性。此属性在还原期间设置资源冲突期间的策略。
ItemLevelRestoreTargetInfo	项级还原操作的还原目标信息
ItemPathBasedRestoreCriteria	还原期间要使用的前缀条件
KubernetesClusterRestoreCriteria	用于还原操作的 kubernetes 群集备份目标信息
KubernetesPVRestoreCriteria	还原操作的项级别 kubernetes 永久性卷目标信息
KubernetesStorageClassRestoreCriteria	还原操作的项级别 kubernetes 存储类目标信息
OperationJobExtendedInfo	OperationJobExtendedInfo
PersistentVolumeRestoreMode	获取或设置 PV (永久卷) 还原模式属性。此属性设置是否需要还原卷。
RangeBasedItemLevelRestoreCriteria	还原操作的项目级别目标信息
RecoveryOption	恢复选项
RehydrationPriority	用于解除冻结的优先级。值高或标准
RestoreFilesTargetInfo	将还原封装为文件目标参数的类
RestoreTargetInfo	封装还原目标参数的类
RestoreTargetLocationType	表示将还原数据的目标位置，枚举 {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 的字符串值
SecretStoreBasedAuthCredentials	基于机密存储的身份验证凭据。
SecretStoreResource	表示机密存储资源的类。
SecretStoreType	获取或设置机密存储的类型
SourceDataStoreType	获取或设置源数据存储的类型。
TargetDetails	封装目标详细信息的类，在目标不是数据源的位置使用
ValidateRestoreRequestObject	ValidateRestoreRequestObject

AzureBackupRecoveryPointBasedRestoreRequest

名称	类型	说明
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	完全限定的 Azure 资源管理器要恢复的数据源的 ID。

AzureBackupRecoveryTimeBasedRestoreRequest

名称	类型	说明
objectType	string: AzureBackupRecoveryTimeBasedRestoreRequest
recoveryPointTime	string	ISO 8601 格式的恢复时间示例 - 2020-08-14T17：30：00.0000000Z。
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	完全限定的 Azure 资源管理器要恢复的数据源的 ID。

AzureBackupRestoreWithRehydrationRequest

名称	类型	说明
objectType	string: AzureBackupRestoreWithRehydrationRequest
recoveryPointId	string
rehydrationPriority	RehydrationPriority	用于解除冻结的优先级。值高或标准
rehydrationRetentionDuration	string	ISO 8601 格式的保留期，即 P10D 。
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	获取或设置还原目标信息。
sourceDataStoreType	SourceDataStoreType	获取或设置源数据存储的类型。
sourceResourceId	string	完全限定的 Azure 资源管理器要恢复的数据源的 ID。

CloudError

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

Datasource

数据源

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

DatasourceSet

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

Error

资源管理错误响应。

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

ErrorAdditionalInfo

资源管理错误附加信息。

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

ExistingResourcePolicy

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

名称	类型	说明
Patch	string
Skip	string

ItemLevelRestoreTargetInfo

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

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

ItemPathBasedRestoreCriteria

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

名称	类型	说明
isPathRelativeToBackupItem	boolean	用于指定路径是相对于备份项还是完整路径的标志
itemPath	string	要还原的项的路径。它可以是项的完整路径，也可以是相对于备份项的路径
objectType	string: ItemPathBasedRestoreCriteria	特定对象的类型 - 用于反序列化
subItemPathPrefix	string[]	在还原期间用作筛选条件的前缀字符串的列表。这些是相对于指定的项路径的。

KubernetesClusterRestoreCriteria

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

名称	类型	说明
conflictPolicy	ExistingResourcePolicy	获取或设置“冲突策略”属性。此属性在还原期间设置资源冲突期间的策略。
excludedNamespaces	string[]	获取或设置 exclude namespaces 属性。此属性设置在还原期间要排除的命名空间。
excludedResourceTypes	string[]	获取或设置排除资源类型属性。此属性设置还原期间要排除的资源类型。
includeClusterScopeResources	boolean	获取或设置 include 群集资源属性。此属性（如果启用）将在还原期间包括群集范围资源。
includedNamespaces	string[]	获取或设置 include namespaces 属性。此属性设置还原期间要包括的命名空间。
includedResourceTypes	string[]	获取或设置 include 资源类型属性。此属性设置还原期间要包括的资源类型。
labelSelectors	string[]	获取或设置 LabelSelectors 属性。此属性设置在还原期间包含此类标签选择器的资源。
namespaceMappings	object	获取或设置 Namespace Mappings 属性。此属性设置在还原期间是否需要更改命名空间。
objectType	string: KubernetesClusterRestoreCriteria	特定对象的类型 - 用于反序列化
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	获取或设置 PV (永久卷) 还原模式属性。此属性设置是否需要还原卷。

KubernetesPVRestoreCriteria

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

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

KubernetesStorageClassRestoreCriteria

还原操作的项级别 kubernetes 存储类目标信息

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

OperationJobExtendedInfo

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

PersistentVolumeRestoreMode

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

名称	类型	说明
RestoreWithVolumeData	string
RestoreWithoutVolumeData	string

RangeBasedItemLevelRestoreCriteria

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

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

RecoveryOption

恢复选项

名称	类型	说明
FailIfExists	string

RehydrationPriority

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

名称	类型	说明
High	string
Invalid	string
Standard	string

RestoreFilesTargetInfo

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

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

RestoreTargetInfo

封装还原目标参数的类

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

RestoreTargetLocationType

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

名称	类型	说明
AzureBlobs	string
AzureFiles	string
Invalid	string

SecretStoreBasedAuthCredentials

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

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

SecretStoreResource

表示机密存储资源的类。

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

SecretStoreType

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

名称	类型	说明
AzureKeyVault	string
Invalid	string

SourceDataStoreType

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

名称	类型	说明
ArchiveStore	string
OperationalStore	string
SnapshotStore	string
VaultStore	string

TargetDetails

封装目标详细信息的类，在目标不是数据源的位置使用

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

ValidateRestoreRequestObject

名称	类型	说明
restoreRequestObject	AzureBackupRestoreRequest: AzureBackupRecoveryPointBasedRestoreRequest AzureBackupRecoveryTimeBasedRestoreRequest AzureBackupRestoreWithRehydrationRequest	AzureBackupRestoreRequest 获取或设置还原请求对象。

Backup Instances - Validate For Restore

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

Validate Restore

Sample Request

Sample Response

定义

AzureBackupRecoveryPointBasedRestoreRequest

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackupRestoreWithRehydrationRequest

CloudError

Datasource

DatasourceSet

Error

ErrorAdditionalInfo

ExistingResourcePolicy

ItemLevelRestoreTargetInfo

ItemPathBasedRestoreCriteria

KubernetesClusterRestoreCriteria

KubernetesPVRestoreCriteria

KubernetesStorageClassRestoreCriteria

OperationJobExtendedInfo

PersistentVolumeRestoreMode

RangeBasedItemLevelRestoreCriteria

RecoveryOption

RehydrationPriority

RestoreFilesTargetInfo

RestoreTargetInfo

RestoreTargetLocationType

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

SourceDataStoreType

TargetDetails

ValidateRestoreRequestObject

其他资源