Share via


Microsoft.RecoveryServices コンテナー/replicationRecoveryPlans 2022-03-01

Bicep リソース定義

コンテナー/replicationRecoveryPlans リソースの種類は、次の場所にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-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'
  primaryExtendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  primaryZone: 'string'
  recoveryExtendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  recoveryZone: 'string'

プロパティ値

vaults/replicationRecoveryPlans

Name 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: コンテナー
properties 復旧計画の作成プロパティ。 CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (必須)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Name 説明
failoverDeploymentModel フェールオーバー デプロイ モデル。 'Classic'
'NotApplicable'
'ResourceManager'
groups 復旧計画グループ。 RecoveryPlanGroup[] (必須)
primaryFabricId プライマリ ファブリック ID。 string (必須)
providerSpecificInput プロバイダー固有の入力。 RecoveryPlanProviderSpecificInput[]
recoveryFabricId 回復ファブリック ID。 string (必須)

RecoveryPlanGroup

Name 説明
endGroupActions グループの終了アクション。 RecoveryPlanAction[]
groupType グループの種類。 'Boot'
'フェールオーバー'
'Shutdown' (必須)
replicationProtectedItems 保護された項目の一覧。 RecoveryPlanProtectedItem[]
startGroupActions グループの開始アクション。 RecoveryPlanAction[]

RecoveryPlanAction

Name 説明
actionName アクション名。 string (必須)
customDetails カスタムの詳細。 RecoveryPlanActionDetails (必須)
failoverDirections フェールオーバーの方向の一覧。 次のいずれかを含む文字列配列:
'PrimaryToRecovery'
'RecoveryToPrimary' (必須)
failoverTypes フェールオーバーの種類の一覧。 次のいずれかを含む文字列配列:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'フェールバック'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (必須)

RecoveryPlanActionDetails

Name 説明
instanceType オブジェクトの種類を設定する AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (必須)

RecoveryPlanAutomationRunbookActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'AutomationRunbookActionDetails' (必須)
fabricLocation ファブリックの場所。 'Primary'
'Recovery' (必須)
RunbookId Runbook ARM ID。 string
timeout Runbook のタイムアウト。 string

RecoveryPlanManualActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'ManualActionDetails' (必須)
description 手動アクションの説明。 string

RecoveryPlanScriptActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'ScriptActionDetails' (必須)
fabricLocation ファブリックの場所。 'Primary'
'Recovery' (必須)
path スクリプト パス。 string (必須)
timeout スクリプトのタイムアウト。 string

RecoveryPlanProtectedItem

Name 説明
id 復旧計画で保護された項目の ARM ID。 string
virtualMachineId 仮想マシン ID。 string

RecoveryPlanProviderSpecificInput

Name 説明
instanceType オブジェクトの種類を設定する A2A (必須)

RecoveryPlanA2AInput

Name 説明
instanceType インスタンスの種類を取得します。 'A2A' (必須)
primaryExtendedLocation プライマリ拡張場所。 ExtendedLocation
primaryZone プライマリ ゾーン。 string
recoveryExtendedLocation 回復の拡張場所。 ExtendedLocation
recoveryZone 回復ゾーン。 string

ExtendedLocation

Name 説明
name 拡張場所の名前。 string (必須)
拡張場所の種類。 'EdgeZone' (必須)

ARM テンプレート リソース定義

コンテナー/replicationRecoveryPlans リソースの種類は、次の場所にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans リソースを作成するには、テンプレートに次の JSON を追加します。

