Microsoft.RecoveryServices vaults/replicationRecoveryPlans 2021-03-01

  • Статья

Определение ресурса Bicep

Тип ресурса vaults/replicationRecoveryPlans можно развернуть в:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, добавьте в шаблон следующий Bicep.

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    failoverDeploymentModel: 'string'
    groups: [
      {
        endGroupActions: [
          {
            actionName: 'string'
            customDetails: {
              instanceType: 'string'
              // For remaining properties, see RecoveryPlanActionDetails objects
            }
            failoverDirections: [
              'string'
            ]
            failoverTypes: [
              'string'
            ]
          }
        ]
        groupType: 'string'
        replicationProtectedItems: [
          {
            id: 'string'
            virtualMachineId: 'string'
          }
        ]
        startGroupActions: [
          {
            actionName: 'string'
            customDetails: {
              instanceType: 'string'
              // For remaining properties, see RecoveryPlanActionDetails objects
            }
            failoverDirections: [
              'string'
            ]
            failoverTypes: [
              'string'
            ]
          }
        ]
      }
    ]
    primaryFabricId: 'string'
    providerSpecificInput: [
      {
        instanceType: 'string'
        // For remaining properties, see RecoveryPlanProviderSpecificInput objects
      }
    ]
    recoveryFabricId: 'string'
  }
}

Объекты RecoveryPlanActionDetails

Задайте свойство instanceType , чтобы указать тип объекта .

Для AutomationRunbookActionDetails используйте:

  instanceType: 'AutomationRunbookActionDetails'
  fabricLocation: 'string'
  runbookId: 'string'
  timeout: 'string'

Для manualActionDetails используйте:

  instanceType: 'ManualActionDetails'
  description: 'string'

Для ScriptActionDetails используйте:

  instanceType: 'ScriptActionDetails'
  fabricLocation: 'string'
  path: 'string'
  timeout: 'string'

Объекты RecoveryPlanProviderSpecificInput

Задайте свойство instanceType , чтобы указать тип объекта .

Для A2A используйте:

  instanceType: 'A2A'
  primaryZone: 'string'
  recoveryZone: 'string'

Значения свойств

vaults/replicationRecoveryPlans

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: vaults
properties Свойства создания плана восстановления. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (обязательно)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Имя Описание Значение
failoverDeploymentModel Модель развертывания отработки отказа. "Классический"
NotApplicable
ResourceManager
groups Группы плана восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Идентификатор основной структуры. строка (обязательно)
providerSpecificInput Входные данные, относящиеся к поставщику. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. строка (обязательно)

RecoveryPlanGroup

Имя Описание Значение
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. "Boot"
Отработка отказа
"Shutdown" (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanAction

Имя Описание Значение
actionName Имя действия. string (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
PrimaryToRecovery
RecoveryToPrimary (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
ChangePit
"Фиксация"
'CompleteMigration'
DisableProtection
'Восстановление размещения'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
"ReverseReplicate"
SwitchProtection
TestFailover
TestFailoverCleanup
UnplannedFailover (обязательно)

RecoveryPlanActionDetails

Имя Описание Значение
instanceType Установка типа объекта AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в перечислении RecoveryPlanActionDetailsTypes). AutomationRunbookActionDetails (обязательно)
fabricLocation Расположение структуры. 'Primary'
"Восстановление" (обязательно)
RunbookId Идентификатор ARM модуля Runbook. строка
timeout Время ожидания модуля Runbook. строка

RecoveryPlanManualActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в перечислении RecoveryPlanActionDetailsTypes). ManualActionDetails (обязательно)
description Описание действия вручную. строка

RecoveryPlanScriptActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в перечислении RecoveryPlanActionDetailsTypes). ScriptActionDetails (обязательно)
fabricLocation Расположение структуры. 'Primary'
"Восстановление" (обязательно)
path Путь к скрипту. string (обязательно)
timeout Время ожидания скрипта. строка

RecoveryPlanProtectedItem

Имя Описание Значение
идентификатор Идентификатор ARM защищенного элемента плана восстановления. строка
virtualMachineId Идентификатор виртуальной машины. строка

RecoveryPlanProviderSpecificInput

Имя Описание Значение
instanceType Установка типа объекта A2A (обязательно)

RecoveryPlanA2AInput

Имя Описание Значение
instanceType Возвращает тип экземпляра. "A2A" (обязательно)
primaryZone Основная зона. строка
recoveryZone Зона восстановления. строка

