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 參數

名稱	位於	必要	類型	Description
backupInstanceName	path	True	string	BackupInstanceResource 的名稱
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 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 版本。

要求標頭

名稱	必要	類型	Description
x-ms-authorization-auxiliary		string

要求本文

要求主體可以是下列其中一項：

名稱	Description
AzureBackupRecoveryPointBasedRestoreRequest	Azure 備份復原Point 型還原要求
AzureBackupRecoveryTimeBasedRestoreRequest	AzureBackup RecoveryPointTime 型還原要求
AzureBackupRestoreWithRehydrationRequest	使用解除凍結要求還原 AzureBackup

AzureBackupRecoveryPointBasedRestoreRequest

Azure 備份復原Point 型還原要求

名稱	必要	類型	Description
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 Resource Manager 標識符。

AzureBackupRecoveryTimeBasedRestoreRequest

AzureBackup RecoveryPointTime 型還原要求

名稱	必要	類型	Description
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 Resource Manager 標識符。

AzureBackupRestoreWithRehydrationRequest

使用解除凍結要求還原 AzureBackup

名稱	必要	類型	Description
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 Resource Manager 標識符。

回應

名稱	類型	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	模擬您的用戶帳戶

範例

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

定義

名稱	Description
AzureBackupRecoveryPointBasedRestoreRequest	Azure 備份復原Point 型還原要求
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 備份復原Point 型還原要求

名稱	類型	Description
identityDetails	IdentityDetails	包含 BI 的身分識別詳細數據資訊。如果它是 Null，預設值會被視為系統指派。
objectType	string: AzureBackupRecoveryPointBasedRestoreRequest
recoveryPointId	string
resourceGuardOperationRequests	string[]	將執行 LAC 檢查的 ResourceGuardOperationRequests
restoreTargetInfo	RestoreTargetInfoBase: ItemLevelRestoreTargetInfo RestoreFilesTargetInfo RestoreTargetInfo	取得或設定還原目標資訊。
sourceDataStoreType	SourceDataStoreType	取得或設定源數據存放區的型別。
sourceResourceId	string	正在復原之數據源的完整 Azure Resource Manager 標識符。

AzureBackupRecoveryTimeBasedRestoreRequest

Object

AzureBackup RecoveryPointTime 型還原要求

名稱	類型	Description
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 Resource Manager 標識符。

AzureBackupRestoreWithRehydrationRequest

Object

使用解除凍結要求還原 AzureBackup

名稱	類型	Description
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 Resource Manager 標識符。

CloudError

Object

來自 Azure 備份的錯誤回應。

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

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。

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	其他信息類型。

ExistingResourcePolicy

列舉型別

取得或設定衝突原則屬性。此屬性會在還原期間設定資源衝突期間的原則。

值	Description
Skip
Patch

IdentityDetails

Object

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

ItemLevelRestoreTargetInfo

Object

專案層級還原作業的還原目標資訊

名稱	類型	Description
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

還原期間要使用的前置詞準則

名稱	類型	Description
isPathRelativeToBackupItem	boolean	旗標，指定路徑是否相對於備份專案或完整路徑
itemPath	string	要還原之項目的路徑。它可以是專案的完整路徑或相對於備份項目的路徑
objectType	string: ItemPathBasedRestoreCriteria	特定物件的類型 - 用於還原串行化
renameTo	string	重命名要還原的專案。如果指定了值，則 Restore 會將 itemPath 重命名為此新名稱，否則 itemPath 將恢復為相同的名稱。
subItemPathPrefix	string[]	在還原期間做為篩選準則的前置詞字串清單。這些是相對於指定的項目路徑。

KubernetesClusterRestoreCriteria

Object

適用於還原作業的 kubernetes 叢集備份目標資訊

名稱	類型	Description
conflictPolicy	ExistingResourcePolicy	取得或設定衝突原則屬性。此屬性會在還原期間設定資源衝突期間的原則。
excludedNamespaces	string[]	取得或設定 exclude 命名空間屬性。這個屬性會設定還原期間要排除的命名空間。
excludedResourceTypes	string[]	取得或設定排除資源類型屬性。這個屬性會設定在還原期間要排除的資源類型。
includeClusterScopeResources	boolean	取得或設定 include cluster resources 屬性。如果啟用，這個屬性會在還原期間包含叢集範圍資源。
includedNamespaces	string[]	取得或設定 include 命名空間屬性。這個屬性會設定還原期間要包含的命名空間。
includedResourceTypes	string[]	取得或設定 include 資源類型屬性。這個屬性會設定還原期間要包含的資源類型。
labelSelectors	string[]	取得或設定 LabelSelectors 屬性。此屬性會將資源設定為還原期間要包含的這類標籤選取器。
namespaceMappings	object	取得或設定命名空間對應屬性。此屬性會設定命名空間是否需要在還原期間變更。
objectType	string: KubernetesClusterRestoreCriteria	特定物件的類型 - 用於還原串行化
persistentVolumeRestoreMode	PersistentVolumeRestoreMode	取得或設定 PV （永續性磁碟區）還原模式屬性。這個屬性會設定磁碟區是否需要還原。
resourceModifierReference	NamespacedNameResource	取得或設定資源修飾詞參考。此屬性會在還原期間設定資源修飾詞的參考。
restoreHookReferences	NamespacedNameResource[]	取得或設定還原勾點參考。這個屬性會設定在還原期間要執行的勾點參考。