{
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "apiVersion": "2022-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",
  "primaryExtendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "primaryZone": "string",
  "recoveryExtendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "recoveryZone": "string"

プロパティ値

vaults/replicationRecoveryPlans

Name 説明
type リソースの種類 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans'
apiVersion リソース API のバージョン '2022-03-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
properties 復旧計画の作成プロパティ。 CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (必須)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Name 説明
failoverDeploymentModel フェールオーバー デプロイ モデル。 'Classic'
'NotApplicable'
'ResourceManager'
groups 復旧計画グループ。 RecoveryPlanGroup[] (必須)
primaryFabricId プライマリ ファブリック ID。 string (必須)
providerSpecificInput プロバイダー固有の入力。 RecoveryPlanProviderSpecificInput[]
recoveryFabricId 回復ファブリック ID。 string (必須)

RecoveryPlanGroup

Name 説明
endGroupActions グループの終了アクション。 RecoveryPlanAction[]
groupType グループの種類。 'Boot'
'フェールオーバー'
'Shutdown' (必須)
replicationProtectedItems 保護されたアイテムの一覧。 RecoveryPlanProtectedItem[]
startGroupActions グループの開始アクション。 RecoveryPlanAction[]

RecoveryPlanAction

Name 説明
actionName アクション名。 string (必須)
customDetails カスタムの詳細。 RecoveryPlanActionDetails (必須)
failoverDirections フェールオーバーの方向の一覧。 次のいずれかを含む文字列配列:
'PrimaryToRecovery'
'RecoveryToPrimary' (必須)
failoverTypes フェールオーバーの種類の一覧。 次のいずれかを含む文字列配列:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'フェールバック'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (必須)

RecoveryPlanActionDetails

Name 説明
instanceType オブジェクトの種類を設定する AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (必須)

RecoveryPlanAutomationRunbookActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'AutomationRunbookActionDetails' (必須)
fabricLocation ファブリックの場所。 'Primary'
'Recovery' (必須)
RunbookId Runbook ARM ID。 string
timeout Runbook のタイムアウト。 string

RecoveryPlanManualActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'ManualActionDetails' (必須)
description 手動アクションの説明。 string

RecoveryPlanScriptActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 'ScriptActionDetails' (必須)
fabricLocation ファブリックの場所。 'Primary'
'Recovery' (必須)
path スクリプト パス。 string (必須)
timeout スクリプトのタイムアウト。 string

RecoveryPlanProtectedItem

Name 説明
id 復旧計画で保護された項目の ARM ID。 string
virtualMachineId 仮想マシン ID。 string

RecoveryPlanProviderSpecificInput

Name 説明
instanceType オブジェクトの種類を設定する A2A (必須)

RecoveryPlanA2AInput

Name 説明
instanceType インスタンスの種類を取得します。 'A2A' (必須)
primaryExtendedLocation プライマリ拡張場所。 ExtendedLocation
primaryZone プライマリ ゾーン。 string
recoveryExtendedLocation 回復の拡張場所。 ExtendedLocation
recoveryZone 回復ゾーン。 string

ExtendedLocation

Name 説明
name 拡張場所の名前。 string (必須)
拡張場所の種類。 'EdgeZone' (必須)

Terraform (AzAPI プロバイダー) リソース定義

コンテナー/replicationRecoveryPlans リソースの種類は、次の場所にデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-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"
  primaryExtendedLocation = {
    name = "string"
    type = "EdgeZone"
  }
  primaryZone = "string"
  recoveryExtendedLocation = {
    name = "string"
    type = "EdgeZone"
  }
  recoveryZone = "string"

プロパティ値

vaults/replicationRecoveryPlans

Name 説明
type リソースの種類 "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2022-03-01"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: コンテナー
properties 復旧計画の作成プロパティ。 CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (必須)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Name 説明
failoverDeploymentModel フェールオーバー デプロイ モデル。 "クラシック"
"NotApplicable"
"ResourceManager"
groups 復旧計画グループ。 RecoveryPlanGroup[] (必須)
primaryFabricId プライマリ ファブリック ID。 string (必須)
providerSpecificInput プロバイダー固有の入力。 RecoveryPlanProviderSpecificInput[]
recoveryFabricId 回復ファブリック ID。 string (必須)

RecoveryPlanGroup

Name 説明
endGroupActions グループの終了アクション。 RecoveryPlanAction[]
groupType グループの種類。 "Boot"
"フェールオーバー"
"Shutdown" (必須)
replicationProtectedItems 保護されたアイテムの一覧。 RecoveryPlanProtectedItem[]
startGroupActions グループの開始アクション。 RecoveryPlanAction[]

RecoveryPlanAction

Name 説明
actionName アクション名。 string (必須)
customDetails カスタムの詳細。 RecoveryPlanActionDetails (必須)
failoverDirections フェールオーバーの方向の一覧。 次のいずれかを含む文字列配列:
"PrimaryToRecovery"
"RecoveryToPrimary" (必須)
failoverTypes フェールオーバーの種類の一覧。 次のいずれかを含む文字列配列:
"CancelFailover"
"ChangePit"
"コミット"
"CompleteMigration"
"DisableProtection"
"フェールバック"
"FinalizeFailback"
"PlannedFailover"
"RepairReplication"
"ReverseReplicate"
"SwitchProtection"
"TestFailover"
"TestFailoverCleanup"
"UnplannedFailover" (必須)

RecoveryPlanActionDetails

Name 説明
instanceType オブジェクトの種類を設定する AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (必須)

RecoveryPlanAutomationRunbookActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 "AutomationRunbookActionDetails" (必須)
fabricLocation ファブリックの場所。 "Primary"
"回復" (必須)
RunbookId Runbook ARM ID。 string
timeout Runbook のタイムアウト。 string

RecoveryPlanManualActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 "ManualActionDetails" (必須)
description 手動アクションの説明。 string

RecoveryPlanScriptActionDetails

Name 説明
instanceType アクションの詳細の種類を取得します (使用可能な値については、「RecoveryPlanActionDetailsTypes 列挙型」を参照してください)。 "ScriptActionDetails" (必須)
fabricLocation ファブリックの場所。 "Primary"
"回復" (必須)
path スクリプト パス。 string (必須)
timeout スクリプトのタイムアウト。 string

RecoveryPlanProtectedItem

Name 説明
id 復旧計画で保護された項目の ARM ID。 string
virtualMachineId 仮想マシン ID。 string

RecoveryPlanProviderSpecificInput

Name 説明
instanceType オブジェクトの種類を設定する A2A (必須)

RecoveryPlanA2AInput

Name 説明
instanceType インスタンス型を取得します。 "A2A" (必須)
primaryExtendedLocation プライマリ拡張場所。 ExtendedLocation
primaryZone プライマリ ゾーン。 string
recoveryExtendedLocation 回復の拡張場所。 ExtendedLocation
recoveryZone 回復ゾーン。 string

ExtendedLocation

Name 説明
name 拡張場所の名前。 string (必須)
拡張された場所の種類。 "EdgeZone" (必須)