Backup Instances - Validate For Backup

服務:: Data Protection

API 版本:: 2025-09-01

驗證臨機作備份是否成功

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
vaultName	path	True	string	BackupVaultResource 的名稱
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
backupInstance	True	BackupInstance	備份實例

回應

名稱	類型	Description
200 OK	OperationJobExtendedInfo	Azure 作業已順利完成。
202 Accepted		已接受資源作業。標題 Azure-AsyncOperation: string Location: string
Other Status Codes	CloudError	未預期的錯誤回應。

名稱

類型

Description

200 OK

OperationJobExtendedInfo

Azure 作業已順利完成。

202 Accepted

已接受資源作業。

標題

Azure-AsyncOperation: string
Location: string

Other Status Codes

CloudError

未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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-09-01

{
  "backupInstance": {
    "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": ""
    },
    "datasourceAuthCredentials": {
      "objectType": "SecretStoreBasedAuthCredentials",
      "secretStoreResource": {
        "secretStoreType": "AzureKeyVault",
        "uri": "https://samplevault.vault.azure.net/secrets/credentials"
      }
    },
    "friendlyName": "harshitbi2",
    "identityDetails": {
      "useSystemAssignedIdentity": false,
      "userAssignedIdentityArmUrl": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourcegroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testUami"
    },
    "objectType": "BackupInstance",
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    }
  }
}

範例回覆

狀態碼:: 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/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2025-09-01
Retry-After: 60

定義

名稱	Description
AdlsBlobBackupDatasourceParameters	配置 Azure Data Lake Storage 帳戶 blob 備份期間要使用的參數
AKSVolumeTypes
AzureOperationalStoreParameters	Operational-Tier DataStore 的參數
BackupInstance	備份實例
BlobBackupDatasourceParameters	設定 Blob 時要使用的參數
CloudError	來自 Azure 備份的錯誤回應。
CurrentProtectionState	指定資源的目前保護狀態
Datasource	要備份的數據源
DatasourceSet	要備份之數據源的DatasourceSet詳細數據
DataStoreTypes	數據存放區的類型;Operational/Vault/Archive
DefaultResourceProperties	預設來源屬性
Error	資源管理錯誤回應。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
IdentityDetails
InnerError	內部錯誤
KubernetesClusterBackupDatasourceParameters	Kubernetes 叢集備份數據源的參數
NamespacedNameResource	參考包含命名空間和名稱之資源的類別
OperationJobExtendedInfo	作業作業擴充資訊
PolicyInfo	backupInstance 中的原則資訊
PolicyParameters	原則中的參數
ProtectionStatusDetails	保護狀態詳細數據
ResourcePropertiesObjectType	特定物件的類型 - 用於還原串行化
SecretStoreBasedAuthCredentials	秘密存放區型驗證認證。
SecretStoreResource	代表秘密存放區資源的類別。
SecretStoreType	取得或設定秘密存放區的類型
Status	指定資源的保護狀態
UserFacingError	可存取當地語系化內容的圖層所使用的錯誤物件，並將該對象傳播給使用者
ValidateForBackupRequest	驗證備份要求
ValidationType	指定驗證的類型。如果是 DeepValidation，來自 /validateForBackup API 的所有驗證都會再次執行。

AdlsBlobBackupDatasourceParameters

Object

配置 Azure Data Lake Storage 帳戶 blob 備份期間要使用的參數

名稱	類型	Description
containersList	string[]	設定 Blob 備份期間要備份的容器清單
objectType	string: AdlsBlobBackupDatasourceParameters	特定物件的類型 - 用於還原串行化

AKSVolumeTypes

列舉型別

值	Description
AzureDisk
AzureFileShareSMB

AzureOperationalStoreParameters

Object

Operational-Tier DataStore 的參數

名稱	類型	Description
dataStoreType	DataStoreTypes	數據存放區的類型;Operational/Vault/Archive
objectType	string: AzureOperationalStoreParameters	特定物件的類型 - 用於還原串行化
resourceGroupId	string	取得或設定快照集資源群組 URI。

BackupInstance

Object

備份實例

