Freigeben über


Microsoft.RecoveryServices Vaults/replicationRecoveryPlans 2023-08-01

Bicep-Ressourcendefinition

Der Ressourcentyp Vaults/replicationRecoveryPlans kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.RecoveryServices/vaults/replicationRecoveryPlans-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

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

RecoveryPlanActionDetails-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AutomationRunbookActionDetails:

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

Verwenden Sie für ManualActionDetails-:

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

Verwenden Sie für ScriptActionDetails-:

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

RecoveryPlanProviderSpecificInput-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für A2A-:

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

Eigenschaftswerte

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Beschreibung Wert
failoverDeploymentModel Das Failoverbereitstellungsmodell. "Klassisch"
'NotApplicable'
'ResourceManager'
Gruppen Die Wiederherstellungsplangruppen. RecoveryPlanGroup-[] (erforderlich)
primaryFabricId Die primäre Fabric-ID. Zeichenfolge (erforderlich)
providerSpecificInput Die anbieterspezifische Eingabe. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Die Wiederherstellungs-Fabric-ID. Zeichenfolge (erforderlich)

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
Art Der erweiterte Standorttyp. "EdgeZone" (erforderlich)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: Tresore
Eigenschaften Erstellungseigenschaften des Wiederherstellungsplans. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (erforderlich)

RecoveryPlanA2AInput

Name Beschreibung Wert
instanceType Ruft den Instanztyp ab. "A2A" (erforderlich)
primaryExtendedLocation Der primäre erweiterte Speicherort. ExtendedLocation-
primaryZone Die primäre Zone. Schnur
recoveryExtendedLocation Der erweiterte Wiederherstellungsspeicherort. ExtendedLocation-
recoveryZone Die Wiederherstellungszone. Schnur

RecoveryPlanAction

Name Beschreibung Wert
actionName Der Aktionsname. Zeichenfolge (erforderlich)
customDetails Die benutzerdefinierten Details. RecoveryPlanActionDetails- (erforderlich)
failoverDirections Die Liste der Failoverbeschreibungen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'PrimaryToRecovery'
'RecoveryToPrimary' (erforderlich)
failoverTypes Die Liste der Failovertypen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
"DisableProtection"
'Failback'
"FinalizeFailback"
"PlanFailover"
'RepairReplication'
'ReverseReplicate'
"SwitchProtection"
"TestFailover"
"TestFailoverCleanup"
"UnplannedFailover" (erforderlich)

RecoveryPlanActionDetails

Name Beschreibung Wert
instanceType Set to 'AutomationRunbookActionDetails' for type RecoveryPlanAutomationRunbookActionDetails. Set to 'ManualActionDetails' for type RecoveryPlanManualActionDetails. Set to 'ScriptActionDetails' for type RecoveryPlanScriptActionDetails. "AutomationRunbookActionDetails"
"ManualActionDetails"
'ScriptActionDetails' (erforderlich)

RecoveryPlanAutomationRunbookActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "AutomationRunbookActionDetails" (erforderlich)
runbookId Die Runbook-ARM-ID. Schnur
Zeitüberschreitung Das Runbook-Timeout. Schnur

RecoveryPlanGroup

Name Beschreibung Wert
endGroupActions Die Endgruppenaktionen. RecoveryPlanAction[]
groupType Der Gruppentyp. "Start"
'Failover'
"Herunterfahren" (erforderlich)
replicationProtectedItems Die Liste der geschützten Elemente. RecoveryPlanProtectedItem-[]
startGroupActions Die Startgruppenaktionen. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Beschreibung Wert
Beschreibung Die Beschreibung der manuellen Aktion. Schnur
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "ManualActionDetails" (erforderlich)

RecoveryPlanProtectedItem

Name Beschreibung Wert
id Die ARM-ID des geschützten Elements des Wiederherstellungsplans. Schnur
virtualMachineId Die ID des virtuellen Computers. Schnur

RecoveryPlanProviderSpecificInput

Name Beschreibung Wert
instanceType Legen Sie für den Typ RecoveryPlanA2AInput-auf "A2A" fest. "A2A" (erforderlich)

RecoveryPlanScriptActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). 'ScriptActionDetails' (erforderlich)
Pfad Der Skriptpfad. Zeichenfolge (erforderlich)
Zeitüberschreitung Das Skripttimeout. Schnur

ARM-Vorlagenressourcendefinition

