Microsoft.RecoveryServices 保存庫/replicationRecoveryPlans 2021-03-01

• 最近的
• 2025-02-01
• 2025-01-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@2021-03-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'
  primaryZone: '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

名稱	說明	價值觀
名稱	資源名稱	字串 （必要）
家長	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型資源的符號名稱：保存庫
屬性	復原計劃建立屬性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties （必要）

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名稱	說明	價值觀
failoverDeploymentModel	故障轉移部署模型。	“經典” '不適用' '資源管理員'
群組	復原方案群組。	RecoveryPlanGroup[] （必要）
primaryFabricId	主要網狀架構標識碼。	字串 （必要）
providerSpecificInput	提供者特定的輸入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	復原網狀架構標識碼。	字串 （必要）

RecoveryPlanA2Anput

名稱	說明	價值觀
instanceType	取得實例類型。	'A2A' （必要）
primaryZone （主區）	主要區域。	字符串
recoveryZone （恢復區）	復原區域。	字符串

RecoveryPlanAction作

名稱	說明	價值觀
作名稱	動作名稱。	字串 （必要）
自訂詳細資訊	自訂詳細數據。	RecoveryPlanActionDetails （必要）
failoverDirections	故障轉移指示的清單。	包含任何的字串數組： “PrimaryToRecovery” 'RecoveryToPrimary' （必要）
failover類型	故障轉移類型清單。	包含任何的字串數組： 'ChangePit' “提交” “完成遷移” 'DisableProtection' '容錯回復' “FinalizeFailback” “計劃故障轉移” “修復複製” '反向複製' “開關保護” “TestFailover” “TestFailoverCleanup” 'UnplannedFailover' （必要）

RecoveryPlanActionDetails

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanAutomationRunbookActionDetails 類型的 'AutomationRunbookActionDetails'。 設定為 RecoveryPlanManualActionDetails 類型的 'ManualActionDetails'。 設定為 RecoveryPlanScriptActionDetails 類型的 'ScriptActionDetails'。	“AutomationRunbookActionDetails” 'ManualActionDetails' 'ScriptActionDetails' （必要）

RecoveryPlanAutomationRunbookActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'AutomationRunbookActionDetails' （必要）
RunbookId	Runbook ARM 識別碼。	字符串
超時	Runbook 逾時。	字符串

RecoveryPlanGroup （恢復計劃組）

名稱	說明	價值觀
endGroupActions	結束群組動作。	RecoveryPlanAction[]
群組類型	群組類型。	'靴子' “故障轉移” 'Shutdown' （必要）
replicationProtectedItems	受保護的項目清單。	RecoveryPlanProtectedItem[]
startGroupActions	開始群組動作。	RecoveryPlanAction[]

RecoveryPlanManualAction詳細資訊

名稱	說明	價值觀
說明	手動動作描述。	字符串
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ManualActionDetails' （必要）

RecoveryPlanProtected專案

名稱	說明	價值觀
識別碼	復原方案受保護專案的 ARM 識別碼。	字符串
虛擬機器ID	虛擬機標識碼。	字符串

RecoveryPlanProviderSpecificInput

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanA2AInput 類型的 『A2A』。	'A2A' （必要）

RecoveryPlanScriptActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ScriptActionDetails' （必要）
路徑	腳本路徑。	字串 （必要）
超時	腳本逾時。	字符串

ARM 樣本資源定義

保存庫/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"
  }
}

RecoveryPlanProviderSpecificInput 物件

設定 instanceType 屬性，以指定對象的類型。

針對 A2A，請使用：

