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


Хранилища Microsoft.RecoveryServices/replicationRecoveryPlans 2024-04-01

Определение ресурсов Bicep

Тип ресурса vaults/replicationRecoveryPlans можно развернуть с помощью операций, предназначенных для следующих операций:

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

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

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2024-04-01' = {
  parent: resourceSymbolicName
  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'
  }
}

объектов RecoveryPlanProviderSpecificInput

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

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

{
  instanceType: 'A2A'
  primaryExtendedLocation: {
    name: 'string'
    type: 'string'
  }
  primaryZone: 'string'
  recoveryExtendedLocation: {
    name: 'string'
    type: 'string'
  }
  recoveryZone: 'string'
}

объектов RecoveryPlanActionDetails

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

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

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

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

{
  description: 'string'
  instanceType: 'ManualActionDetails'
}

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

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

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

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

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

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

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Description Value
failoverDeploymentModel Модель развертывания отработки отказа. 'Classic'
'NotApplicable'
'ResourceManager'
groups Группы планов восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Первичный идентификатор структуры. строка (обязательно)
providerSpecificInput Определенные входные данные поставщика. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. строка (обязательно)

ExtendedLocation

Name Description Value
name Имя расширенного расположения. строка (обязательно)
type Тип расширенного расположения. 'EdgeZone' (обязательно)

RecoveryPlanA2AInput

Name Description Value
instanceType Возвращает тип экземпляра. 'A2A' (обязательно)
primaryExtendedLocation Основное расширенное расположение. ExtendedLocation
primaryZone Основная зона. string
recoveryExtendedLocation Расширенное расположение восстановления. ExtendedLocation
recoveryZone Зона восстановления. string

RecoveryPlanAction