Der Ressourcentyp Vaults/replicationRecoveryPlans kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.RecoveryServices/vaults/replicationRecoveryPlans-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "apiVersion": "2023-08-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-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AutomationRunbookActionDetails:

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

Verwenden Sie für ManualActionDetails-:

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

Verwenden Sie für ScriptActionDetails-:

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

RecoveryPlanProviderSpecificInput-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für A2A-:

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

Eigenschaftswerte

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Beschreibung Wert
failoverDeploymentModel Das Failoverbereitstellungsmodell. "Klassisch"
'NotApplicable'
'ResourceManager'
Gruppen Die Wiederherstellungsplangruppen. RecoveryPlanGroup-[] (erforderlich)
primaryFabricId Die primäre Fabric-ID. Zeichenfolge (erforderlich)
providerSpecificInput Die anbieterspezifische Eingabe. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Die Wiederherstellungs-Fabric-ID. Zeichenfolge (erforderlich)

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
Art Der erweiterte Standorttyp. "EdgeZone" (erforderlich)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Name Beschreibung Wert
apiVersion Die API-Version '2023-08-01'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Erstellungseigenschaften des Wiederherstellungsplans. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans"

RecoveryPlanA2AInput

Name Beschreibung Wert
instanceType Ruft den Instanztyp ab. "A2A" (erforderlich)
primaryExtendedLocation Der primäre erweiterte Speicherort. ExtendedLocation-
primaryZone Die primäre Zone. Schnur
recoveryExtendedLocation Der erweiterte Wiederherstellungsspeicherort. ExtendedLocation-
recoveryZone Die Wiederherstellungszone. Schnur

RecoveryPlanAction

Name Beschreibung Wert
actionName Der Aktionsname. Zeichenfolge (erforderlich)
customDetails Die benutzerdefinierten Details. RecoveryPlanActionDetails- (erforderlich)
failoverDirections Die Liste der Failoverbeschreibungen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'PrimaryToRecovery'
'RecoveryToPrimary' (erforderlich)
failoverTypes Die Liste der Failovertypen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
"DisableProtection"
'Failback'
"FinalizeFailback"
"PlanFailover"
'RepairReplication'
'ReverseReplicate'
"SwitchProtection"
"TestFailover"
"TestFailoverCleanup"
"UnplannedFailover" (erforderlich)

RecoveryPlanActionDetails

Name Beschreibung Wert
instanceType Set to 'AutomationRunbookActionDetails' for type RecoveryPlanAutomationRunbookActionDetails. Set to 'ManualActionDetails' for type RecoveryPlanManualActionDetails. Set to 'ScriptActionDetails' for type RecoveryPlanScriptActionDetails. "AutomationRunbookActionDetails"
"ManualActionDetails"
'ScriptActionDetails' (erforderlich)

RecoveryPlanAutomationRunbookActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "AutomationRunbookActionDetails" (erforderlich)
runbookId Die Runbook-ARM-ID. Schnur
Zeitüberschreitung Das Runbook-Timeout. Schnur

RecoveryPlanGroup

Name Beschreibung Wert
endGroupActions Die Endgruppenaktionen. RecoveryPlanAction[]
groupType Der Gruppentyp. "Start"
'Failover'
"Herunterfahren" (erforderlich)
replicationProtectedItems Die Liste der geschützten Elemente. RecoveryPlanProtectedItem-[]
startGroupActions Die Startgruppenaktionen. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Beschreibung Wert
Beschreibung Die Beschreibung der manuellen Aktion. Schnur
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "ManualActionDetails" (erforderlich)

RecoveryPlanProtectedItem

Name Beschreibung Wert
id Die ARM-ID des geschützten Elements des Wiederherstellungsplans. Schnur
virtualMachineId Die ID des virtuellen Computers. Schnur

RecoveryPlanProviderSpecificInput

Name Beschreibung Wert
instanceType Legen Sie für den Typ RecoveryPlanA2AInput-auf "A2A" fest. "A2A" (erforderlich)

RecoveryPlanScriptActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). 'ScriptActionDetails' (erforderlich)
Pfad Der Skriptpfad. Zeichenfolge (erforderlich)
Zeitüberschreitung Das Skripttimeout. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp Vaults/replicationRecoveryPlans kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.RecoveryServices/vaults/replicationRecoveryPlans-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

RecoveryPlanActionDetails-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für AutomationRunbookActionDetails:

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

Verwenden Sie für ManualActionDetails-:

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

