Backup Protectable Items - List

參考

服務:: Recovery Services - Backup

API 版本:: 2024-10-01

根據查詢篩選和分頁參數，提供訂用帳戶內可保護物件的可分頁清單。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01

含選擇性參數:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01&$filter={$filter}&$skipToken={$skipToken}

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	復原服務保存庫所在的資源群組名稱。
subscriptionId	path	True	string	訂用帳戶標識碼。
vaultName	path	True	string	復原服務保存庫的名稱。
api-version	query	True	string	用戶端 API 版本。
$filter	query		string	OData 篩選選項。
$skipToken	query		string	skipToken 篩選條件。

回應

名稱	類型	Description
200 OK	WorkloadProtectableItemResourceList	還行
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	模擬您的用戶帳戶。

範例

List protectable items with backupManagementType filter as AzureIaasVm

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupProtectableItems?api-version=2024-10-01&$filter=backupManagementType eq 'AzureIaasVM'

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectableItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectableItems",
      "properties": {
        "friendlyName": "iaasvm-1",
        "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
        "protectionState": "NotProtected",
        "protectableItemType": "Microsoft.ClassicCompute/virtualMachines",
        "backupManagementType": "AzureIaasVM",
        "workloadType": "VM"
      }
    }
  ]
}

定義

名稱	Description
AzureFileShareProtectableItem	Azure Fileshare 工作負載的可保護專案。
AzureFileShareType	檔案共享類型 XSync 或 XSMB。
AzureIaaSClassicComputeVMProtectableItem	代表傳統計算 VM 的 IaaS VM 工作負載特定備份專案。
AzureIaaSComputeVMProtectableItem	代表 Azure Resource Manager VM 的 IaaS VM 工作負載特定備份專案。
AzureVmWorkloadProtectableItem	Azure VM 工作負載特定的可保護專案。
AzureVmWorkloadSAPAseSystemProtectableItem	代表 SAP ASE 系統的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSAPHanaDatabaseProtectableItem	代表 SAP HANA 資料庫的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSAPHanaDBInstance	代表 SAP HANA Dbinstance 的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSAPHanaHSRProtectableItem	代表 HANA HSR 的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSAPHanaSystemProtectableItem	代表 SAP HANA 系統的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSQLAvailabilityGroupProtectableItem	代表 SQL 可用性群組的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSQLDatabaseProtectableItem	代表 SQL Database 的 Azure VM 工作負載特定可保護專案。
AzureVmWorkloadSQLInstanceProtectableItem	代表 SQL 實例的 Azure VM 工作負載特定可保護專案。
CloudError	來自容器實例服務的錯誤回應。
CloudErrorBody	來自容器實例服務的錯誤回應。
DistributedNodesInfo	這是用來代表分散式容器的各種節點。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	封裝程式代碼、訊息和建議的錯誤詳細數據類別。
IaaSVMProtectableItem	IaaS VM 工作負載特定的備份專案。
InquiryStatus	可保護項目的狀態，例如 InProgress、Succeeded、Failed
PreBackupValidation	Azure VM 工作負載提供者的預先備份驗證。
ProtectionStatus	備份項目的狀態。
WorkloadProtectableItemResource	備份專案的基類。工作負載特定的備份專案衍生自這個類別。
WorkloadProtectableItemResourceList	WorkloadProtectableItem 資源清單

AzureFileShareProtectableItem

Azure Fileshare 工作負載的可保護專案。

名稱	類型	Description
azureFileShareType	AzureFileShareType	檔案共享類型 XSync 或 XSMB。
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
parentContainerFabricId	string	此可保護專案所屬容器的完整網狀架構標識碼。例如，ARM 標識碼。
parentContainerFriendlyName	string	這個可保護專案所屬的容器易記名稱。
protectableItemType	string: AzureFileShare	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
workloadType	string	備份管理的工作負載類型

AzureFileShareType

檔案共享類型 XSync 或 XSMB。

名稱	類型	Description
Invalid	string
XSMB	string
XSync	string

AzureIaaSClassicComputeVMProtectableItem

代表傳統計算 VM 的 IaaS VM 工作負載特定備份專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
protectableItemType	string: Microsoft.ClassicCompute/virtualMachines	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
resourceGroup	string	復原服務保存庫的資源組名。
virtualMachineId	string	虛擬機的完整ARM標識碼。
virtualMachineVersion	string	指定容器代表傳統或 Azure Resource Manager VM。
workloadType	string	備份管理的工作負載類型

AzureIaaSComputeVMProtectableItem

代表 Azure Resource Manager VM 的 IaaS VM 工作負載特定備份專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
protectableItemType	string: Microsoft.Compute/virtualMachines	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
resourceGroup	string	復原服務保存庫的資源組名。
virtualMachineId	string	虛擬機的完整ARM標識碼。
virtualMachineVersion	string	指定容器代表傳統或 Azure Resource Manager VM。
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadProtectableItem

Azure VM 工作負載特定的可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: AzureVmWorkloadProtectableItem	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSAPAseSystemProtectableItem

代表 SAP ASE 系統的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SAPAseSystem	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSAPHanaDatabaseProtectableItem

代表 SAP HANA 資料庫的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SAPHanaDatabase	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSAPHanaDBInstance

代表 SAP HANA Dbinstance 的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SAPHanaDBInstance	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSAPHanaHSRProtectableItem

代表 HANA HSR 的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: HanaHSRContainer	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSAPHanaSystemProtectableItem

代表 SAP HANA 系統的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SAPHanaSystem	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

代表 SQL 可用性群組的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
nodesList	DistributedNodesInfo[]	分散式容器時節點的清單。
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SQLAvailabilityGroupContainer	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSQLDatabaseProtectableItem

代表 SQL Database 的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SQLDataBase	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

AzureVmWorkloadSQLInstanceProtectableItem

代表 SQL 實例的 Azure VM 工作負載特定可保護專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
isAutoProtectable	boolean	指出可保護的專案是否可自動保護
isAutoProtected	boolean	指出可保護的專案是否自動受到保護
isProtectable	boolean	指出專案是否可保護
parentName	string	實例或 AG 的名稱
parentUniqueName	string	已新增父唯一名稱，以提供服務格式化的父系 URI 名稱，僅適用於父系為 Instance 或 SQL AG 的數據基底。
prebackupvalidation	PreBackupValidation	可保護物件的預先備份驗證
protectableItemType	string: SQLInstance	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
serverName	string	實例或 AG 的主機/叢集名稱
subinquireditemcount	integer	例如或 AG，表示 DB 存在的數目
subprotectableitemcount	integer	例如或 AG，表示要保護的資料庫數目
workloadType	string	備份管理的工作負載類型

CloudError

來自容器實例服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	error 物件。

CloudErrorBody

來自容器實例服務的錯誤回應。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤的識別碼。程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。例如，錯誤中的屬性名稱。

DistributedNodesInfo

這是用來代表分散式容器的各種節點。

名稱	類型	Description
errorDetail	ErrorDetail	如果狀態為非成功，則錯誤詳細數據。
nodeName	string	分散式容器下節點的名稱。
sourceResourceId	string	節點的 ARM 資源識別碼
status	string	此節點的狀態。失敗 \|成功

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

封裝程式代碼、訊息和建議的錯誤詳細數據類別。

名稱	類型	Description
code	string	錯誤碼。
message	string	與程式代碼相關的錯誤訊息。
recommendations	string[]	建議字串清單。

IaaSVMProtectableItem

IaaS VM 工作負載特定的備份專案。

名稱	類型	Description
backupManagementType	string	要備份項目的備份管理類型。
friendlyName	string	備份專案的易記名稱。
protectableItemType	string: IaaSVMProtectableItem	備份項目的類型。
protectionState	ProtectionStatus	備份項目的狀態。
resourceGroup	string	復原服務保存庫的資源組名。
virtualMachineId	string	虛擬機的完整ARM標識碼。
virtualMachineVersion	string	指定容器代表傳統或 Azure Resource Manager VM。
workloadType	string	備份管理的工作負載類型

InquiryStatus

可保護項目的狀態，例如 InProgress、Succeeded、Failed

名稱	類型	Description
Failed	string
Invalid	string
Success	string

PreBackupValidation

Azure VM 工作負載提供者的預先備份驗證。

名稱	類型	Description
code	string	可保護項目的錯誤碼
message	string	對應至可保護專案之錯誤碼的訊息
status	InquiryStatus	可保護項目的狀態，例如 InProgress、Succeeded、Failed

ProtectionStatus

備份項目的狀態。

名稱	類型	Description
Invalid	string
NotProtected	string
Protected	string
Protecting	string
ProtectionFailed	string

WorkloadProtectableItemResource

備份專案的基類。工作負載特定的備份專案衍生自這個類別。

名稱	類型	Description
eTag	string	選擇性 ETag。
id	string	資源標識子代表資源的完整路徑。
location	string	資源位置。
name	string	與資源相關聯的資源名稱。
properties	WorkloadProtectableItem: AzureFileShareProtectableItem AzureIaaSClassicComputeVMProtectableItem AzureIaaSComputeVMProtectableItem AzureVmWorkloadProtectableItem AzureVmWorkloadSAPAseSystemProtectableItem AzureVmWorkloadSAPHanaDBInstance AzureVmWorkloadSAPHanaDatabaseProtectableItem AzureVmWorkloadSAPHanaHSRProtectableItem AzureVmWorkloadSAPHanaSystemProtectableItem AzureVmWorkloadSQLAvailabilityGroupProtectableItem AzureVmWorkloadSQLDatabaseProtectableItem AzureVmWorkloadSQLInstanceProtectableItem IaaSVMProtectableItem	WorkloadProtectableItemResource 屬性
tags	object	資源標籤。
type	string	資源類型代表命名空間/ResourceType/ResourceType/... 格式的完整路徑。

WorkloadProtectableItemResourceList

WorkloadProtectableItem 資源清單

名稱	類型	Description
nextLink	string	要擷取下一頁資源的 URI。呼叫 ListNext（）會擷取下一頁的資源。
value	WorkloadProtectableItemResource[]	資源清單。

共用方式為