KubernetesClusterVaultTierRestoreCriteria

Object

從保存庫還原作業的 kubernetes 叢集備份目標資訊

名稱	類型	Description
conflictPolicy	ExistingResourcePolicy	取得或設定衝突原則屬性。此屬性會在從保存庫還原期間的資源衝突期間設定原則。
excludedNamespaces	string[]	取得或設定 exclude 命名空間屬性。這個屬性會設定從保存庫還原期間要排除的命名空間。
excludedResourceTypes	string[]	取得或設定排除資源類型屬性。這個屬性會設定從保存庫還原期間要排除的資源類型。
includeClusterScopeResources	boolean	取得或設定 include cluster resources 屬性。如果已啟用，此屬性會在從保存庫還原期間包含叢集範圍資源。
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 識別符，以在從保存庫還原期間建立暫存磁碟和快照集。
stagingStorageAccountId	string (arm-id)	取得或設定預備記憶體帳戶標識碼，以在從保存庫還原期間建立備份擴充功能物件存放區數據。

KubernetesPVRestoreCriteria

Object

還原作業的專案層級 kubernetes 永續性磁碟區目標資訊

名稱	類型	Description
name	string	選取的永續性磁碟區宣告名稱
objectType	string: KubernetesPVRestoreCriteria	特定物件的類型 - 用於還原串行化
storageClassName	string	用於還原作業的選取記憶體類別名稱

KubernetesStorageClassRestoreCriteria

Object

還原作業的專案層級 kubernetes 記憶體類別目標資訊

名稱	類型	Description
objectType	string: KubernetesStorageClassRestoreCriteria	特定物件的類型 - 用於還原串行化
provisioner	string	記憶體類別的布建器
selectedStorageClassName	string	選取的記憶體類別名稱

NamespacedNameResource

Object

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

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

OperationJobExtendedInfo

Object

作業作業擴充資訊

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

PersistentVolumeRestoreMode

列舉型別

取得或設定 PV （永續性磁碟區）還原模式屬性。這個屬性會設定磁碟區是否需要還原。

值	Description
RestoreWithVolumeData
RestoreWithoutVolumeData

RangeBasedItemLevelRestoreCriteria

Object

還原作業的專案層級目標資訊

名稱	類型	Description
maxMatchingValue	string	範圍前置詞比對的最大值
minMatchingValue	string	範圍前置詞比對的最小值
objectType	string: RangeBasedItemLevelRestoreCriteria	特定物件的類型 - 用於還原串行化

RecoveryOption

列舉型別

復原選項

值	Description
FailIfExists

RehydrationPriority

列舉型別

用於解除凍結的優先順序。值高或標準

值	Description
Invalid
High
Standard

ResourcePropertiesObjectType

列舉型別

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

值	Description
DefaultResourceProperties

RestoreFilesTargetInfo

Object

將還原封裝為檔案目標參數的類別

名稱	類型	Description
objectType	string: RestoreFilesTargetInfo	Datasource 物件的類型，用來初始化正確的繼承類型
recoveryOption	RecoveryOption	復原選項
restoreLocation	string	目標還原區域
targetDetails	TargetDetails	當目的地不是數據源時，RestoreAsFiles 作業的目的地

RestoreTargetInfo

Object

封裝還原目標參數的類別

名稱	類型	Description
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} 的字符串值

值	Description
Invalid
AzureBlobs
AzureFiles

SecretStoreBasedAuthCredentials

Object

秘密存放區型驗證認證。

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

SecretStoreResource

Object

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

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

SecretStoreType

列舉型別

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

值	Description
Invalid
AzureKeyVault

SourceDataStoreType

列舉型別

取得或設定源數據存放區的型別。

值	Description
ArchiveStore
SnapshotStore
OperationalStore
VaultStore

TargetDetails

Object

類別封裝目標詳細數據，用於目的地不是數據源

名稱	類型	Description
filePrefix	string	還原作業可能會在 Url 下方所指向的位置內建立多個檔案，將會是其中所有檔案的通用前置詞
restoreTargetLocationType	RestoreTargetLocationType	表示將還原數據的目標位置、列舉 {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType} 的字符串值
targetResourceArmId	string	表示還原目的地的完整 ARM 識別碼。這是指向容器/檔案共用的 ARM 識別碼。如果目標訂用帳戶可以使用 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