Compartilhar via

Cofres microsoft.RecoveryServices/replicationRecoveryPlans 2024-01-01

  • Artigo

Definição de recurso do Bicep

O tipo de recurso vaults/replicationRecoveryPlans pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, adicione o seguinte Bicep ao modelo.

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

Objetos RecoveryPlanActionDetails

Defina a propriedade instanceType para especificar o tipo de objeto.

Para AutomationRunbookActionDetails, use:

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

Para ManualActionDetails, use:

  instanceType: 'ManualActionDetails'
  description: 'string'

Para ScriptActionDetails, use:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, use:

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

Valores de propriedade

vaults/replicationRecoveryPlans

Nome Descrição Valor
nome O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: cofres
Propriedades Propriedades de criação do plano de recuperação. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (obrigatório)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Nome Descrição Valor
failoverDeploymentModel O modelo de implantação de failover. 'Clássico'
'NotApplicable'
'ResourceManager'
Grupos Os grupos de planos de recuperação. RecoveryPlanGroup [] (obrigatório)
primaryFabricId A ID da malha primária. cadeia de caracteres (obrigatório)
providerSpecificInput A entrada específica do provedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId A ID da malha de recuperação. cadeia de caracteres (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction []
groupType O tipo de grupo. 'Inicialização'
'Failover'
'Desligamento' (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem []
startGroupActions As ações de grupo inicial. RecoveryPlanAction []

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia de caracteres (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
'PrimaryToRecovery'
'RecoveryToPrimary' (obrigatório)
failoverTypes A lista de tipos de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (obrigatório)

RecoveryPlanActionDetails

Nome Descrição Valor
instanceType Definir o tipo de objeto AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (obrigatório)

RecoveryPlanAutomationRunbookActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'AutomationRunbookActionDetails' (obrigatório)
fabricLocation O local da malha. 'Primário'
'Recuperação' (obrigatório)
runbookId A ID do ARM do runbook. corda
timeout O tempo limite do runbook. corda

RecoveryPlanManualActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'ManualActionDetails' (obrigatório)
descrição A descrição da ação manual. corda

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'ScriptActionDetails' (obrigatório)
fabricLocation O local da malha. 'Primário'
'Recuperação' (obrigatório)
caminho O caminho do script. cadeia de caracteres (obrigatório)
timeout O tempo limite do script. corda

RecoveryPlanProtectedItem

Nome Descrição Valor
id A ID do ARM do item protegido do plano de recuperação. corda
virtualMachineId A ID da máquina virtual. corda

RecoveryPlanProviderSpecificInput

Nome Descrição Valor
instanceType Definir o tipo de objeto A2A (obrigatório)

RecoveryPlanA2AInput

Nome Descrição Valor
instanceType Obtém o tipo de instância. 'A2A' (obrigatório)
primaryExtendedLocation O local estendido primário. ExtendedLocation
primaryZone A zona primária. corda
recoveryExtendedLocation O local estendido da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. corda

ExtendedLocation

Nome Descrição Valor
nome Nome do local estendido. corda
tipo Tipo do local estendido. Os valores possíveis incluem: 'EdgeZone' corda
nome O nome do local estendido. cadeia de caracteres (obrigatório)
tipo O tipo de local estendido. 'EdgeZone' (obrigatório)

Definição de recurso de modelo do ARM

O tipo de recurso vaults/replicationRecoveryPlans pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, adicione o JSON a seguir ao seu modelo.

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

Objetos RecoveryPlanActionDetails

Defina a propriedade instanceType para especificar o tipo de objeto.

Para AutomationRunbookActionDetails, use:

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

Para ManualActionDetails, use:

  "instanceType": "ManualActionDetails",
  "description": "string"

Para ScriptActionDetails, use:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, use:

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

Valores de propriedade

vaults/replicationRecoveryPlans

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans'
apiVersion A versão da API do recurso '2024-01-01'
nome O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
Propriedades Propriedades de criação do plano de recuperação. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (obrigatório)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Nome Descrição Valor
failoverDeploymentModel O modelo de implantação de failover. 'Clássico'
'NotApplicable'
'ResourceManager'
Grupos Os grupos de planos de recuperação. RecoveryPlanGroup [] (obrigatório)
primaryFabricId A ID da malha primária. cadeia de caracteres (obrigatório)
providerSpecificInput A entrada específica do provedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId A ID da malha de recuperação. cadeia de caracteres (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction []
groupType O tipo de grupo. 'Inicialização'
'Failover'
'Desligamento' (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem []
startGroupActions As ações de grupo inicial. RecoveryPlanAction []

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia de caracteres (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
'PrimaryToRecovery'
'RecoveryToPrimary' (obrigatório)
failoverTypes A lista de tipos de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
'CancelFailover'
'ChangePit'
'Commit'
'CompleteMigration'
'DisableProtection'
'Failback'
'FinalizeFailback'
'PlannedFailover'
'RepairReplication'
'ReverseReplicate'
'SwitchProtection'
'TestFailover'
'TestFailoverCleanup'
'UnplannedFailover' (obrigatório)

RecoveryPlanActionDetails

Nome Descrição Valor
instanceType Definir o tipo de objeto AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (obrigatório)

RecoveryPlanAutomationRunbookActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'AutomationRunbookActionDetails' (obrigatório)
fabricLocation O local da malha. 'Primário'
'Recuperação' (obrigatório)
runbookId A ID do ARM do runbook. corda
timeout O tempo limite do runbook. corda

RecoveryPlanManualActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'ManualActionDetails' (obrigatório)
descrição A descrição da ação manual. corda

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). 'ScriptActionDetails' (obrigatório)
fabricLocation O local da malha. 'Primário'
'Recuperação' (obrigatório)
caminho O caminho do script. cadeia de caracteres (obrigatório)
timeout O tempo limite do script. corda

RecoveryPlanProtectedItem

Nome Descrição Valor
id A ID do ARM do item protegido do plano de recuperação. corda
virtualMachineId A ID da máquina virtual. corda

RecoveryPlanProviderSpecificInput

Nome Descrição Valor
instanceType Definir o tipo de objeto A2A (obrigatório)

RecoveryPlanA2AInput

Nome Descrição Valor
instanceType Obtém o tipo de instância. 'A2A' (obrigatório)
primaryExtendedLocation O local estendido primário. ExtendedLocation
primaryZone A zona primária. corda
recoveryExtendedLocation O local estendido da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. corda

ExtendedLocation

Nome Descrição Valor
nome Nome do local estendido. corda
tipo Tipo do local estendido. Os valores possíveis incluem: 'EdgeZone' corda
nome O nome do local estendido. cadeia de caracteres (obrigatório)
tipo O tipo de local estendido. 'EdgeZone' (obrigatório)

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso vaults/replicationRecoveryPlans pode ser implantado com operações direcionadas:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.RecoveryServices/vaults/replicationRecoveryPlans, adicione o Terraform a seguir ao modelo.

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

Objetos RecoveryPlanActionDetails

Defina a propriedade instanceType para especificar o tipo de objeto.

Para AutomationRunbookActionDetails, use:

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

Para ManualActionDetails, use:

  instanceType = "ManualActionDetails"
  description = "string"

Para ScriptActionDetails, use:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, use:

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

Valores de propriedade

vaults/replicationRecoveryPlans

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2024-01-01"
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: cofres
Propriedades Propriedades de criação do plano de recuperação. CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope... (obrigatório)

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Nome Descrição Valor
failoverDeploymentModel O modelo de implantação de failover. "Clássico"
"NotApplicable"
"ResourceManager"
Grupos Os grupos de planos de recuperação. RecoveryPlanGroup [] (obrigatório)
primaryFabricId A ID da malha primária. cadeia de caracteres (obrigatório)
providerSpecificInput A entrada específica do provedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId A ID da malha de recuperação. cadeia de caracteres (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction []
groupType O tipo de grupo. "Inicialização"
"Failover"
"Desligamento" (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem []
startGroupActions As ações de grupo inicial. RecoveryPlanAction []

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia de caracteres (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
"PrimaryToRecovery"
"RecoveryToPrimary" (obrigatório)
failoverTypes A lista de tipos de failover. Matriz de cadeia de caracteres que contém qualquer um dos:
"CancelFailover"
"ChangePit"
"Confirmar"
"CompleteMigration"
"DisableProtection"
"Failback"
"FinalizeFailback"
"PlannedFailover"
"RepairReplication"
"ReverseReplicate"
"SwitchProtection"
"TestFailover"
"TestFailoverCleanup"
"UnplannedFailover" (obrigatório)

RecoveryPlanActionDetails

Nome Descrição Valor
instanceType Definir o tipo de objeto AutomationRunbookActionDetails
ManualActionDetails
ScriptActionDetails (obrigatório)

RecoveryPlanAutomationRunbookActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). "AutomationRunbookActionDetails" (obrigatório)
fabricLocation O local da malha. "Primário"
"Recuperação" (obrigatório)
runbookId A ID do ARM do runbook. corda
timeout O tempo limite do runbook. corda

RecoveryPlanManualActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). "ManualActionDetails" (obrigatório)
descrição A descrição da ação manual. corda

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes da ação (consulte RecoveryPlanActionDetailsTypes enumeração para possíveis valores). "ScriptActionDetails" (obrigatório)
fabricLocation O local da malha. "Primário"
"Recuperação" (obrigatório)
caminho O caminho do script. cadeia de caracteres (obrigatório)
timeout O tempo limite do script. corda

RecoveryPlanProtectedItem

Nome Descrição Valor
id A ID do ARM do item protegido do plano de recuperação. corda
virtualMachineId A ID da máquina virtual. corda

RecoveryPlanProviderSpecificInput

Nome Descrição Valor
instanceType Definir o tipo de objeto A2A (obrigatório)

RecoveryPlanA2AInput

Nome Descrição Valor
instanceType Obtém o tipo de instância. "A2A" (obrigatório)
primaryExtendedLocation O local estendido primário. ExtendedLocation
primaryZone A zona primária. corda
recoveryExtendedLocation O local estendido da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. corda

ExtendedLocation

Nome Descrição Valor
nome Nome do local estendido. corda
tipo Tipo do local estendido. Os valores possíveis incluem: 'EdgeZone' corda
nome O nome do local estendido. cadeia de caracteres (obrigatório)
tipo O tipo de local estendido. "EdgeZone" (obrigatório)