Verwenden Sie für ScriptActionDetails-:

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

RecoveryPlanProviderSpecificInput-Objekte

Legen Sie die instanceType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für A2A-:

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

Eigenschaftswerte

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Name Beschreibung Wert
failoverDeploymentModel Das Failoverbereitstellungsmodell. "Klassisch"
'NotApplicable'
'ResourceManager'
Gruppen Die Wiederherstellungsplangruppen. RecoveryPlanGroup-[] (erforderlich)
primaryFabricId Die primäre Fabric-ID. Zeichenfolge (erforderlich)
providerSpecificInput Die anbieterspezifische Eingabe. RecoveryPlanProviderSpecificInput[]
recoveryFabricId Die Wiederherstellungs-Fabric-ID. Zeichenfolge (erforderlich)

ExtendedLocation

Name Beschreibung Wert
Name Der Name des erweiterten Speicherorts. Zeichenfolge (erforderlich)
Art Der erweiterte Standorttyp. "EdgeZone" (erforderlich)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Vaults
Eigenschaften Erstellungseigenschaften des Wiederherstellungsplans. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2023-08-01"

RecoveryPlanA2AInput

Name Beschreibung Wert
instanceType Ruft den Instanztyp ab. "A2A" (erforderlich)
primaryExtendedLocation Der primäre erweiterte Speicherort. ExtendedLocation-
primaryZone Die primäre Zone. Schnur
recoveryExtendedLocation Der erweiterte Wiederherstellungsspeicherort. ExtendedLocation-
recoveryZone Die Wiederherstellungszone. Schnur

RecoveryPlanAction

Name Beschreibung Wert
actionName Der Aktionsname. Zeichenfolge (erforderlich)
customDetails Die benutzerdefinierten Details. RecoveryPlanActionDetails- (erforderlich)
failoverDirections Die Liste der Failoverbeschreibungen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'PrimaryToRecovery'
'RecoveryToPrimary' (erforderlich)
failoverTypes Die Liste der Failovertypen. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
"DisableProtection"
'Failback'
"FinalizeFailback"
"PlanFailover"
'RepairReplication'
'ReverseReplicate'
"SwitchProtection"
"TestFailover"
"TestFailoverCleanup"
"UnplannedFailover" (erforderlich)

RecoveryPlanActionDetails

Name Beschreibung Wert
instanceType Set to 'AutomationRunbookActionDetails' for type RecoveryPlanAutomationRunbookActionDetails. Set to 'ManualActionDetails' for type RecoveryPlanManualActionDetails. Set to 'ScriptActionDetails' for type RecoveryPlanScriptActionDetails. "AutomationRunbookActionDetails"
"ManualActionDetails"
'ScriptActionDetails' (erforderlich)

RecoveryPlanAutomationRunbookActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "AutomationRunbookActionDetails" (erforderlich)
runbookId Die Runbook-ARM-ID. Schnur
Zeitüberschreitung Das Runbook-Timeout. Schnur

RecoveryPlanGroup

Name Beschreibung Wert
endGroupActions Die Endgruppenaktionen. RecoveryPlanAction[]
groupType Der Gruppentyp. "Start"
'Failover'
"Herunterfahren" (erforderlich)
replicationProtectedItems Die Liste der geschützten Elemente. RecoveryPlanProtectedItem-[]
startGroupActions Die Startgruppenaktionen. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Name Beschreibung Wert
Beschreibung Die Beschreibung der manuellen Aktion. Schnur
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). "ManualActionDetails" (erforderlich)

RecoveryPlanProtectedItem

Name Beschreibung Wert
id Die ARM-ID des geschützten Elements des Wiederherstellungsplans. Schnur
virtualMachineId Die ID des virtuellen Computers. Schnur

RecoveryPlanProviderSpecificInput

Name Beschreibung Wert
instanceType Legen Sie für den Typ RecoveryPlanA2AInput-auf "A2A" fest. "A2A" (erforderlich)

RecoveryPlanScriptActionDetails

Name Beschreibung Wert
fabricLocation Der Fabric-Speicherort. 'Primär'
"Wiederherstellung" (erforderlich)
instanceType Ruft den Typ der Aktionsdetails ab (siehe RecoveryPlanActionDetailsTypes-Enumeration für mögliche Werte). 'ScriptActionDetails' (erforderlich)
Pfad Der Skriptpfad. Zeichenfolge (erforderlich)
Zeitüberschreitung Das Skripttimeout. Schnur