你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.RecoveryServices vaults/replicationRecoveryPlans 2022-02-01

• 最新
• 2024-10-01
• 2024-04-01
• 2024-02-01
• 2024-01-01
• 2023-08-01
• 2023-06-01
• 2023-04-01
• 2023-02-01
• 2023-01-01
• 2022-10-01
• 2022-09-10
• 2022-08-01
• 2022-05-01
• 2022-04-01
• 2022-03-01
• 2022-02-01
• 2022-01-01
• 2021-12-01
• 2021-11-01
• 2021-10-01
• 2021-08-01
• 2021-07-01
• 2021-06-01
• 2021-04-01
• 2021-03-01
• 2021-02-10
• 2018-07-10
• 2018-01-10
• 2016-08-10

Bicep 资源定义

可以使用目标操作部署保管库/replicationRecoveryPlans 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/replicationRecoveryPlans 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-02-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'
}

属性值

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名字	描述	价值
failoverDeploymentModel	故障转移部署模型。	“经典” “NotApplicable” “ResourceManager”
组	恢复计划组。	RecoveryPlanGroup[] （必需）
primaryFabricId	主构造 ID。	string （必需）
providerSpecificInput	提供程序特定的输入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	恢复构造 ID。	string （必需）

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	string （必需）
类型	扩展位置类型。	“EdgeZone”（必需）

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

名字	描述	价值
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：保管库
性能	恢复计划创建属性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties（必需）

RecoveryPlanA2AInput

名字	描述	价值
instanceType	获取实例类型。	“A2A”（必需）
primaryExtendedLocation	主要扩展位置。	ExtendedLocation
primaryZone	主要区域。	字符串
recoveryExtendedLocation	恢复扩展位置。	ExtendedLocation
recoveryZone	恢复区域。	字符串

RecoveryPlanAction

名字	描述	价值
actionName	操作名称。	string （必需）
customDetails	自定义详细信息。	RecoveryPlanActionDetails （必需）
failoverDirections	故障转移方向列表。	包含任一项的字符串数组： “PrimaryToRecovery” “RecoveryToPrimary”（必需）
failoverTypes	故障转移类型列表。	包含任一项的字符串数组： “CancelFailover” “ChangePit” “Commit” “CompleteMigration” “DisableProtection” “故障回复” “FinalizeFailback” “PlannedFailover” “RepairReplication” “ReverseReplicate” “SwitchProtection” “TestFailover” “TestFailoverCleanup” “UnplannedFailover”（必需）

RecoveryPlanActionDetails

名字	描述	价值
instanceType	对于 RecoveryPlanAutomationRunbookActionDetails类型，设置为“AutomationRunbookActionDetails”。 对于 recoveryPlanManualActionDetails类型，设置为“ManualActionDetails”。 对于 RecoveryPlanScriptActionDetails类型，设置为“ScriptActionDetails”。	“AutomationRunbookActionDetails” “ManualActionDetails” “ScriptActionDetails”（必需）

RecoveryPlanAutomationRunbookActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“AutomationRunbookActionDetails”（必需）
runbookId	Runbook ARM ID。	字符串
超时	Runbook 超时。	字符串

RecoveryPlanGroup

名字	描述	价值
endGroupActions	结束组操作。	RecoveryPlanAction[]
groupType	组类型。	“Boot” “故障转移” “关闭”（必需）
replicationProtectedItems	受保护项的列表。	RecoveryPlanProtectedItem[]
startGroupActions	启动组操作。	RecoveryPlanAction[]

RecoveryPlanManualActionDetails

名字	描述	价值
描述	手动操作说明。	字符串
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ManualActionDetails”（必需）

RecoveryPlanProtectedItem

名字	描述	价值
id	恢复计划受保护项的 ARM ID。	字符串
virtualMachineId	虚拟机 ID。	字符串

RecoveryPlanProviderSpecificInput

名字	描述	价值
instanceType	对于 RecoveryPlanA2AInput类型，设置为“A2A”。	“A2A”（必需）

RecoveryPlanScriptActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ScriptActionDetails”（必需）
路径	脚本路径。	string （必需）
超时	脚本超时。	字符串

ARM 模板资源定义

可以使用目标操作部署保管库/replicationRecoveryPlans 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/replicationRecoveryPlans 资源，请将以下 JSON 添加到模板。

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

属性值

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名字	描述	价值
failoverDeploymentModel	故障转移部署模型。	“经典” “NotApplicable” “ResourceManager”
组	恢复计划组。	RecoveryPlanGroup[] （必需）
primaryFabricId	主构造 ID。	string （必需）
providerSpecificInput	提供程序特定的输入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	恢复构造 ID。	string （必需）

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	string （必需）
类型	扩展位置类型。	“EdgeZone”（必需）

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

名字	描述	价值
apiVersion	API 版本	'2022-02-01'
名字	资源名称	string （必需）
性能	恢复计划创建属性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties（必需）
类型	资源类型	“Microsoft.RecoveryServices/vaults/replicationRecoveryPlans”

RecoveryPlanA2AInput

名字	描述	价值
instanceType	获取实例类型。	“A2A”（必需）
primaryExtendedLocation	主要扩展位置。	ExtendedLocation
primaryZone	主要区域。	字符串
recoveryExtendedLocation	恢复扩展位置。	ExtendedLocation
recoveryZone	恢复区域。	字符串

RecoveryPlanAction

名字	描述	价值
actionName	操作名称。	string （必需）
customDetails	自定义详细信息。	RecoveryPlanActionDetails （必需）
failoverDirections	故障转移方向列表。	包含任一项的字符串数组： “PrimaryToRecovery” “RecoveryToPrimary”（必需）
failoverTypes	故障转移类型列表。	包含任一项的字符串数组： “CancelFailover” “ChangePit” “Commit” “CompleteMigration” “DisableProtection” “故障回复” “FinalizeFailback” “PlannedFailover” “RepairReplication” “ReverseReplicate” “SwitchProtection” “TestFailover” “TestFailoverCleanup” “UnplannedFailover”（必需）