Определение ресурса шаблона ARM

Тип ресурса vaults/replicationRecoveryPlans можно развернуть в:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "apiVersion": "2021-03-01",
  "name": "string",
  "properties": {
    "failoverDeploymentModel": "string",
    "groups": [
      {
        "endGroupActions": [
          {
            "actionName": "string",
            "customDetails": {
              "instanceType": "string"
              // For remaining properties, see RecoveryPlanActionDetails objects
            },
            "failoverDirections": [ "string" ],
            "failoverTypes": [ "string" ]
          }
        ],
        "groupType": "string",
        "replicationProtectedItems": [
          {
            "id": "string",
            "virtualMachineId": "string"
          }
        ],
        "startGroupActions": [
          {
            "actionName": "string",
            "customDetails": {
              "instanceType": "string"
              // For remaining properties, see RecoveryPlanActionDetails objects
            },
            "failoverDirections": [ "string" ],
            "failoverTypes": [ "string" ]
          }
        ]
      }
    ],
    "primaryFabricId": "string",
    "providerSpecificInput": [
      {
        "instanceType": "string"
        // For remaining properties, see RecoveryPlanProviderSpecificInput objects
      }
    ],
    "recoveryFabricId": "string"
  }
}

Объекты RecoveryPlanActionDetails

Задайте свойство instanceType , чтобы указать тип объекта .

Для AutomationRunbookActionDetails используйте:

  "instanceType": "AutomationRunbookActionDetails",
  "fabricLocation": "string",
  "runbookId": "string",
  "timeout": "string"

Для manualActionDetails используйте:

  "instanceType": "ManualActionDetails",
  "description": "string"

Для ScriptActionDetails используйте:

  "instanceType": "ScriptActionDetails",
  "fabricLocation": "string",
  "path": "string",
  "timeout": "string"

Объекты RecoveryPlanProviderSpecificInput

Задайте свойство instanceType , чтобы указать тип объекта .

Для A2A используйте:

  "instanceType": "A2A",
  "primaryZone": "string",
  "recoveryZone": "string"

Значения свойств

vaults/replicationRecoveryPlans

Имя Описание Значение
тип Тип ресурса Microsoft.RecoveryServices/vaults/replicationRecoveryPlans
версия_API Версия API ресурсов '2021-03-01'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 строка (обязательно)
properties Свойства создания плана восстановления. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (обязательно)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Имя Описание Значение
failoverDeploymentModel Модель развертывания отработки отказа. "Классический"
NotApplicable
ResourceManager
groups Группы плана восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Идентификатор основной структуры. строка (обязательно)
providerSpecificInput Входные данные, относящиеся к поставщику. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. строка (обязательно)

RecoveryPlanGroup

Имя Описание Значение
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. "Boot"
Отработка отказа
"Shutdown" (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanAction

Имя Описание Значение
actionName Имя действия. строка (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
PrimaryToRecovery
RecoveryToPrimary (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
ChangePit
"Фиксация"
'CompleteMigration'
DisableProtection
Восстановление размещения
FinalizeFailback
PlannedFailover
RepairReplication
ReverseReplicate
SwitchProtection
TestFailover
TestFailoverCleanup
UnplannedFailover (обязательно)

RecoveryPlanActionDetails

Имя Описание Значение
instanceType Установка типа объекта AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). AutomationRunbookActionDetails (обязательно)
fabricLocation Расположение структуры. "Основной"
"Восстановление" (обязательно)
RunbookId Идентификатор ARM модуля Runbook. строка
timeout Время ожидания модуля Runbook. строка

RecoveryPlanManualActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). ManualActionDetails (обязательно)
description Описание действия вручную. строка

RecoveryPlanScriptActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). ScriptActionDetails (обязательно)
fabricLocation Расположение структуры. "Основной"
"Восстановление" (обязательно)
path Путь к скрипту. строка (обязательно)
timeout Время ожидания скрипта. строка

RecoveryPlanProtectedItem

Имя Описание Значение
идентификатор Идентификатор ARM защищенного элемента плана восстановления. строка
virtualMachineId Идентификатор виртуальной машины. строка

RecoveryPlanProviderSpecificInput

Имя Описание Значение
instanceType Установка типа объекта A2A (обязательно)

RecoveryPlanA2AInput

