Поделиться через


Backup Protectable Items - List

Предоставляет список защищаемых объектов в подписке в соответствии с фильтром запросов и параметрами разбиения на страницы.

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

Идентификатор подписки.

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

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя.

Примеры

List protectable items with backupManagementType filter as AzureIaasVm

Образец запроса

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'

Пример ответа

{
  "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

Элемент резервной копии виртуальной машины IaaS, представляющий классическую виртуальную машину вычислений.

AzureIaaSComputeVMProtectableItem

Элемент резервной копии виртуальной машины IaaS, представляющий виртуальную машину Azure Resource Manager.

AzureVmWorkloadProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure.

AzureVmWorkloadSAPAseSystemProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий систему SAP ASE.

AzureVmWorkloadSAPHanaDatabaseProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий базу данных SAP HANA.

AzureVmWorkloadSAPHanaDBInstance

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий Dbinstance SAP HANA.

AzureVmWorkloadSAPHanaHSRProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий HSR HANA.

AzureVmWorkloadSAPHanaSystemProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий систему SAP HANA.

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий группу доступности SQL.

AzureVmWorkloadSQLDatabaseProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий базу данных SQL.

AzureVmWorkloadSQLInstanceProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий экземпляр SQL.

CloudError

Ответ об ошибке службы экземпляра контейнера.

CloudErrorBody

Ответ об ошибке службы экземпляра контейнера.

DistributedNodesInfo

Это используется для представления различных узлов распределенного контейнера.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Класс Сведений об ошибках, который инкапсулирует код, сообщение и рекомендации.

IaaSVMProtectableItem

Элемент резервной копии виртуальной машины IaaS для конкретной рабочей нагрузки.

InquiryStatus

Состояние защищаемого элемента, т. е. InProgress,Succeeded,Failed

PreBackupValidation

Предварительная проверка резервного копирования для поставщика рабочей нагрузки виртуальной машины Azure.

ProtectionStatus

Состояние элемента резервного копирования.

WorkloadProtectableItemResource

Базовый класс для элемента резервного копирования. Элементы резервной копии, относящиеся к рабочей нагрузке, являются производными от этого класса.

WorkloadProtectableItemResourceList

Список ресурсов WorkloadProtectableItem

AzureFileShareProtectableItem

Защищенный элемент для рабочих нагрузок Файлового ресурса Azure.

Имя Тип Описание
azureFileShareType

AzureFileShareType

Тип общей папки XSync или XSMB.

backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

parentContainerFabricId

string

Полный идентификатор контейнера, к которому принадлежит этот защищенный элемент. Например, идентификатор ARM.

parentContainerFriendlyName

string

Понятное имя контейнера, к которому принадлежит этот защищенный элемент.

protectableItemType string:

AzureFileShare

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureFileShareType

Тип общей папки XSync или XSMB.

Имя Тип Описание
Invalid

string

XSMB

string

XSync

string

AzureIaaSClassicComputeVMProtectableItem

Элемент резервной копии виртуальной машины IaaS, представляющий классическую виртуальную машину вычислений.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

protectableItemType string:

Microsoft.ClassicCompute/virtualMachines

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

resourceGroup

string

Имя группы ресурсов хранилища служб восстановления.

virtualMachineId

string

Полный идентификатор ARM виртуальной машины.

virtualMachineVersion

string

Указывает, представляет ли контейнер классическую или виртуальную машину Azure Resource Manager.

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureIaaSComputeVMProtectableItem

Элемент резервной копии виртуальной машины IaaS, представляющий виртуальную машину Azure Resource Manager.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

protectableItemType string:

Microsoft.Compute/virtualMachines

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

resourceGroup

string

Имя группы ресурсов хранилища служб восстановления.

virtualMachineId

string

Полный идентификатор ARM виртуальной машины.

virtualMachineVersion

string

Указывает, представляет ли контейнер классическую или виртуальную машину Azure Resource Manager.

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

AzureVmWorkloadProtectableItem

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSAPAseSystemProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий систему SAP ASE.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SAPAseSystem

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSAPHanaDatabaseProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий базу данных SAP HANA.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SAPHanaDatabase

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSAPHanaDBInstance

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий Dbinstance SAP HANA.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SAPHanaDBInstance

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSAPHanaHSRProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий HSR HANA.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

HanaHSRContainer

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSAPHanaSystemProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий систему SAP HANA.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SAPHanaSystem

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий группу доступности SQL.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

nodesList

DistributedNodesInfo[]

Список узлов в случае распределенного контейнера.

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SQLAvailabilityGroupContainer

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSQLDatabaseProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий базу данных SQL.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SQLDataBase

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

AzureVmWorkloadSQLInstanceProtectableItem

Защищенный элемент рабочей нагрузки виртуальной машины Azure, представляющий экземпляр SQL.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

isAutoProtectable

boolean

Указывает, является ли защищенный элемент автоматически защищенным.

isAutoProtected

boolean

Указывает, является ли защищенный элемент автоматически защищенным

isProtectable

boolean

Указывает, является ли элемент защищенным

parentName

string

Имя экземпляра или группы доступности

parentUniqueName

string

Родительское уникальное имя добавляется для предоставления отформатированного URI службы имени родительского только для баз данных, где родительский объект будет экземпляром или группой доступности SQL.

prebackupvalidation

PreBackupValidation

Предварительная проверка резервного копирования для защищенных объектов

protectableItemType string:

SQLInstance

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

serverName

string

Имя узла или кластера для экземпляра или группы доступности

subinquireditemcount

integer

Например, или группа доступности, указывает количество присутствующих баз данных

subprotectableitemcount

integer

Например, или группа доступности, указывает количество защищаемых баз данных

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

CloudError

Ответ об ошибке службы экземпляра контейнера.

Имя Тип Описание
error

CloudErrorBody

Объект ошибки.

CloudErrorBody

Ответ об ошибке службы экземпляра контейнера.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.

details

CloudErrorBody[]

Список дополнительных сведений об ошибке.

message

string

Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

target

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

DistributedNodesInfo

Это используется для представления различных узлов распределенного контейнера.

Имя Тип Описание
errorDetail

ErrorDetail

Сведения об ошибке, если состояние не выполнено.

nodeName

string

Имя узла в распределенном контейнере.

sourceResourceId

string

Идентификатор ресурса ARM узла

status

string

Состояние этого узла. Сбой | Удалось

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Класс Сведений об ошибках, который инкапсулирует код, сообщение и рекомендации.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке, связанное с кодом.

recommendations

string[]

Список строк рекомендаций.

IaaSVMProtectableItem

Элемент резервной копии виртуальной машины IaaS для конкретной рабочей нагрузки.

Имя Тип Описание
backupManagementType

string

Тип управления резервными копиями для резервного копирования элемента.

friendlyName

string

Понятное имя элемента резервной копии.

protectableItemType string:

IaaSVMProtectableItem

Тип элемента резервной копии.

protectionState

ProtectionStatus

Состояние элемента резервного копирования.

resourceGroup

string

Имя группы ресурсов хранилища служб восстановления.

virtualMachineId

string

Полный идентификатор ARM виртуальной машины.

virtualMachineVersion

string

Указывает, представляет ли контейнер классическую или виртуальную машину Azure Resource Manager.

workloadType

string

Тип рабочей нагрузки для управления резервными копиями

InquiryStatus

Состояние защищаемого элемента, т. е. InProgress,Succeeded,Failed

Имя Тип Описание
Failed

string

Invalid

string

Success

string

PreBackupValidation

Предварительная проверка резервного копирования для поставщика рабочей нагрузки виртуальной машины Azure.

Имя Тип Описание
code

string

Код ошибки защищенного элемента

message

string

Сообщение, соответствующее коду ошибки для защищенного элемента

status

InquiryStatus

Состояние защищаемого элемента, т. е. InProgress,Succeeded,Failed

ProtectionStatus

Состояние элемента резервного копирования.

Имя Тип Описание
Invalid

string

NotProtected

string

Protected

string

Protecting

string

ProtectionFailed

string

WorkloadProtectableItemResource

Базовый класс для элемента резервного копирования. Элементы резервной копии, относящиеся к рабочей нагрузке, являются производными от этого класса.

Имя Тип Описание
eTag

string

Необязательный ETag.

id

string

Идентификатор ресурса представляет полный путь к ресурсу.

location

string

Расположение ресурса.

name

string

Имя ресурса, связанное с ресурсом.

properties WorkloadProtectableItem:

Свойства WorkloadProtectableItemResource

tags

object

Теги ресурсов.

type

string

Тип ресурса представляет полный путь к пространству имен формы/ResourceType/ResourceType/...

WorkloadProtectableItemResourceList

Список ресурсов WorkloadProtectableItem

Имя Тип Описание
nextLink

string

URI для получения следующей страницы ресурсов. Вызов ListNext() извлекает следующую страницу ресурсов.

value

WorkloadProtectableItemResource[]

Список ресурсов.