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

Backup Instances - Validate For Backup

参考

服务:: Data Protection

API 版本:: 2025-01-01

验证临时备份是否成功

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

URI 参数

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

请求正文

名称	必需	类型	说明
backupInstance	True	BackupInstance	备份实例

响应

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

名称

类型

说明

200 OK

OperationJobExtendedInfo

包含其他信息，如作业 ID

202 Accepted

该作将以异步方式完成。

标头

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

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

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

示例

Validate For Backup

示例请求

HTTP

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

{
  "backupInstance": {
    "objectType": "BackupInstance",
    "friendlyName": "harshitbi2",
    "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": "OssDB"
    },
    "dataSourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    }
  }
}

示例响应

状态代码:: 202

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-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=2025-01-01
Retry-After: 60

状态代码:: 200

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

定义

名称	说明
AKSVolumeTypes	获取或设置 include 卷类型属性。此属性设置备份期间要包含的卷类型。
AzureOperationalStoreParameters	Operational-Tier DataStore 的参数
BackupInstance	备份实例
BlobBackupDatasourceParameters	配置 blob 期间要使用的参数
CloudError	CloudError
CurrentProtectionState	指定资源的当前保护状态
Datasource	数据源
DatasourceSet	DatasourceSet
DataStoreTypes	数据存储的类型;作/保管库/存档
DefaultResourceProperties	默认源属性
Error	资源管理错误响应。
ErrorAdditionalInfo	资源管理错误附加信息。
IdentityDetails
InnerError	InnerError
KubernetesClusterBackupDatasourceParameters	Kubernetes 群集备份数据源的参数
NamespacedNameResource	NamespacedNameResource
OperationJobExtendedInfo	OperationJobExtendedInfo
PolicyInfo	PolicyInfo
PolicyParameters	策略中的参数
ProtectionStatusDetails	ProtectionStatusDetails
SecretStoreBasedAuthCredentials	基于机密存储的身份验证凭据。
SecretStoreResource	表示机密存储资源的类。
SecretStoreType	获取或设置机密存储的类型
Status	指定资源的保护状态
UserFacingError	有权访问本地化内容的层使用的 Error 对象，并将其传播到用户
ValidateForBackupRequest	ValidateForBackupRequest
ValidationType	指定验证的类型。对于 DeepValidation，/validateForBackup API 中的所有验证都将再次运行。

AKSVolumeTypes

Enumeration

获取或设置 include 卷类型属性。此属性设置备份期间要包含的卷类型。

值	说明
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Operational-Tier DataStore 的参数

名称	类型	说明
dataStoreType	DataStoreTypes	数据存储的类型;作/保管库/存档
objectType	string: AzureOperationalStoreParameters	特定对象的类型 - 用于反序列化
resourceGroupId	string	获取或设置快照资源组 URI。

BackupInstance

Object

备份实例

名称	类型	说明
currentProtectionState	CurrentProtectionState	指定资源的当前保护状态
dataSourceInfo	Datasource	数据源获取或设置数据源信息。
dataSourceSetInfo	DatasourceSet	DatasourceSet 获取或设置数据源集信息。
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	用于向数据源提供程序进行身份验证的凭据。
friendlyName	string	获取或设置备份实例友好名称。
identityDetails	IdentityDetails	包含 BI 的标识详细信息的信息。如果为 null，则默认值将被视为系统分配。
objectType	string
policyInfo	PolicyInfo	PolicyInfo 获取或设置策略信息。
protectionErrorDetails	UserFacingError	指定资源的保护错误
protectionStatus	ProtectionStatusDetails	ProtectionStatusDetails 指定资源的保护状态
provisioningState	string	指定资源的预配状态，即预配/更新/成功/失败
resourceGuardOperationRequests	string[]	将对其执行 LAC 检查的 ResourceGuardOperationRequests
validationType	ValidationType	指定验证的类型。对于 DeepValidation，/validateForBackup API 中的所有验证都将再次运行。

BlobBackupDatasourceParameters

Object

配置 blob 期间要使用的参数

名称	类型	说明
containersList	string[]	配置 blob 时要备份的容器列表
objectType	string: BlobBackupDatasourceParameters	特定对象的类型 - 用于反序列化

CloudError

Object

CloudError

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

CurrentProtectionState

Enumeration

指定资源的当前保护状态