Name Description Value
actionName Наименование действия. строка (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
'PrimaryToRecovery'
'RecoveryToPrimary' (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (обязательно)

RecoveryPlanActionDetails

Name Description Value
instanceType Установите значение AutomationRunbookActionDetails для типа RecoveryPlanAutomationRunbookActionDetails. Установите значение ManualActionDetails для типа RecoveryPlanManualActionDetails. Задайте значение ScriptActionDetails для типа RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'AutomationRunbookActionDetails' (обязательно)
runbookId Идентификатор ARM модуля Runbook. string
timeout Время ожидания runbook. string

RecoveryPlanGroup

Name Description Value
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. 'Boot'
'Failover'
«Выключение» (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Description Value
description Описание действия вручную. string
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ManualActionDetails' (обязательно)

RecoveryPlanProtectedItem

Name Description Value
id Идентификатор ARM защищенного элемента плана восстановления. string
virtualMachineId Идентификатор виртуальной машины. string

RecoveryPlanProviderSpecificInput

Name Description Value
instanceType Установите значение A2A для типа RecoveryPlanA2AInput. 'A2A' (обязательно)

RecoveryPlanScriptActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ScriptActionDetails' (обязательно)
path Путь к скрипту. строка (обязательно)
timeout Время ожидания скрипта. string

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

Тип ресурса vaults/replicationRecoveryPlans можно развернуть с помощью операций, предназначенных для следующих операций:

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

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

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

{
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "apiVersion": "2024-04-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"
  }
}

объектов RecoveryPlanProviderSpecificInput

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

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

{
  "instanceType": "A2A",
  "primaryExtendedLocation": {
    "name": "string",
    "type": "string"
  },
  "primaryZone": "string",
  "recoveryExtendedLocation": {
    "name": "string",
    "type": "string"
  },
  "recoveryZone": "string"
}

объектов RecoveryPlanActionDetails

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

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

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

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

{
  "description": "string",
  "instanceType": "ManualActionDetails"
}

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

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

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

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Name Description Value
apiVersion Версия API '2024-04-01'
name имя ресурса. строка (обязательно)
properties Свойства создания плана восстановления. CreateRecoveryPlanInputProperties или RecoveryPlanProperties (обязательно)
type Тип ресурса 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans'

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Description Value
failoverDeploymentModel Модель развертывания отработки отказа. 'Classic'
'NotApplicable'
'ResourceManager'
groups Группы планов восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Первичный идентификатор структуры. строка (обязательно)
providerSpecificInput Определенные входные данные поставщика. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. строка (обязательно)

ExtendedLocation

Name Description Value
name Имя расширенного расположения. строка (обязательно)
type Тип расширенного расположения. 'EdgeZone' (обязательно)

RecoveryPlanA2AInput

Name Description Value
instanceType Возвращает тип экземпляра. 'A2A' (обязательно)
primaryExtendedLocation Основное расширенное расположение. ExtendedLocation
primaryZone Основная зона. string
recoveryExtendedLocation Расширенное расположение восстановления. ExtendedLocation
recoveryZone Зона восстановления. string

RecoveryPlanAction

Name Description Value
actionName Наименование действия. строка (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
'PrimaryToRecovery'
'RecoveryToPrimary' (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (обязательно)

RecoveryPlanActionDetails

Name Description Value
instanceType Установите значение AutomationRunbookActionDetails для типа RecoveryPlanAutomationRunbookActionDetails. Установите значение ManualActionDetails для типа RecoveryPlanManualActionDetails. Задайте значение ScriptActionDetails для типа RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'AutomationRunbookActionDetails' (обязательно)
runbookId Идентификатор ARM модуля Runbook. string
timeout Время ожидания runbook. string

RecoveryPlanGroup

Name Description Value
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. 'Boot'
'Failover'
«Выключение» (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Description Value
description Описание действия вручную. string
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ManualActionDetails' (обязательно)

RecoveryPlanProtectedItem

Name Description Value
id Идентификатор ARM защищенного элемента плана восстановления. string
virtualMachineId Идентификатор виртуальной машины. string

RecoveryPlanProviderSpecificInput

Name Description Value
instanceType Установите значение A2A для типа RecoveryPlanA2AInput. 'A2A' (обязательно)

RecoveryPlanScriptActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ScriptActionDetails' (обязательно)
path Путь к скрипту. строка (обязательно)
timeout Время ожидания скрипта. string

Примеры использования

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

Тип ресурса vaults/replicationRecoveryPlans можно развернуть с помощью операций, предназначенных для следующих операций:

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2024-04-01"
  name = "string"
  parent_id = "string"
  body = {
    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"
    }
  }
}

объектов RecoveryPlanProviderSpecificInput

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

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

{
  instanceType = "A2A"
  primaryExtendedLocation = {
    name = "string"
    type = "string"
  }
  primaryZone = "string"
  recoveryExtendedLocation = {
    name = "string"
    type = "string"
  }
  recoveryZone = "string"
}

объектов RecoveryPlanActionDetails

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

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

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

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

{
  description = "string"
  instanceType = "ManualActionDetails"
}

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

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

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

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Name Description Value
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: хранилища
properties Свойства создания плана восстановления. CreateRecoveryPlanInputProperties или RecoveryPlanProperties (обязательно)
type Тип ресурса "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2024-04-01"

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Description Value
failoverDeploymentModel Модель развертывания отработки отказа. 'Classic'
'NotApplicable'
'ResourceManager'
groups Группы планов восстановления. RecoveryPlanGroup[] (обязательно)
primaryFabricId Первичный идентификатор структуры. строка (обязательно)
providerSpecificInput Определенные входные данные поставщика. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Идентификатор структуры восстановления. строка (обязательно)

ExtendedLocation

Name Description Value
name Имя расширенного расположения. строка (обязательно)
type Тип расширенного расположения. 'EdgeZone' (обязательно)

RecoveryPlanA2AInput

Name Description Value
instanceType Возвращает тип экземпляра. 'A2A' (обязательно)
primaryExtendedLocation Основное расширенное расположение. ExtendedLocation
primaryZone Основная зона. string
recoveryExtendedLocation Расширенное расположение восстановления. ExtendedLocation
recoveryZone Зона восстановления. string

RecoveryPlanAction

Name Description Value
actionName Наименование действия. строка (обязательно)
customDetails Пользовательские сведения. RecoveryPlanActionDetails (обязательно)
failoverDirections Список направлений отработки отказа. Массив строк, содержащий любой из:
'PrimaryToRecovery'
'RecoveryToPrimary' (обязательно)
failoverTypes Список типов отработки отказа. Массив строк, содержащий любой из:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (обязательно)

RecoveryPlanActionDetails

Name Description Value
instanceType Установите значение AutomationRunbookActionDetails для типа RecoveryPlanAutomationRunbookActionDetails. Установите значение ManualActionDetails для типа RecoveryPlanManualActionDetails. Задайте значение ScriptActionDetails для типа RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (обязательно)

RecoveryPlanAutomationRunbookActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'AutomationRunbookActionDetails' (обязательно)
runbookId Идентификатор ARM модуля Runbook. string
timeout Время ожидания runbook. string

RecoveryPlanGroup

Name Description Value
endGroupActions Действия конечной группы. RecoveryPlanAction[]
groupType Тип группы. 'Boot'
'Failover'
«Выключение» (обязательно)
replicationProtectedItems Список защищенных элементов. RecoveryPlanProtectedItem[]
startGroupActions Действия начальной группы. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Description Value
description Описание действия вручную. string
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ManualActionDetails' (обязательно)

RecoveryPlanProtectedItem

Name Description Value
id Идентификатор ARM защищенного элемента плана восстановления. string
virtualMachineId Идентификатор виртуальной машины. string

RecoveryPlanProviderSpecificInput

Name Description Value
instanceType Установите значение A2A для типа RecoveryPlanA2AInput. 'A2A' (обязательно)

RecoveryPlanScriptActionDetails

Name Description Value
fabricLocation Расположение структуры. 'Primary'
«Восстановление» (обязательно)
instanceType Возвращает тип сведений о действии (см. перечисление RecoveryPlanActionDetailsTypes для возможных значений). 'ScriptActionDetails' (обязательно)
path Путь к скрипту. строка (обязательно)
timeout Время ожидания скрипта. string