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

Backup Engines - List

服务:: Recovery Services - Backup

API 版本:: 2025-08-01

注册到恢复服务保管库的备份管理服务器。返回服务器的可分页列表。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
vaultName	path	True	string	VaultResource 的名称
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
$filter	query		string	OData 筛选器选项。
$skipToken	query		string	skipToken 筛选器。

响应

名称	类型	说明
200 OK	BackupEngineBaseResourceList	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List Dpm/AzureBackupServer/Lajolla Backup Engines

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines?api-version=2025-08-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "testServer1",
      "type": "Microsoft.RecoveryServices/vaults/backupEngines",
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer1",
      "properties": {
        "azureBackupAgentVersion": "2.0.9532.0",
        "backupEngineState": "Active",
        "backupEngineType": "DpmBackupEngine",
        "dpmVersion": "5.1.348.0",
        "extendedInfo": {
          "availableDiskSpace": 50,
          "diskCount": 5,
          "protectedItemsCount": 35,
          "protectedServersCount": 21,
          "usedDiskSpace": 20
        },
        "friendlyName": "testServer1",
        "isAzureBackupAgentUpgradeAvailable": false,
        "isDpmUpgradeAvailable": false,
        "registrationStatus": "Registered"
      }
    },
    {
      "name": "testServer5",
      "type": "Microsoft.RecoveryServices/vaults/backupEngines",
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer5",
      "properties": {
        "azureBackupAgentVersion": "2.0.9530.0",
        "backupEngineState": "Active",
        "backupEngineType": "DpmBackupEngine",
        "dpmVersion": "5.1.348.0",
        "extendedInfo": {
          "availableDiskSpace": 50,
          "diskCount": 5,
          "protectedItemsCount": 35,
          "protectedServersCount": 21,
          "usedDiskSpace": 20
        },
        "friendlyName": "testServer5",
        "isAzureBackupAgentUpgradeAvailable": false,
        "isDpmUpgradeAvailable": false,
        "registrationStatus": "Registered"
      }
    }
  ]
}

定义

名称	说明
AzureBackupServerEngine	使用 Azure 备份服务器管理备份时备份引擎类型。
BackupEngineBaseResource	基本备份引擎类。所有特定于工作负荷的备份引擎都派生自此类。
BackupEngineBaseResourceList	BackupEngineBase 资源列表
BackupEngineExtendedInfo	有关备份引擎的其他信息。
BackupEngineType	备份引擎的类型。
BackupManagementType	用于执行当前作业的备份管理类型。
createdByType	创建资源的标识的类型。
DpmBackupEngine	特定于 Data Protection Manager （DPM）的备份引擎。
ErrorDetail	Error Detail 类，用于封装 Code、Message 和 Recommendations。
ErrorResponse	错误响应
systemData	与创建和上次修改资源相关的元数据。

AzureBackupServerEngine

Object

使用 Azure 备份服务器管理备份时备份引擎类型。

名称	类型	说明
azureBackupAgentVersion	string	备份代理版本
backupEngineId	string	备份引擎的 ID。
backupEngineState	string	使用恢复服务保管库的备份引擎的状态。 = {Active/Delete/DeleteFailed}
backupEngineType	string: AzureBackupServerEngine	备份引擎的类型。
backupManagementType	BackupManagementType	备份引擎的备份管理类型。
canReRegister	boolean	指示备份引擎是否已注册的标志，一旦已注册。
dpmVersion	string	备份引擎版本
extendedInfo	BackupEngineExtendedInfo	backupengine 的扩展信息
friendlyName	string	备份引擎的友好名称。
healthStatus	string	备份引擎的备份状态。
isAzureBackupAgentUpgradeAvailable	boolean	检查备份代理升级是否可用
isDpmUpgradeAvailable	boolean	检查备份引擎升级是否可用
registrationStatus	string	使用恢复服务保管库注册备份引擎的状态。

BackupEngineBaseResource

Object

基本备份引擎类。所有特定于工作负荷的备份引擎都派生自此类。

名称	类型	说明
eTag	string	可选 ETag。
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties	BackupEngineBase: AzureBackupServerEngine DpmBackupEngine	BackupEngineBaseResource 属性
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

BackupEngineBaseResourceList

Object

BackupEngineBase 资源列表

名称	类型	说明
nextLink	string	用于提取下一页资源的 URI，每个 API 调用最多返回每页 200 个资源。如果资源总数超过 200，请使用 ListNext（）提取下一页。
value	BackupEngineBaseResource[]	资源列表。

BackupEngineExtendedInfo

Object

有关备份引擎的其他信息。

名称	类型	说明
availableDiskSpace	number (double)	备份引擎中当前可用的磁盘空间。
azureProtectedInstances	integer (int32)	备份引擎中的受保护实例。
databaseName	string	备份引擎的数据库名称。
diskCount	integer (int32)	备份引擎中的磁盘数。
protectedItemsCount	integer (int32)	备份引擎中的受保护项数。
protectedServersCount	integer (int32)	备份引擎中的受保护服务器数。
refreshedAt	string (date-time)	备份引擎中的上次刷新时间。
usedDiskSpace	number (double)	备份引擎中使用的磁盘空间。

BackupEngineType

枚举

备份引擎的类型。

值	说明
Invalid
DpmBackupEngine
AzureBackupServerEngine

BackupManagementType

枚举

用于执行当前作业的备份管理类型。

值	说明
Invalid
AzureIaasVM
MAB
DPM
AzureBackupServer
AzureSql
AzureStorage
AzureWorkload
DefaultBackup

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DpmBackupEngine

Object

特定于 Data Protection Manager （DPM）的备份引擎。

名称	类型	说明
azureBackupAgentVersion	string	备份代理版本
backupEngineId	string	备份引擎的 ID。
backupEngineState	string	使用恢复服务保管库的备份引擎的状态。 = {Active/Delete/DeleteFailed}
backupEngineType	string: DpmBackupEngine	备份引擎的类型。
backupManagementType	BackupManagementType	备份引擎的备份管理类型。
canReRegister	boolean	指示备份引擎是否已注册的标志，一旦已注册。
dpmVersion	string	备份引擎版本
extendedInfo	BackupEngineExtendedInfo	backupengine 的扩展信息
friendlyName	string	备份引擎的友好名称。
healthStatus	string	备份引擎的备份状态。
isAzureBackupAgentUpgradeAvailable	boolean	检查备份代理升级是否可用
isDpmUpgradeAvailable	boolean	检查备份引擎升级是否可用
registrationStatus	string	使用恢复服务保管库注册备份引擎的状态。

ErrorDetail

Object

Error Detail 类，用于封装 Code、Message 和 Recommendations。

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

ErrorResponse

Object

错误响应

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

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Backup Engines - List

URI 参数

响应

安全性

azure_auth

作用域

示例

List Dpm/AzureBackupServer/Lajolla Backup Engines

示例请求

示例响应

定义

AzureBackupServerEngine

BackupEngineBaseResource

BackupEngineBaseResourceList

BackupEngineExtendedInfo

BackupEngineType

BackupManagementType

createdByType

DpmBackupEngine

ErrorDetail

ErrorResponse

systemData