Имя Описание Значение
instanceType Возвращает тип экземпляра. "A2A" (обязательно)
primaryZone Основная зона. строка
recoveryZone Зона восстановления. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса vaults/replicationRecoveryPlans можно развернуть в:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      failoverDeploymentModel = "string"
      groups = [
        {
          endGroupActions = [
            {
              actionName = "string"
              customDetails = {
                instanceType = "string"
                // For remaining properties, see RecoveryPlanActionDetails objects
              }
              failoverDirections = [
                "string"
              ]
              failoverTypes = [
                "string"
              ]
            }
          ]
          groupType = "string"
          replicationProtectedItems = [
            {
              id = "string"
              virtualMachineId = "string"
            }
          ]
          startGroupActions = [
            {
              actionName = "string"
              customDetails = {
                instanceType = "string"
                // For remaining properties, see RecoveryPlanActionDetails objects
              }
              failoverDirections = [
                "string"
              ]
              failoverTypes = [
                "string"
              ]
            }
          ]
        }
      ]
      primaryFabricId = "string"
      providerSpecificInput = [
        {
          instanceType = "string"
          // For remaining properties, see RecoveryPlanProviderSpecificInput objects
        }
      ]
      recoveryFabricId = "string"
    }
  })
}

Объекты RecoveryPlanActionDetails

Задайте свойство instanceType , чтобы указать тип объекта .

Для AutomationRunbookActionDetails используйте:

  instanceType = "AutomationRunbookActionDetails"
  fabricLocation = "string"
  runbookId = "string"
  timeout = "string"

Для manualActionDetails используйте:

  instanceType = "ManualActionDetails"
  description = "string"

Для ScriptActionDetails используйте:

  instanceType = "ScriptActionDetails"
  fabricLocation = "string"
  path = "string"
  timeout = "string"

Объекты RecoveryPlanProviderSpecificInput

Задайте свойство instanceType , чтобы указать тип объекта .

Для A2A используйте:

  instanceType = "A2A"
  primaryZone = "string"
  recoveryZone = "string"

Значения свойств

vaults/replicationRecoveryPlans

Имя Описание Значение
тип Тип ресурса "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: хранилища
properties Свойства создания плана восстановления. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (обязательно)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Имя Описание Значение
failoverDeploymentModel Модель развертывания отработки отказа. "Классический"
NotApplicable
"ResourceManager"
groups Группы плана восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Идентификатор основной структуры. string (обязательно)
providerSpecificInput Входные данные, относящиеся к поставщику. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. string (обязательно)

RecoveryPlanGroup

Имя Описание Значение
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. "Загрузка"
"Отработка отказа"
"Завершение работы" (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanAction

Имя Описание Значение
actionName Имя действия. string (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
PrimaryToRecovery
RecoveryToPrimary (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
ChangePit
"Фиксация"
"CompleteMigration"
DisableProtection
"Восстановление размещения"
"FinalizeFailback"
"PlannedFailover"
"RepairReplication"
"ReverseReplicate"
SwitchProtection
TestFailover
"TestFailoverCleanup"
"UnplannedFailover" (обязательно)

RecoveryPlanActionDetails

Имя Описание Значение
instanceType Установка типа объекта AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). AutomationRunbookActionDetails (обязательно)
fabricLocation Расположение структуры. "Основной"
"Восстановление" (обязательно)
RunbookId Идентификатор ARM модуля Runbook. строка
timeout Время ожидания модуля Runbook. строка

RecoveryPlanManualActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). ManualActionDetails (обязательно)
description Описание действия вручную. строка

RecoveryPlanScriptActionDetails

Имя Описание Значение
instanceType Возвращает сведения о типе действия (возможные значения см. в разделе Перечисление RecoveryPlanActionDetailsTypes). ScriptActionDetails (обязательно)
fabricLocation Расположение структуры. "Основной"
"Восстановление" (обязательно)
path Путь к скрипту. строка (обязательно)
timeout Время ожидания скрипта. строка

RecoveryPlanProtectedItem

Имя Описание Значение
идентификатор Идентификатор ARM защищенного элемента плана восстановления. строка
virtualMachineId Идентификатор виртуальной машины. строка

RecoveryPlanProviderSpecificInput

Имя Описание Значение
instanceType Установка типа объекта A2A (обязательно)

RecoveryPlanA2AInput

Имя Описание Значение
instanceType Возвращает тип экземпляра. "A2A" (обязательно)
primaryZone Основная зона. строка
recoveryZone Зона восстановления. строка