RecoveryPlanActionDetails

名字	描述	价值
instanceType	对于 RecoveryPlanAutomationRunbookActionDetails类型，设置为“AutomationRunbookActionDetails”。 对于 recoveryPlanManualActionDetails类型，设置为“ManualActionDetails”。 对于 RecoveryPlanScriptActionDetails类型，设置为“ScriptActionDetails”。	“AutomationRunbookActionDetails” “ManualActionDetails” “ScriptActionDetails”（必需）

RecoveryPlanAutomationRunbookActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“AutomationRunbookActionDetails”（必需）
runbookId	Runbook ARM ID。	字符串
超时	Runbook 超时。	字符串

RecoveryPlanGroup

名字	描述	价值
endGroupActions	结束组操作。	RecoveryPlanAction[]
groupType	组类型。	“Boot” “故障转移” “关闭”（必需）
replicationProtectedItems	受保护项的列表。	RecoveryPlanProtectedItem[]
startGroupActions	启动组操作。	RecoveryPlanAction[]

RecoveryPlanManualActionDetails

名字	描述	价值
描述	手动操作说明。	字符串
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ManualActionDetails”（必需）

RecoveryPlanProtectedItem

名字	描述	价值
id	恢复计划受保护项的 ARM ID。	字符串
virtualMachineId	虚拟机 ID。	字符串

RecoveryPlanProviderSpecificInput

名字	描述	价值
instanceType	对于 RecoveryPlanA2AInput类型，设置为“A2A”。	“A2A”（必需）

RecoveryPlanScriptActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ScriptActionDetails”（必需）
路径	脚本路径。	string （必需）
超时	脚本超时。	字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署保管库/replicationRecoveryPlans 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.RecoveryServices/vaults/replicationRecoveryPlans 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-02-01"
  name = "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"
    }
  })
}

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

属性值

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名字	描述	价值
failoverDeploymentModel	故障转移部署模型。	“经典” “NotApplicable” “ResourceManager”
组	恢复计划组。	RecoveryPlanGroup[] （必需）
primaryFabricId	主构造 ID。	string （必需）
providerSpecificInput	提供程序特定的输入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	恢复构造 ID。	string （必需）

ExtendedLocation

名字	描述	价值
名字	扩展位置的名称。	string （必需）
类型	扩展位置类型。	“EdgeZone”（必需）

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

名字	描述	价值
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：保管库
性能	恢复计划创建属性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties（必需）
类型	资源类型	“Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-02-01”

RecoveryPlanA2AInput

名字	描述	价值
instanceType	获取实例类型。	“A2A”（必需）
primaryExtendedLocation	主要扩展位置。	ExtendedLocation
primaryZone	主要区域。	字符串
recoveryExtendedLocation	恢复扩展位置。	ExtendedLocation
recoveryZone	恢复区域。	字符串

RecoveryPlanAction

名字	描述	价值
actionName	操作名称。	string （必需）
customDetails	自定义详细信息。	RecoveryPlanActionDetails （必需）
failoverDirections	故障转移方向列表。	包含任一项的字符串数组： “PrimaryToRecovery” “RecoveryToPrimary”（必需）
failoverTypes	故障转移类型列表。	包含任一项的字符串数组： “CancelFailover” “ChangePit” “Commit” “CompleteMigration” “DisableProtection” “故障回复” “FinalizeFailback” “PlannedFailover” “RepairReplication” “ReverseReplicate” “SwitchProtection” “TestFailover” “TestFailoverCleanup” “UnplannedFailover”（必需）

RecoveryPlanActionDetails

名字	描述	价值
instanceType	对于 RecoveryPlanAutomationRunbookActionDetails类型，设置为“AutomationRunbookActionDetails”。 对于 recoveryPlanManualActionDetails类型，设置为“ManualActionDetails”。 对于 RecoveryPlanScriptActionDetails类型，设置为“ScriptActionDetails”。	“AutomationRunbookActionDetails” “ManualActionDetails” “ScriptActionDetails”（必需）

RecoveryPlanAutomationRunbookActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“AutomationRunbookActionDetails”（必需）
runbookId	Runbook ARM ID。	字符串
超时	Runbook 超时。	字符串

RecoveryPlanGroup

名字	描述	价值
endGroupActions	结束组操作。	RecoveryPlanAction[]
groupType	组类型。	“Boot” “故障转移” “关闭”（必需）
replicationProtectedItems	受保护项的列表。	RecoveryPlanProtectedItem[]
startGroupActions	启动组操作。	RecoveryPlanAction[]

RecoveryPlanManualActionDetails

名字	描述	价值
描述	手动操作说明。	字符串
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ManualActionDetails”（必需）

RecoveryPlanProtectedItem

名字	描述	价值
id	恢复计划受保护项的 ARM ID。	字符串
virtualMachineId	虚拟机 ID。	字符串

RecoveryPlanProviderSpecificInput

名字	描述	价值
instanceType	对于 RecoveryPlanA2AInput类型，设置为“A2A”。	“A2A”（必需）

RecoveryPlanScriptActionDetails

名字	描述	价值
fabricLocation	构造位置。	“Primary” “恢复”（必需）
instanceType	获取操作详细信息的类型（有关可能的值，请参阅 RecoveryPlanActionDetailsTypes 枚举）。	“ScriptActionDetails”（必需）
路径	脚本路径。	string （必需）
超时	脚本超时。	字符串