名稱	類型	Description
currentProtectionState	CurrentProtectionState	指定資源的目前保護狀態
dataSourceInfo	Datasource	取得或設定數據源資訊。
dataSourceSetInfo	DatasourceSet	取得或設定數據源集資訊。
datasourceAuthCredentials	AuthCredentials: SecretStoreBasedAuthCredentials	用來向數據源提供者進行驗證的認證。
friendlyName	string	取得或設定備份實例易記名稱。
identityDetails	IdentityDetails	包含 BI 的身分識別詳細數據資訊。如果它是 Null，預設值會被視為系統指派。
objectType	string
policyInfo	PolicyInfo	取得或設定原則資訊。
protectionErrorDetails	UserFacingError	指定資源的保護錯誤
protectionStatus	ProtectionStatusDetails	指定資源的保護狀態
provisioningState	string	指定資源的布建狀態，也就是布建/更新/成功/失敗
resourceGuardOperationRequests	string[]	將執行 LAC 檢查的 ResourceGuardOperationRequests
validationType	ValidationType	指定驗證的類型。如果是 DeepValidation，來自 /validateForBackup API 的所有驗證都會再次執行。

BlobBackupDatasourceParameters

Object

設定 Blob 時要使用的參數

名稱	類型	Description
containersList	string[]	設定 Blob 備份期間要備份的容器清單
objectType	string: BlobBackupDatasourceParameters	特定物件的類型 - 用於還原串行化

CloudError

Object

來自 Azure 備份的錯誤回應。

名稱	類型	Description
error	Error	資源管理錯誤回應。

CurrentProtectionState

列舉型別

指定資源的目前保護狀態

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

Datasource

Object

要備份的數據源

名稱	類型	Description
datasourceType	string	資源的 DatasourceType。
objectType	string	Datasource 物件的類型，用來初始化正確的繼承類型
resourceID	string	資源的完整 ARM 識別碼。針對 Azure 資源，這是 ARM 識別碼。針對非 Azure 資源，這會是透過 Fabric/Vault 備份服務所建立的標識符。
resourceLocation	string	數據源的位置。
resourceName	string	父系內容中資源的唯一標識符。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	數據源特有的屬性
resourceType	string	數據源的資源類型。
resourceUri	string	資源的 URI。

DatasourceSet

Object

要備份之數據源的DatasourceSet詳細數據

名稱	類型	Description
datasourceType	string	資源的 DatasourceType。
objectType	string	Datasource 物件的類型，用來初始化正確的繼承類型
resourceID	string	資源的完整 ARM 識別碼。針對 Azure 資源，這是 ARM 識別碼。針對非 Azure 資源，這會是透過 Fabric/Vault 備份服務所建立的標識符。
resourceLocation	string	數據源的位置。
resourceName	string	父系內容中資源的唯一標識符。
resourceProperties	BaseResourceProperties: DefaultResourceProperties	數據源集特有的屬性
resourceType	string	數據源的資源類型。
resourceUri	string	資源的 URI。

DataStoreTypes

列舉型別

數據存放區的類型;Operational/Vault/Archive

值	Description
OperationalStore
VaultStore
ArchiveStore

DefaultResourceProperties

Object

預設來源屬性

名稱	類型	Description
objectType	string: DefaultResourceProperties	特定物件的類型 - 用於還原串行化

Error

Object