{
  "instanceType": "A2A",
  "primaryZone": "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

名稱	說明	價值觀
apiVersion	API 版本	'2021-03-01'
名稱	資源名稱	字串 （必要）
屬性	復原計劃建立屬性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties （必要）
類型	資源類型	“Microsoft.RecoveryServices/vaults/replicationRecoveryPlans”

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名稱	說明	價值觀
failoverDeploymentModel	故障轉移部署模型。	“經典” '不適用' '資源管理員'
群組	復原方案群組。	RecoveryPlanGroup[] （必要）
primaryFabricId	主要網狀架構標識碼。	字串 （必要）
providerSpecificInput	提供者特定的輸入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	復原網狀架構標識碼。	字串 （必要）

RecoveryPlanA2Anput

名稱	說明	價值觀
instanceType	取得實例類型。	'A2A' （必要）
primaryZone （主區）	主要區域。	字符串
recoveryZone （恢復區）	復原區域。	字符串

RecoveryPlanAction作

名稱	說明	價值觀
作名稱	動作名稱。	字串 （必要）
自訂詳細資訊	自訂詳細數據。	RecoveryPlanActionDetails （必要）
failoverDirections	故障轉移指示的清單。	包含任何的字串數組： “PrimaryToRecovery” 'RecoveryToPrimary' （必要）
failover類型	故障轉移類型清單。	包含任何的字串數組： 'ChangePit' “提交” “完成遷移” 'DisableProtection' '容錯回復' “FinalizeFailback” “計劃故障轉移” “修復複製” '反向複製' “開關保護” “TestFailover” “TestFailoverCleanup” 'UnplannedFailover' （必要）

RecoveryPlanActionDetails

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanAutomationRunbookActionDetails 類型的 'AutomationRunbookActionDetails'。 設定為 RecoveryPlanManualActionDetails 類型的 'ManualActionDetails'。 設定為 RecoveryPlanScriptActionDetails 類型的 'ScriptActionDetails'。	“AutomationRunbookActionDetails” 'ManualActionDetails' 'ScriptActionDetails' （必要）

RecoveryPlanAutomationRunbookActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'AutomationRunbookActionDetails' （必要）
RunbookId	Runbook ARM 識別碼。	字符串
超時	Runbook 逾時。	字符串

RecoveryPlanGroup （恢復計劃組）

名稱	說明	價值觀
endGroupActions	結束群組動作。	RecoveryPlanAction[]
群組類型	群組類型。	'靴子' “故障轉移” 'Shutdown' （必要）
replicationProtectedItems	受保護的項目清單。	RecoveryPlanProtectedItem[]
startGroupActions	開始群組動作。	RecoveryPlanAction[]

RecoveryPlanManualAction詳細資訊

名稱	說明	價值觀
說明	手動動作描述。	字符串
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ManualActionDetails' （必要）

RecoveryPlanProtected專案

名稱	說明	價值觀
識別碼	復原方案受保護專案的 ARM 識別碼。	字符串
虛擬機器ID	虛擬機標識碼。	字符串

RecoveryPlanProviderSpecificInput

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanA2AInput 類型的 『A2A』。	'A2A' （必要）

RecoveryPlanScriptActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ScriptActionDetails' （必要）
路徑	腳本路徑。	字串 （必要）
超時	腳本逾時。	字符串

使用範例

Terraform （AzAPI 提供者） 資源定義

保存庫/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 = {
    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"
  primaryZone = "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

名稱	說明	價值觀
名稱	資源名稱	字串 （必要）
父項識別碼	此資源為父系之資源的標識碼。	類型的資源標識碼：保存庫
屬性	復原計劃建立屬性。	CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties （必要）
類型	資源類型	“Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-03-01”

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

名稱	說明	價值觀
failoverDeploymentModel	故障轉移部署模型。	“經典” '不適用' '資源管理員'
群組	復原方案群組。	RecoveryPlanGroup[] （必要）
primaryFabricId	主要網狀架構標識碼。	字串 （必要）
providerSpecificInput	提供者特定的輸入。	RecoveryPlanProviderSpecificInput[]
recoveryFabricId	復原網狀架構標識碼。	字串 （必要）

RecoveryPlanA2Anput

名稱	說明	價值觀
instanceType	取得實例類型。	'A2A' （必要）
primaryZone （主區）	主要區域。	字符串
recoveryZone （恢復區）	復原區域。	字符串

RecoveryPlanAction作

名稱	說明	價值觀
作名稱	動作名稱。	字串 （必要）
自訂詳細資訊	自訂詳細數據。	RecoveryPlanActionDetails （必要）
failoverDirections	故障轉移指示的清單。	包含任何的字串數組： “PrimaryToRecovery” 'RecoveryToPrimary' （必要）
failover類型	故障轉移類型清單。	包含任何的字串數組： 'ChangePit' “提交” “完成遷移” 'DisableProtection' '容錯回復' “FinalizeFailback” “計劃故障轉移” “修復複製” '反向複製' “開關保護” “TestFailover” “TestFailoverCleanup” 'UnplannedFailover' （必要）

RecoveryPlanActionDetails

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanAutomationRunbookActionDetails 類型的 'AutomationRunbookActionDetails'。 設定為 RecoveryPlanManualActionDetails 類型的 'ManualActionDetails'。 設定為 RecoveryPlanScriptActionDetails 類型的 'ScriptActionDetails'。	“AutomationRunbookActionDetails” 'ManualActionDetails' 'ScriptActionDetails' （必要）

RecoveryPlanAutomationRunbookActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'AutomationRunbookActionDetails' （必要）
RunbookId	Runbook ARM 識別碼。	字符串
超時	Runbook 逾時。	字符串

RecoveryPlanGroup （恢復計劃組）

名稱	說明	價值觀
endGroupActions	結束群組動作。	RecoveryPlanAction[]
群組類型	群組類型。	'靴子' “故障轉移” 'Shutdown' （必要）
replicationProtectedItems	受保護的項目清單。	RecoveryPlanProtectedItem[]
startGroupActions	開始群組動作。	RecoveryPlanAction[]

RecoveryPlanManualAction詳細資訊

名稱	說明	價值觀
說明	手動動作描述。	字符串
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ManualActionDetails' （必要）

RecoveryPlanProtected專案

名稱	說明	價值觀
識別碼	復原方案受保護專案的 ARM 識別碼。	字符串
虛擬機器ID	虛擬機標識碼。	字符串

RecoveryPlanProviderSpecificInput

名稱	說明	價值觀
instanceType	設定為 RecoveryPlanA2AInput 類型的 『A2A』。	'A2A' （必要）

RecoveryPlanScriptActionDetails

名稱	說明	價值觀
fabricLocation	網狀架構位置。	“主要” 'Recovery' （必要）
instanceType	取得動作詳細數據的類型（如需可能的值，請參閱 RecoveryPlanActionDetailsTypes 列舉）。	'ScriptActionDetails' （必要）
路徑	腳本路徑。	字串 （必要）
超時	腳本逾時。	字符串