值	说明
BackupSchedulesSuspended
ConfiguringProtection
ConfiguringProtectionFailed
Invalid
NotProtected
ProtectionConfigured
ProtectionError
ProtectionStopped
RetentionSchedulesSuspended
SoftDeleted
SoftDeleting
UpdatingProtection

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。

DataStoreTypes

Enumeration

数据存储的类型;作/保管库/存档

值	说明
ArchiveStore
OperationalStore
VaultStore

DefaultResourceProperties

Object

默认源属性

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

Error

Object

资源管理错误响应。

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

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

IdentityDetails

Object

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

InnerError

Object

InnerError

名称	类型	说明
additionalInfo	object	任何可提供给客户端的键值对，以获取其他详细信息。
code	string	此错误的唯一代码
embeddedInnerError	InnerError	InnerError 子内部错误，允许嵌套。

KubernetesClusterBackupDatasourceParameters

Object

Kubernetes 群集备份数据源的参数

名称	类型	说明
backupHookReferences	NamespacedNameResource[]	获取或设置备份挂钩引用。此属性设置在备份期间要执行的挂钩引用。
excludedNamespaces	string[]	获取或设置 exclude 命名空间属性。此属性设置在备份期间要排除的命名空间。
excludedResourceTypes	string[]	获取或设置排除资源类型属性。此属性设置在备份期间要排除的资源类型。
includeClusterScopeResources	boolean	获取或设置 include 群集资源属性。如果启用此属性，则会在备份期间包括群集范围资源。
includedNamespaces	string[]	获取或设置 include 命名空间属性。此属性设置在备份期间要包括的命名空间。
includedResourceTypes	string[]	获取或设置 include 资源类型属性。此属性设置在备份期间要包含的资源类型。
includedVolumeTypes	AKSVolumeTypes[]	获取或设置 include 卷类型属性。此属性设置备份期间要包含的卷类型。
labelSelectors	string[]	获取或设置 LabelSelectors 属性。此属性设置在备份期间要包含的此类标签选择器的资源。
objectType	string: KubernetesClusterBackupDatasourceParameters	特定对象的类型 - 用于反序列化
snapshotVolumes	boolean	获取或设置卷快照属性。如果启用此属性，则会在备份期间创建卷快照。

NamespacedNameResource

Object

NamespacedNameResource

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

OperationJobExtendedInfo

Object

OperationJobExtendedInfo

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

PolicyInfo

Object

PolicyInfo

名称	类型	说明
policyId	string
policyParameters	PolicyParameters	备份实例的策略参数
policyVersion	string

PolicyParameters

Object

策略中的参数

名称	类型	说明
backupDatasourceParametersList	BackupDatasourceParameters[]: BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	获取或设置备份数据源参数
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	获取或设置 DataStore 参数

ProtectionStatusDetails

Object

ProtectionStatusDetails

名称	类型	说明
errorDetails	UserFacingError	指定资源的保护状态错误
status	Status	指定资源的保护状态

SecretStoreBasedAuthCredentials

Object

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

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

SecretStoreResource

Object

表示机密存储资源的类。

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

SecretStoreType

Enumeration

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

值	说明
AzureKeyVault
Invalid

Status

Enumeration

指定资源的保护状态

值	说明
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Object

有权访问本地化内容的层使用的 Error 对象，并将其传播到用户

名称	类型	说明
code	string	此错误的唯一代码
details	UserFacingError[]	其他相关错误
innerError	InnerError	InnerError 内部错误
isRetryable	boolean	作是否可重试
isUserError	boolean	作是由用户错误还是服务错误导致的
message	string
properties	object	可在错误对象内注入的任何键值对
recommendedAction	string[]	RecommendedAction 本地化。
target	string	错误的目标。

ValidateForBackupRequest

Object

ValidateForBackupRequest

名称	类型	说明
backupInstance	BackupInstance	备份实例

ValidationType

Enumeration

指定验证的类型。对于 DeepValidation，/validateForBackup API 中的所有验证都将再次运行。

值	说明
DeepValidation
ShallowValidation

通过

Backup Instances - Validate For Backup

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Validate For Backup

示例请求

示例响应

定义

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BlobBackupDatasourceParameters

CloudError

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

OperationJobExtendedInfo

PolicyInfo

PolicyParameters

ProtectionStatusDetails

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

UserFacingError

ValidateForBackupRequest

ValidationType

其他资源