資源管理錯誤回應。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	Error[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

IdentityDetails

Object

名稱	類型	Description
useSystemAssignedIdentity	boolean	指定 BI 是否受到系統識別的保護。
userAssignedIdentityArmUrl	string	使用者指派身分識別的ARM URL。

InnerError

Object

內部錯誤

名稱	類型	Description
additionalInfo	object	任何可提供給用戶端的索引鍵值組，以取得其他詳細資訊資訊。
code	string	此錯誤的唯一程序代碼
embeddedInnerError	InnerError	子內部錯誤，允許巢狀。

KubernetesClusterBackupDatasourceParameters

Object

Kubernetes 叢集備份數據源的參數

名稱	類型	Description
backupHookReferences	NamespacedNameResource[]	取得或設定備份勾點參考。這個屬性會設定在備份期間要執行的攔截參考。
excludedNamespaces	string[]	取得或設定 exclude 命名空間屬性。這個屬性會設定在備份期間要排除的命名空間。
excludedResourceTypes	string[]	取得或設定排除資源類型屬性。這個屬性會設定備份期間要排除的資源類型。
includeClusterScopeResources	boolean	取得或設定 include cluster resources 屬性。如果已啟用，此屬性將會在備份期間包含叢集範圍資源。
includedNamespaces	string[]	取得或設定 include 命名空間屬性。這個屬性會設定在備份期間要包含的命名空間。
includedResourceTypes	string[]	取得或設定 include 資源類型屬性。這個屬性會設定備份期間要包含的資源類型。
includedVolumeTypes	AKSVolumeTypes[]	取得或設定 include 磁碟區類型屬性。這個屬性會設定備份期間要包含的磁碟區類型。
labelSelectors	string[]	取得或設定 LabelSelectors 屬性。這個屬性會將資源設定為備份期間要包含的這類標籤選取器。
objectType	string: KubernetesClusterBackupDatasourceParameters	特定物件的類型 - 用於還原串行化
snapshotVolumes	boolean	取得或設定磁碟區快照集屬性。如果已啟用，此屬性會在備份期間擷取磁碟區快照集。

NamespacedNameResource

Object

參考包含命名空間和名稱之資源的類別

名稱	類型	Description
name	string	資源名稱
namespace	string	資源所在的命名空間

OperationJobExtendedInfo

Object

作業作業擴充資訊

名稱	類型	Description
jobId	string	為這項作業建立之作業的名稱或 Arm 識別碼。
objectType	string: OperationJobExtendedInfo	這個屬性將做為決定型別多型鏈結中特定類型的歧視性。

PolicyInfo

Object

backupInstance 中的原則資訊

名稱	類型	Description
policyId	string
policyParameters	PolicyParameters	備份實例的原則參數
policyVersion	string

PolicyParameters

Object

原則中的參數

名稱	類型	Description
backupDatasourceParametersList	BackupDatasourceParameters[]: AdlsBlobBackupDatasourceParameters[] BlobBackupDatasourceParameters[] KubernetesClusterBackupDatasourceParameters[]	取得或設定備份數據源參數
dataStoreParametersList	DataStoreParameters[]: AzureOperationalStoreParameters[]	取得或設定 DataStore 參數

ProtectionStatusDetails

Object

保護狀態詳細數據

名稱	類型	Description
errorDetails	UserFacingError	指定資源的保護狀態錯誤
status	Status	指定資源的保護狀態

ResourcePropertiesObjectType

列舉型別

特定物件的類型 - 用於還原串行化

值	Description
DefaultResourceProperties

SecretStoreBasedAuthCredentials

Object

秘密存放區型驗證認證。

名稱	類型	Description
objectType	string: SecretStoreBasedAuthCredentials	特定物件的類型 - 用於還原串行化
secretStoreResource	SecretStoreResource	秘密存放區資源

SecretStoreResource

Object

代表秘密存放區資源的類別。

名稱	類型	Description
secretStoreType	SecretStoreType	取得或設定秘密存放區的類型
uri	string	要取得資源的 URI
value	string	取得或設定儲存在秘密存放區資源中的值

SecretStoreType

列舉型別

取得或設定秘密存放區的類型

值	Description
Invalid
AzureKeyVault

Status

列舉型別

指定資源的保護狀態

值	Description
ConfiguringProtection
ConfiguringProtectionFailed
ProtectionConfigured
ProtectionStopped
SoftDeleted
SoftDeleting

UserFacingError

Object

可存取當地語系化內容的圖層所使用的錯誤物件，並將該對象傳播給使用者

名稱	類型	Description
code	string	此錯誤的唯一程序代碼
details	UserFacingError[]	其他相關錯誤
innerError	InnerError	內部錯誤
isRetryable	boolean	作業是否可重試
isUserError	boolean	作業是否因為使用者錯誤或服務錯誤所造成
message	string
properties	object	可在錯誤物件內插入的任何索引鍵值組
recommendedAction	string[]	RecommendedAction 已當地語系化。
target	string	錯誤的目標。

ValidateForBackupRequest

Object

驗證備份要求

名稱	類型	Description
backupInstance	BackupInstance	備份實例

ValidationType

列舉型別

指定驗證的類型。如果是 DeepValidation，來自 /validateForBackup API 的所有驗證都會再次執行。

值	Description
ShallowValidation
DeepValidation

共用方式為

Backup Instances - Validate For Backup

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Validate For Backup

範例要求

範例回覆

定義

AdlsBlobBackupDatasourceParameters

AKSVolumeTypes

AzureOperationalStoreParameters

BackupInstance

BlobBackupDatasourceParameters

CloudError

CurrentProtectionState

Datasource

DatasourceSet

DataStoreTypes

DefaultResourceProperties

Error

ErrorAdditionalInfo

IdentityDetails

InnerError

KubernetesClusterBackupDatasourceParameters

NamespacedNameResource

OperationJobExtendedInfo

PolicyInfo

PolicyParameters

ProtectionStatusDetails

ResourcePropertiesObjectType

SecretStoreBasedAuthCredentials

SecretStoreResource

SecretStoreType

Status

UserFacingError

ValidateForBackupRequest

ValidationType