Backup Instances - Validate For Backup

Проверка успешности резервного копирования

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup?api-version=2023-01-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

vaultName
path True

string

Имя хранилища резервных копий.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
backupInstance True

BackupInstance

Экземпляр резервного копирования

Ответы

Имя Тип Описание
200 OK

OperationJobExtendedInfo

Содержит дополнительные сведения, например идентификатор задания.

202 Accepted

Операция будет выполнена асинхронно.

Headers

  • Location: string
  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

CloudError

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

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

Примеры

Validate For Backup

Sample Request

POST https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/validateForBackup?api-version=2023-01-01

{
  "backupInstance": {
    "objectType": "BackupInstance",
    "friendlyName": "harshitbi2",
    "dataSourceSetInfo": {
      "objectType": "DatasourceSet",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest",
      "resourceName": "viveksipgtest",
      "resourceType": "Microsoft.DBforPostgreSQL/servers",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "dataSourceInfo": {
      "objectType": "Datasource",
      "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb",
      "resourceName": "testdb",
      "resourceType": "Microsoft.DBforPostgreSQL/servers/databases",
      "resourceUri": "",
      "resourceLocation": "",
      "datasourceType": "OssDB"
    },
    "datasourceAuthCredentials": {
      "secretStoreResource": {
        "uri": "https://samplevault.vault.azure.net/secrets/credentials",
        "secretStoreType": "AzureKeyVault"
      },
      "objectType": "SecretStoreBasedAuthCredentials"
    },
    "policyInfo": {
      "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1"
    }
  }
}

Sample Response

Location: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-01-01
Retry-After: 60
{
  "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae",
  "objectType": "OperationJobExtendedInfo"
}

Определения

Имя Описание
AzureOperationalStoreParameters

Параметры для хранилища данных Operational-Tier

BackupInstance

Экземпляр резервного копирования

BlobBackupDatasourceParameters

Параметры, используемые во время настройки резервного копирования BLOB-объектов

CloudError

CloudError

CurrentProtectionState

Указывает текущее состояние защиты ресурса.

Datasource

Источник данных

DatasourceSet

Набор источников данных

DataStoreTypes

тип хранилища данных; Рабочая/Хранилище/Архивная

Error

Ответ об ошибке управления ресурсами.

ErrorAdditionalInfo

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

InnerError

InnerError

KubernetesClusterBackupDatasourceParameters

Параметры для источника данных резервного копирования кластера Kubernetes

OperationJobExtendedInfo

OperationJobExtendedInfo

PolicyInfo

PolicyInfo

PolicyParameters

Параметры в политике

ProtectionStatusDetails

Сведения о состоянии защиты

SecretStoreBasedAuthCredentials

Учетные данные для проверки подлинности на основе хранилища секретов.

SecretStoreResource

Класс, представляющий ресурс хранилища секретов.

SecretStoreType

Возвращает или задает тип хранилища секретов.

Status

Указывает состояние защиты ресурса.

UserFacingError

Объект ошибки, используемый слоями, имеющими доступ к локализованным содержимым и распространяющий его пользователю

ValidateForBackupRequest

ValidateForBackupRequest

ValidationType

Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

AzureOperationalStoreParameters

Параметры для хранилища данных Operational-Tier

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

DataStoreTypes

тип хранилища данных; Рабочая/Хранилище/Архивная

objectType string:

AzureOperationalStoreParameters

Тип конкретного объекта , используемый для десериализации

resourceGroupId

string

Возвращает или задает универсальный код ресурса (URI) группы ресурсов моментального снимка.

BackupInstance

Экземпляр резервного копирования

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

CurrentProtectionState

Указывает текущее состояние защиты ресурса.

dataSourceInfo

Datasource

Источник данных
Возвращает или задает сведения об источнике данных.

dataSourceSetInfo

DatasourceSet

Набор источников данных
Возвращает или задает сведения о наборе источников данных.

datasourceAuthCredentials AuthCredentials:

SecretStoreBasedAuthCredentials

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

friendlyName

string

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

objectType

string

policyInfo

PolicyInfo

PolicyInfo
Возвращает или задает сведения о политике.

protectionErrorDetails

UserFacingError

Указывает ошибку защиты ресурса.

protectionStatus

ProtectionStatusDetails

Сведения о состоянии защиты
Указывает состояние защиты ресурса.

provisioningState

string

Указывает состояние подготовки ресурса, т. е. подготовка, обновление, успешное выполнение, сбой.

validationType

ValidationType

Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

BlobBackupDatasourceParameters

Параметры, используемые во время настройки резервного копирования BLOB-объектов

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

string[]

Список контейнеров для резервного копирования во время настройки резервного копирования BLOB-объектов

objectType string:

BlobBackupDatasourceParameters

Тип конкретного объекта , используемый для десериализации

CloudError

CloudError

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

Error

Ответ об ошибке управления ресурсами.

CurrentProtectionState

Указывает текущее состояние защиты ресурса.

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

string

ConfiguringProtection

string

ConfiguringProtectionFailed

string

Invalid

string

NotProtected

string

ProtectionConfigured

string

ProtectionError

string

ProtectionStopped

string

RetentionSchedulesSuspended

string

SoftDeleted

string

SoftDeleting

string

UpdatingProtection

string

Datasource

Источник данных

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

string

DatasourceType ресурса.

objectType

string

Тип объекта Datasource, используемый для инициализации правонаследуемого типа

resourceID

string

Полный идентификатор ARM ресурса. Для ресурсов Azure это идентификатор ARM. Для ресурсов, отличных от Azure, это будет идентификатор, созданный службой резервного копирования с помощью Fabric/Vault.

resourceLocation

string

Расположение источника данных.

resourceName

string

Уникальный идентификатор ресурса в контексте родительского объекта.

resourceType

string

Тип ресурса источника данных.

resourceUri

string

URI ресурса.

DatasourceSet

Набор источников данных

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

string

DatasourceType ресурса.

objectType

string

Тип объекта Datasource, используемый для инициализации правонаследуемого типа

resourceID

string

Полный идентификатор ARM ресурса. Для ресурсов Azure это идентификатор ARM. Для ресурсов, отличных от Azure, это будет идентификатор, созданный службой резервного копирования с помощью Fabric/Vault.

resourceLocation

string

Расположение источника данных.

resourceName

string

Уникальный идентификатор ресурса в контексте родительского объекта.

resourceType

string

Тип ресурса источника данных.

resourceUri

string

URI ресурса.

DataStoreTypes

тип хранилища данных; Рабочая/Хранилище/Архивная

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

string

OperationalStore

string

VaultStore

string

Error

Ответ об ошибке управления ресурсами.

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

Error[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorAdditionalInfo

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

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

object

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

type

string

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

InnerError

InnerError

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

object

Любые пары "Значение ключа", которые могут быть предоставлены клиенту для получения дополнительных подробных сведений.

code

string

Уникальный код для этой ошибки

embeddedInnerError

InnerError

InnerError
Внутренняя ошибка дочернего элемента, чтобы разрешить вложение.

KubernetesClusterBackupDatasourceParameters

Параметры для источника данных резервного копирования кластера Kubernetes

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

string[]

Возвращает или задает свойство exclude namespaces. Это свойство задает пространства имен, которые должны быть исключены во время восстановления.

excludedResourceTypes

string[]

Возвращает или задает свойство exclude resource types. Это свойство задает типы ресурсов, которые будут исключены во время восстановления.

includeClusterScopeResources

boolean

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

includedNamespaces

string[]

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

includedResourceTypes

string[]

Возвращает или задает свойство include resource types. Это свойство задает типы ресурсов, которые будут включены во время восстановления.

labelSelectors

string[]

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

objectType string:

KubernetesClusterBackupDatasourceParameters

Тип конкретного объекта , используемый для десериализации

snapshotVolumes

boolean

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

OperationJobExtendedInfo

OperationJobExtendedInfo

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

string

Идентификатор arm задания, созданного для этой операции.

objectType string:

OperationJobExtendedInfo

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

PolicyInfo

PolicyInfo

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

string

policyParameters

PolicyParameters

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

policyVersion

string

PolicyParameters

Параметры в политике

Имя Тип Описание
backupDatasourceParametersList BackupDatasourceParameters[]:

Возвращает или задает параметры источника резервных копий данных

dataStoreParametersList DataStoreParameters[]:

AzureOperationalStoreParameters[]

Возвращает или задает параметры хранилища данных.

ProtectionStatusDetails

Сведения о состоянии защиты

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

UserFacingError

Указывает ошибку состояния защиты ресурса.

status

Status

Указывает состояние защиты ресурса.

SecretStoreBasedAuthCredentials

Учетные данные для проверки подлинности на основе хранилища секретов.

Имя Тип Описание
objectType string:

SecretStoreBasedAuthCredentials

Тип конкретного объекта , используемый для десериализации

secretStoreResource

SecretStoreResource

Ресурс хранилища секретов

SecretStoreResource

Класс, представляющий ресурс хранилища секретов.

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

SecretStoreType

Возвращает или задает тип хранилища секретов.

uri

string

Универсальный код ресурса (URI) для получения ресурса

value

string

Возвращает или задает значение, хранящееся в ресурсе хранилища секретов.

SecretStoreType

Возвращает или задает тип хранилища секретов.

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

string

Invalid

string

Status

Указывает состояние защиты ресурса.

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

string

ConfiguringProtectionFailed

string

ProtectionConfigured

string

ProtectionStopped

string

SoftDeleted

string

SoftDeleting

string

UserFacingError

Объект ошибки, используемый слоями, имеющими доступ к локализованным содержимым и распространяющий его пользователю

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

string

Уникальный код для этой ошибки

details

UserFacingError[]

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

innerError

InnerError

InnerError
Внутренняя ошибка

isRetryable

boolean

Будет ли операция повторяться

isUserError

boolean

Указывает, вызвана ли операция ошибкой пользователя или службой

message

string

properties

object

Любые пары "ключ-значение", которые могут быть внедрены в объект ошибки

recommendedAction

string[]

Рекомендуемое действие локализовано.

target

string

Целевой объект ошибки.

ValidateForBackupRequest

ValidateForBackupRequest

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

BackupInstance

Экземпляр резервного копирования

ValidationType

Указывает тип проверки. В случае DeepValidation все проверки из API /validateForBackup будут выполняться снова.

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

string

ShallowValidation

string