Cofres Microsoft.RecoveryServices/replicaçãoRecoveryPlans 2021-12-01

Definição de recurso do Bicep

O tipo de recurso vaults/replicationRecoveryPlans pode ser implementado em:

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

Formato do recurso

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-12-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, utilize:

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

Para ManualActionDetails, utilize:

  instanceType: 'ManualActionDetails'
  description: 'string'

Para ScriptActionDetails, utilize:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, utilize:

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

Valores de propriedade

cofres/replicaçãoRecoveryPlans

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.
cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

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

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Nome Descrição Valor
ativação pós-falhaDeploymentModel O modelo de implementação de ativação pós-falha. 'Clássico'
"NotApplicable"
"ResourceManager"
grupos Os grupos do plano de recuperação. RecoveryPlanGroup[] (obrigatório)
primaryFabricId O ID dos recursos de infraestrutura primários. cadeia (obrigatório)
providerSpecificInput A entrada específica do fornecedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId O ID dos recursos de infraestrutura de recuperação. cadeia (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction[]
tipodeGrupo O tipo de grupo. 'Arranque'
"Ativação pós-falha"
"Encerramento" (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem[]
startGroupActions As ações de grupo de início. RecoveryPlanAction[]

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de ativação pós-falha. Matriz de cadeia que contém qualquer um dos seguintes:
"PrimaryToRecovery"
"RecoveryToPrimary" (obrigatório)
failoverTypes A lista de tipos de ativação pós-falha. Matriz de cadeia que contém qualquer um dos seguintes:
"CancelFailover"
"ChangePit"
"Consolidar"
"CompleteMigration"
"DisableProtection"
"Reativação pós-falha"
"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 de ação (veja RecoveryPlanActionDetailsTypes enum para obter os valores possíveis). "AutomationRunbookActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Principal"
"Recuperação" (obrigatório)
runbookId O ID arm do runbook. string
tempo limite O tempo limite do runbook. string

RecoveryPlanManualActionDetails

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

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes de ação (veja RecoveryPlanActionDetailsTypes enum para obter os valores possíveis). "ScriptActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Principal"
"Recuperação" (obrigatório)
caminho O caminho do script. cadeia (obrigatório)
tempo limite O tempo limite do script. string

RecoveryPlanProtectedItem

Nome Descrição Valor
ID O ID arm do item protegido do plano de recuperação. string
virtualMachineId O ID da máquina virtual. string

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 A localização expandida primária. ExtendedLocation
zona primária A zona primária. string
recoveryExtendedLocation A localização expandida da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. string

ExtendedLocation

Nome Descrição Valor
name O nome da localização expandida. cadeia (obrigatório)
tipo O tipo de localização expandida. "EdgeZone" (obrigatório)

Definição de recurso do modelo arm

O tipo de recurso vaults/replicationRecoveryPlans pode ser implementado em:

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

Formato do recurso

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

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

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

Para ManualActionDetails, utilize:

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

Para ScriptActionDetails, utilize:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, utilize:

  "instanceType": "A2A",
  "primaryExtendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "primaryZone": "string",
  "recoveryExtendedLocation": {
    "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 de recursos '2021-12-01'
name O nome do recurso

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

CreateRecoveryPlanInputPropertiesOrRecoveryPlanPrope...

Nome Descrição Valor
failoverDeploymentModel O modelo de implementação de ativação pós-falha. 'Clássico'
"Não Aplicável"
"ResourceManager"
grupos Os grupos do plano de recuperação. RecoveryPlanGroup[] (obrigatório)
primaryFabricId O ID do recurso de infraestrutura principal. cadeia (obrigatório)
providerSpecificInput A entrada específica do fornecedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId O ID dos recursos de infraestrutura de recuperação. cadeia (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction[]
tipodeGrupo O tipo de grupo. 'Arranque'
"Ativação Pós-falha"
"Encerramento" (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem[]
startGroupActions As ações do grupo iniciar. RecoveryPlanAction[]

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de ativação pós-falha. Matriz de cadeias que contém qualquer um dos seguintes:
"PrimaryToRecovery"
"RecoveryToPrimary" (obrigatório)
failoverTypes A lista de tipos de ativação pós-falha. Matriz de cadeias que contém qualquer um dos seguintes:
"CancelFailover"
"ChangePit"
"Consolidar"
"CompleteMigration"
"DesativarProteção"
"Reativação pós-falha"
"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 de ação (veja RecoveryPlanActionDetailsTypes enum para valores possíveis). "AutomationRunbookActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Primário"
"Recuperação" (obrigatório)
runbookId O ID do ARM do runbook. string
tempo limite O tempo limite do runbook. string

RecoveryPlanManualActionDetails

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

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes de ação (veja RecoveryPlanActionDetailsTypes enum para valores possíveis). "ScriptActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Primário"
"Recuperação" (obrigatório)
caminho O caminho do script. cadeia (obrigatório)
tempo limite O tempo limite do script. string

RecoveryPlanProtectedItem

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

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 A localização expandida primária. ExtendedLocation
zona primária A zona primária. string
recoveryExtendedLocation A localização expandida da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. string

ExtendedLocation

Nome Descrição Valor
name O nome da localização expandida. cadeia (obrigatório)
tipo O tipo de localização expandida. "EdgeZone" (obrigatório)

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso vaults/replicationRecoveryPlans pode ser implementado em:

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-12-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, utilize:

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

Para ManualActionDetails, utilize:

  instanceType = "ManualActionDetails"
  description = "string"

Para ScriptActionDetails, utilize:

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

Objetos RecoveryPlanProviderSpecificInput

Defina a propriedade instanceType para especificar o tipo de objeto.

Para A2A, utilize:

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

Valores de propriedade

vaults/replicationRecoveryPlans

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans@2021-12-01"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este 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 implementação de ativação pós-falha. "Clássico"
"NotApplicable"
"ResourceManager"
grupos Os grupos do plano de recuperação. RecoveryPlanGroup[] (obrigatório)
primaryFabricId O ID do recurso de infraestrutura principal. cadeia (obrigatório)
providerSpecificInput A entrada específica do fornecedor. RecoveryPlanProviderSpecificInput[]
recoveryFabricId O ID dos recursos de infraestrutura de recuperação. cadeia (obrigatório)

RecoveryPlanGroup

Nome Descrição Valor
endGroupActions As ações do grupo final. RecoveryPlanAction[]
tipodeGrupo O tipo de grupo. "Arranque"
"Ativação Pós-falha"
"Encerramento" (obrigatório)
replicationProtectedItems A lista de itens protegidos. RecoveryPlanProtectedItem[]
startGroupActions As ações do grupo iniciar. RecoveryPlanAction[]

RecoveryPlanAction

Nome Descrição Valor
actionName O nome da ação. cadeia (obrigatório)
customDetails Os detalhes personalizados. RecoveryPlanActionDetails (obrigatório)
failoverDirections A lista de direções de ativação pós-falha. Matriz de cadeia que contém qualquer um dos seguintes:
"PrimaryToRecovery"
"RecoveryToPrimary" (obrigatório)
failoverTypes A lista de tipos de ativação pós-falha. Matriz de cadeia que contém qualquer um dos seguintes:
"CancelFailover"
"ChangePit"
"Consolidar"
"CompleteMigration"
"DisableProtection"
"Reativação pós-falha"
"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 de ação (veja RecoveryPlanActionDetailsTypes enum para obter os valores possíveis). "AutomationRunbookActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Principal"
"Recuperação" (obrigatório)
runbookId O ID arm do runbook. string
tempo limite O tempo limite do runbook. string

RecoveryPlanManualActionDetails

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

RecoveryPlanScriptActionDetails

Nome Descrição Valor
instanceType Obtém o tipo de detalhes de ação (veja RecoveryPlanActionDetailsTypes enum para obter os valores possíveis). "ScriptActionDetails" (obrigatório)
fabricLocation A localização dos recursos de infraestrutura. "Principal"
"Recuperação" (obrigatório)
caminho O caminho do script. cadeia (obrigatório)
tempo limite O tempo limite do script. string

RecoveryPlanProtectedItem

Nome Descrição Valor
ID O ID arm do item protegido do plano de recuperação. string
virtualMachineId O ID da máquina virtual. string

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 A localização expandida primária. ExtendedLocation
primaryZone A zona primária. string
recoveryExtendedLocation A localização expandida da recuperação. ExtendedLocation
recoveryZone A zona de recuperação. string

ExtendedLocation

Nome Descrição Valor
name O nome da localização expandida. cadeia (obrigatório)
tipo O tipo de localização expandida. "EdgeZone" (obrigatório)