Lire en anglais

Partager via

Coffres Microsoft.RecoveryServices/replicationRecoveryPlans 2023-02-01

  • Article
Choisir une langue de déploiement

Définition de ressource Bicep

Le type de ressource vaults/replicationRecoveryPlans peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, ajoutez le bicep suivant à votre modèle.

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

Objets RecoveryPlanProviderSpecificInput

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour A2A, utilisez :

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

Objets RecoveryPlanActionDetails

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour AutomationRunbookActionDetails, utilisez :

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

Pour ManualActionDetails, utilisez :

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

Pour scriptActionDetails, utilisez :

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

Valeurs de propriété

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Nom Description Valeur
failoverDeploymentModel Modèle de déploiement de basculement. 'Classique'
'NotApplicable'
'ResourceManager'
groupe Groupes de plans de récupération. RecoveryPlanGroup[] (obligatoire)
primaryFabricId ID de l’infrastructure principale. chaîne (obligatoire)
providerSpecificInput Entrée spécifique du fournisseur. RecoveryPlanProviderSpecificInput[]
recoveryFabricId ID de l’infrastructure de récupération. chaîne (obligatoire)

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. chaîne (obligatoire)
type Type d’emplacement étendu. 'EdgeZone' (obligatoire)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : coffres
Propriétés Propriétés de création du plan de récupération. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (obligatoire)

RecoveryPlanA2AInput

Nom Description Valeur
instanceType Obtient le type d’instance. 'A2A' (obligatoire)
primaryExtendedLocation Emplacement étendu principal. ExtendedLocation
primaryZone Zone primaire. corde
recoveryExtendedLocation Emplacement étendu de récupération. ExtendedLocation
recoveryZone Zone de récupération. corde

RecoveryPlanAction

Nom Description Valeur
actionName Nom de l’action. chaîne (obligatoire)
customDetails Détails personnalisés. RecoveryPlanActionDetails (obligatoire)
failoverDirections Liste des instructions de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'PrimaryToRecovery'
'RecoveryToPrimary' (obligatoire)
failoverTypes Liste des types de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Restauration automatique'
'FinaliseFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (obligatoire)

RecoveryPlanActionDetails

Nom Description Valeur
instanceType Défini sur « AutomationRunbookActionDetails » pour le type RecoveryPlanAutomationRunbookActionDetails. Défini sur « ManualActionDetails » pour le type RecoveryPlanManualActionDetails. Défini sur « ScriptActionDetails » pour le type RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (obligatoire)

RecoveryPlanAutomationRunbookActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'AutomationRunbookActionDetails' (obligatoire)
runbookId ID ARM du runbook. corde
Timeout Délai d’expiration du runbook. corde

RecoveryPlanGroup

Nom Description Valeur
endGroupActions Actions de groupe final. RecoveryPlanAction[]
groupType Type de groupe. 'Boot'
'Basculement'
'Shutdown' (obligatoire)
replicationProtectedItems Liste des éléments protégés. RecoveryPlanProtectedItem[]
startGroupActions Actions de groupe de démarrage. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Nom Description Valeur
description Description de l’action manuelle. corde
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ManualActionDetails' (obligatoire)

RecoveryPlanProtectedItem

Nom Description Valeur
id ID ARM de l’élément protégé du plan de récupération. corde
virtualMachineId ID de la machine virtuelle. corde

RecoveryPlanProviderSpecificInput

Nom Description Valeur
instanceType Défini sur « A2A » pour le type RecoveryPlanA2AInput. 'A2A' (obligatoire)

RecoveryPlanScriptActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ScriptActionDetails' (obligatoire)
chemin Chemin d’accès du script. chaîne (obligatoire)
Timeout Délai d’expiration du script. corde

Définition de ressource de modèle ARM

Le type de ressource vaults/replicationRecoveryPlans peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, ajoutez le code JSON suivant à votre modèle.

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

