Backup Protectable Items - List

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

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

Параметры URI

Name In Required Type 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.

Ответы

Name Type Description
200 OK

ОК

Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

List protectable items with backupManagementType filter as AzureIaasVm

Sample Request

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

Sample Response

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

AzureVmWorkloadSAPHanaSystemProtectableItem

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

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

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

AzureVmWorkloadSQLDatabaseProtectableItem

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

AzureVmWorkloadSQLInstanceProtectableItem

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

CloudError

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

CloudErrorBody

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

ErrorAdditionalInfo

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

IaaSVMProtectableItem

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

InquiryStatus

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

PreBackupValidation

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

ProtectionStatus

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

WorkloadProtectableItemResource

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

WorkloadProtectableItemResourceList

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

AzureFileShareProtectableItem

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

Name Type Description
azureFileShareType

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

backupManagementType
  • string

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

friendlyName
  • string

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

parentContainerFabricId
  • string

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

parentContainerFriendlyName
  • string

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

protectableItemType string:
  • AzureFileShare

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

protectionState

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

workloadType
  • string

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

AzureFileShareType

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

Name Type Description
Invalid
  • string
XSMB
  • string
XSync
  • string

AzureIaaSClassicComputeVMProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

protectableItemType string:
  • Microsoft.ClassicCompute/virtualMachines

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

protectionState

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

virtualMachineId
  • string

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

workloadType
  • string

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

AzureIaaSComputeVMProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

protectableItemType string:
  • Microsoft.Compute/virtualMachines

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

protectionState

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

virtualMachineId
  • string

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

workloadType
  • string

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

AzureVmWorkloadProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSAPAseSystemProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SAPAseSystem

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSAPHanaDatabaseProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SAPHanaDatabase

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSAPHanaSystemProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SAPHanaSystem

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SQLAvailabilityGroupContainer

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSQLDatabaseProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SQLDataBase

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

AzureVmWorkloadSQLInstanceProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

isAutoProtectable
  • boolean

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

isAutoProtected
  • boolean

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

parentName
  • string

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

parentUniqueName
  • string

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

prebackupvalidation

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

protectableItemType string:
  • SQLInstance

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

protectionState

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

serverName
  • string

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

subinquireditemcount
  • integer

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

subprotectableitemcount
  • integer

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

workloadType
  • string

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

CloudError

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

Name Type Description
error

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

CloudErrorBody

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

Name Type Description
additionalInfo

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

code
  • string

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

details

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

message
  • string

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

target
  • string

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

ErrorAdditionalInfo

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

Name Type Description
info
  • object

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

type
  • string

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

IaaSVMProtectableItem

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

Name Type Description
backupManagementType
  • string

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

friendlyName
  • string

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

protectableItemType string:

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

protectionState

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

virtualMachineId
  • string

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

workloadType
  • string

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

InquiryStatus

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

Name Type Description
Failed
  • string
Invalid
  • string
Success
  • string

PreBackupValidation

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

Name Type Description
code
  • string

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

message
  • string

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

status

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

ProtectionStatus

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

Name Type Description
Invalid
  • string
NotProtected
  • string
Protected
  • string
Protecting
  • string
ProtectionFailed
  • string

WorkloadProtectableItemResource

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

Name Type Description
eTag
  • string

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

id
  • string

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

location
  • string

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

name
  • string

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

properties WorkloadProtectableItem:

Свойства WorkloadProtectableItemResource

tags
  • object

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

type
  • string

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

WorkloadProtectableItemResourceList

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

Name Type Description
nextLink
  • string

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

value

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