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

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 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	恢复服务保管库所在的资源组的名称。
subscriptionId	path	True	string	订阅 ID。
vaultName	path	True	string	恢复服务保管库的名称。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	OData 筛选器选项。
$skipToken	query		string	skipToken 筛选器。

响应

名称	类型	说明
200 OK	WorkloadProtectableItemResourceList	还行
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
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"
      }
    }
  ]
}

定义

名称	说明
AzureFileShareProtectableItem	Azure 文件共享工作负载的可保护项。
AzureFileShareType	文件共享类型 XSync 或 XSMB。
AzureIaaSClassicComputeVMProtectableItem	代表经典计算 VM 的 IaaS VM 特定于工作负荷的备份项。
AzureIaaSComputeVMProtectableItem	代表 Azure 资源管理器 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 数据库的特定于 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

Object

Azure 文件共享工作负载的可保护项。

名称	类型	说明
azureFileShareType	AzureFileShareType	文件共享类型 XSync 或 XSMB。
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
parentContainerFabricId	string	此可保护项所属的容器的完整构造 ID。例如，ARM ID。
parentContainerFriendlyName	string	此可保护项所属的容器的友好名称。
protectableItemType	string: AzureFileShare	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
workloadType	string	备份管理的工作负荷类型

AzureFileShareType

枚举

文件共享类型 XSync 或 XSMB。

值	说明
Invalid
XSMB
XSync

AzureIaaSClassicComputeVMProtectableItem

Object

代表经典计算 VM 的 IaaS VM 特定于工作负荷的备份项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
protectableItemType	string: Microsoft.ClassicCompute/virtualMachines	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
resourceGroup	string	恢复服务保管库的资源组名称。
virtualMachineId	string	虚拟机的完全限定 ARM ID。
virtualMachineVersion	string	指定容器是表示经典 VM 还是 Azure 资源管理器 VM。
workloadType	string	备份管理的工作负荷类型

AzureIaaSComputeVMProtectableItem

Object

代表 Azure 资源管理器 VM 的 IaaS VM 特定于工作负荷的备份项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
protectableItemType	string: Microsoft.Compute/virtualMachines	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
resourceGroup	string	恢复服务保管库的资源组名称。
virtualMachineId	string	虚拟机的完全限定 ARM ID。
virtualMachineVersion	string	指定容器是表示经典 VM 还是 Azure 资源管理器 VM。
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadProtectableItem

Object

特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: AzureVmWorkloadProtectableItem	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSAPAseSystemProtectableItem

Object

表示 SAP ASE 系统的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SAPAseSystem	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSAPHanaDatabaseProtectableItem

Object

表示 SAP HANA 数据库的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SAPHanaDatabase	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSAPHanaDBInstance

Object

表示 SAP HANA Dbinstance 的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SAPHanaDBInstance	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSAPHanaHSRProtectableItem

Object

表示 HANA HSR 的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: HanaHSRContainer	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSAPHanaSystemProtectableItem

Object

表示 SAP HANA 系统的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SAPHanaSystem	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

Object

表示 SQL 可用性组的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
nodesList	DistributedNodesInfo[]	分布式容器时节点的列表。
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SQLAvailabilityGroupContainer	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSQLDatabaseProtectableItem

Object

表示 SQL 数据库的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SQLDataBase	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

AzureVmWorkloadSQLInstanceProtectableItem

Object

表示 SQL 实例的特定于 Azure VM 工作负荷的可保护项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
isAutoProtectable	boolean	指示可保护项是否可自动保护
isAutoProtected	boolean	指示可保护项是否自动保护
isProtectable	boolean	指示项是否可保护
parentName	string	实例或 AG 的名称
parentUniqueName	string	添加了父唯一名称，以提供父级的格式化 URI 名称，该名称仅适用于父数据库（即实例或 SQL AG）。
prebackupvalidation	PreBackupValidation	可保护对象的预备份验证
protectableItemType	string: SQLInstance	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
serverName	string	实例或 AG 的主机/群集名称
subinquireditemcount	integer	例如或 AG，指示 DB 存在的数量
subprotectableitemcount	integer	例如或 AG，指示要保护的 DB 数
workloadType	string	备份管理的工作负荷类型

CloudError

Object

容器实例服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误对象。

CloudErrorBody

Object

容器实例服务的错误响应。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

DistributedNodesInfo

Object

这用于表示分布式容器的各个节点。

名称	类型	说明
errorDetail	ErrorDetail	错误详细信息（如果状态为非成功）。
nodeName	string	分布式容器下节点的名称。
sourceResourceId	string	节点的 ARM 资源 ID
status	string	此节点的状态。失败 \|成功

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

封装代码、消息和建议的错误详细信息类。

名称	类型	说明
code	string	错误代码。
message	string	与代码相关的错误消息。
recommendations	string[]	建议字符串列表。

IaaSVMProtectableItem

Object

特定于 IaaS VM 工作负荷的备份项。

名称	类型	说明
backupManagementType	string	用于备份项的备份管理类型。
friendlyName	string	备份项的友好名称。
protectableItemType	string: IaaSVMProtectableItem	备份项的类型。
protectionState	ProtectionStatus	备份项的状态。
resourceGroup	string	恢复服务保管库的资源组名称。
virtualMachineId	string	虚拟机的完全限定 ARM ID。
virtualMachineVersion	string	指定容器是表示经典 VM 还是 Azure 资源管理器 VM。
workloadType	string	备份管理的工作负荷类型

InquiryStatus

枚举

可保护项的状态，即 InProgress、Succeeded、Failed

值	说明
Failed
Invalid
Success

PreBackupValidation

Object

Azure VM 工作负荷提供程序的备份前验证。

名称	类型	说明
code	string	可保护项的错误代码
message	string	与可保护项的错误代码对应的消息
status	InquiryStatus	可保护项的状态，即 InProgress、Succeeded、Failed

ProtectionStatus

枚举

备份项的状态。

值	说明
Invalid
NotProtected
Protected
Protecting
ProtectionFailed

WorkloadProtectableItemResource

Object

备份项的基类。特定于工作负荷的备份项派生自此类。

名称	类型	说明
eTag	string	可选 ETag。
id	string	资源 ID 表示资源的完整路径。
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

Object

WorkloadProtectableItem 资源列表

名称	类型	说明
nextLink	string	用于提取下一页资源的 URI。调用 ListNext（）提取下一页的资源。
value	WorkloadProtectableItemResource[]	资源列表。

通过

Backup Protectable Items - List

URI 参数

响应

安全性

azure_auth

作用域

示例

List protectable items with backupManagementType filter as AzureIaasVm

示例请求

示例响应

定义

AzureFileShareProtectableItem

AzureFileShareType

AzureIaaSClassicComputeVMProtectableItem

AzureIaaSComputeVMProtectableItem

AzureVmWorkloadProtectableItem

AzureVmWorkloadSAPAseSystemProtectableItem

AzureVmWorkloadSAPHanaDatabaseProtectableItem

AzureVmWorkloadSAPHanaDBInstance

AzureVmWorkloadSAPHanaHSRProtectableItem

AzureVmWorkloadSAPHanaSystemProtectableItem

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

AzureVmWorkloadSQLDatabaseProtectableItem

AzureVmWorkloadSQLInstanceProtectableItem

CloudError

CloudErrorBody

DistributedNodesInfo

ErrorAdditionalInfo

ErrorDetail

IaaSVMProtectableItem

InquiryStatus

PreBackupValidation

ProtectionStatus

WorkloadProtectableItemResource

WorkloadProtectableItemResourceList

其他资源