Objets RecoveryPlanProviderSpecificInput

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour A2A, utilisez :

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

Objets RecoveryPlanActionDetails

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour AutomationRunbookActionDetails, utilisez :

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

Pour ManualActionDetails, utilisez :

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

Pour scriptActionDetails, utilisez :

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

Valeurs de propriété

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Nom Description Valeur
failoverDeploymentModel Modèle de déploiement de basculement. 'Classique'
'NotApplicable'
'ResourceManager'
groupe Groupes de plans de récupération. RecoveryPlanGroup[] (obligatoire)
primaryFabricId ID de l’infrastructure principale. chaîne (obligatoire)
providerSpecificInput Entrée spécifique du fournisseur. RecoveryPlanProviderSpecificInput[]
recoveryFabricId ID de l’infrastructure de récupération. chaîne (obligatoire)

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. chaîne (obligatoire)
type Type d’emplacement étendu. 'EdgeZone' (obligatoire)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Nom Description Valeur
apiVersion Version de l’API '2023-02-01'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de création du plan de récupération. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (obligatoire)
type Type de ressource 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans'

RecoveryPlanA2AInput

Nom Description Valeur
instanceType Obtient le type d’instance. 'A2A' (obligatoire)
primaryExtendedLocation Emplacement étendu principal. ExtendedLocation
primaryZone Zone primaire. corde
recoveryExtendedLocation Emplacement étendu de récupération. ExtendedLocation
recoveryZone Zone de récupération. corde

RecoveryPlanAction

Nom Description Valeur
actionName Nom de l’action. chaîne (obligatoire)
customDetails Détails personnalisés. RecoveryPlanActionDetails (obligatoire)
failoverDirections Liste des instructions de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'PrimaryToRecovery'
'RecoveryToPrimary' (obligatoire)
failoverTypes Liste des types de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Restauration automatique'
'FinaliseFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (obligatoire)

RecoveryPlanActionDetails

Nom Description Valeur
instanceType Défini sur « AutomationRunbookActionDetails » pour le type RecoveryPlanAutomationRunbookActionDetails. Défini sur « ManualActionDetails » pour le type RecoveryPlanManualActionDetails. Défini sur « ScriptActionDetails » pour le type RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (obligatoire)

RecoveryPlanAutomationRunbookActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'AutomationRunbookActionDetails' (obligatoire)
runbookId ID ARM du runbook. corde
Timeout Délai d’expiration du runbook. corde

RecoveryPlanGroup

Nom Description Valeur
endGroupActions Actions de groupe final. RecoveryPlanAction[]
groupType Type de groupe. 'Boot'
'Basculement'
'Shutdown' (obligatoire)
replicationProtectedItems Liste des éléments protégés. RecoveryPlanProtectedItem[]
startGroupActions Actions de groupe de démarrage. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Nom Description Valeur
description Description de l’action manuelle. corde
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ManualActionDetails' (obligatoire)

RecoveryPlanProtectedItem

Nom Description Valeur
id ID ARM de l’élément protégé du plan de récupération. corde
virtualMachineId ID de la machine virtuelle. corde

RecoveryPlanProviderSpecificInput

Nom Description Valeur
instanceType Défini sur « A2A » pour le type RecoveryPlanA2AInput. 'A2A' (obligatoire)

RecoveryPlanScriptActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ScriptActionDetails' (obligatoire)
chemin Chemin d’accès du script. chaîne (obligatoire)
Timeout Délai d’expiration du script. corde

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource vaults/replicationRecoveryPlans peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, ajoutez le terraform suivant à votre modèle.

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

Objets RecoveryPlanProviderSpecificInput

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour A2A, utilisez :

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

Objets RecoveryPlanActionDetails

Définissez la propriété instanceType pour spécifier le type d’objet.

Pour AutomationRunbookActionDetails, utilisez :

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

Pour ManualActionDetails, utilisez :

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

Pour scriptActionDetails, utilisez :

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

Valeurs de propriété

CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties

Nom Description Valeur
failoverDeploymentModel Modèle de déploiement de basculement. 'Classique'
'NotApplicable'
'ResourceManager'
groupe Groupes de plans de récupération. RecoveryPlanGroup[] (obligatoire)
primaryFabricId ID de l’infrastructure principale. chaîne (obligatoire)
providerSpecificInput Entrée spécifique du fournisseur. RecoveryPlanProviderSpecificInput[]
recoveryFabricId ID de l’infrastructure de récupération. chaîne (obligatoire)

ExtendedLocation

Nom Description Valeur
nom Nom de l’emplacement étendu. chaîne (obligatoire)
type Type d’emplacement étendu. 'EdgeZone' (obligatoire)

Microsoft.RecoveryServices/vaults/replicationRecoveryPlans

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : coffres
Propriétés Propriétés de création du plan de récupération. CreateRecoveryPlanInputPropertiesOrRecoveryPlanProperties (obligatoire)
type Type de ressource « Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2023-02-01 »

RecoveryPlanA2AInput

Nom Description Valeur
instanceType Obtient le type d’instance. 'A2A' (obligatoire)
primaryExtendedLocation Emplacement étendu principal. ExtendedLocation
primaryZone Zone primaire. corde
recoveryExtendedLocation Emplacement étendu de récupération. ExtendedLocation
recoveryZone Zone de récupération. corde

RecoveryPlanAction

Nom Description Valeur
actionName Nom de l’action. chaîne (obligatoire)
customDetails Détails personnalisés. RecoveryPlanActionDetails (obligatoire)
failoverDirections Liste des instructions de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'PrimaryToRecovery'
'RecoveryToPrimary' (obligatoire)
failoverTypes Liste des types de basculement. Tableau de chaînes contenant l’un des éléments suivants :
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Restauration automatique'
'FinaliseFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (obligatoire)

RecoveryPlanActionDetails

Nom Description Valeur
instanceType Défini sur « AutomationRunbookActionDetails » pour le type RecoveryPlanAutomationRunbookActionDetails. Défini sur « ManualActionDetails » pour le type RecoveryPlanManualActionDetails. Défini sur « ScriptActionDetails » pour le type RecoveryPlanScriptActionDetails. 'AutomationRunbookActionDetails'
'ManualActionDetails'
'ScriptActionDetails' (obligatoire)

RecoveryPlanAutomationRunbookActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'AutomationRunbookActionDetails' (obligatoire)
runbookId ID ARM du runbook. corde
Timeout Délai d’expiration du runbook. corde

RecoveryPlanGroup

Nom Description Valeur
endGroupActions Actions de groupe final. RecoveryPlanAction[]
groupType Type de groupe. 'Boot'
'Basculement'
'Shutdown' (obligatoire)
replicationProtectedItems Liste des éléments protégés. RecoveryPlanProtectedItem[]
startGroupActions Actions de groupe de démarrage. RecoveryPlanAction[]

RecoveryPlanManualActionDetails

Nom Description Valeur
description Description de l’action manuelle. corde
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ManualActionDetails' (obligatoire)

RecoveryPlanProtectedItem

Nom Description Valeur
id ID ARM de l’élément protégé du plan de récupération. corde
virtualMachineId ID de la machine virtuelle. corde

RecoveryPlanProviderSpecificInput

Nom Description Valeur
instanceType Défini sur « A2A » pour le type RecoveryPlanA2AInput. 'A2A' (obligatoire)

RecoveryPlanScriptActionDetails

Nom Description Valeur
fabricLocation Emplacement de l’infrastructure. 'Primary'
'Recovery' (obligatoire)
instanceType Obtient le type de détails d’action (voir l’énumération RecoveryPlanActionDetailsTypes pour les valeurs possibles). 'ScriptActionDetails' (obligatoire)
chemin Chemin d’accès du script. chaîne (obligatoire)
Timeout Délai d’expiration du script. corde