Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. recoveryservices
  5. getReplicationRecoveryPlan
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.recoveryservices.getReplicationRecoveryPlan

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the details of the recovery plan. Azure REST API version: 2023-04-01.

Other available API versions: 2023-06-01, 2023-08-01, 2024-01-01, 2024-02-01, 2024-04-01, 2024-10-01.

Using getReplicationRecoveryPlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReplicationRecoveryPlan(args: GetReplicationRecoveryPlanArgs, opts?: InvokeOptions): Promise<GetReplicationRecoveryPlanResult>
function getReplicationRecoveryPlanOutput(args: GetReplicationRecoveryPlanOutputArgs, opts?: InvokeOptions): Output<GetReplicationRecoveryPlanResult>
Copy
def get_replication_recovery_plan(recovery_plan_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  resource_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetReplicationRecoveryPlanResult
def get_replication_recovery_plan_output(recovery_plan_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  resource_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetReplicationRecoveryPlanResult]
Copy
func LookupReplicationRecoveryPlan(ctx *Context, args *LookupReplicationRecoveryPlanArgs, opts ...InvokeOption) (*LookupReplicationRecoveryPlanResult, error)
func LookupReplicationRecoveryPlanOutput(ctx *Context, args *LookupReplicationRecoveryPlanOutputArgs, opts ...InvokeOption) LookupReplicationRecoveryPlanResultOutput
Copy

> Note: This function is named LookupReplicationRecoveryPlan in the Go SDK.

public static class GetReplicationRecoveryPlan 
{
    public static Task<GetReplicationRecoveryPlanResult> InvokeAsync(GetReplicationRecoveryPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicationRecoveryPlanResult> Invoke(GetReplicationRecoveryPlanInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReplicationRecoveryPlanResult> getReplicationRecoveryPlan(GetReplicationRecoveryPlanArgs args, InvokeOptions options)
public static Output<GetReplicationRecoveryPlanResult> getReplicationRecoveryPlan(GetReplicationRecoveryPlanArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:recoveryservices:getReplicationRecoveryPlan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

RecoveryPlanName
This property is required.
Changes to this property will trigger replacement.
string
Name of the recovery plan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
RecoveryPlanName
This property is required.
Changes to this property will trigger replacement.
string
Name of the recovery plan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
recoveryPlanName
This property is required.
Changes to this property will trigger replacement.
String
Name of the recovery plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the recovery services vault is present.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.
recoveryPlanName
This property is required.
Changes to this property will trigger replacement.
string
Name of the recovery plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
recovery_plan_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the recovery plan.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group where the recovery services vault is present.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the recovery services vault.
recoveryPlanName
This property is required.
Changes to this property will trigger replacement.
String
Name of the recovery plan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the recovery services vault is present.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.

getReplicationRecoveryPlan Result

The following output properties are available:

Id string
Resource Id
Name string
Resource Name
Properties Pulumi.AzureNative.RecoveryServices.Outputs.RecoveryPlanPropertiesResponse
The custom details.
Type string
Resource Type
Location string
Resource Location
Id string
Resource Id
Name string
Resource Name
Properties RecoveryPlanPropertiesResponse
The custom details.
Type string
Resource Type
Location string
Resource Location
id String
Resource Id
name String
Resource Name
properties RecoveryPlanPropertiesResponse
The custom details.
type String
Resource Type
location String
Resource Location
id string
Resource Id
name string
Resource Name
properties RecoveryPlanPropertiesResponse
The custom details.
type string
Resource Type
location string
Resource Location
id str
Resource Id
name str
Resource Name
properties RecoveryPlanPropertiesResponse
The custom details.
type str
Resource Type
location str
Resource Location
id String
Resource Id
name String
Resource Name
properties Property Map
The custom details.
type String
Resource Type
location String
Resource Location

Supporting Types

CurrentScenarioDetailsResponse

JobId string
ARM Id of the job being executed.
ScenarioName string
Scenario name.
StartTime string
Start time of the workflow.
JobId string
ARM Id of the job being executed.
ScenarioName string
Scenario name.
StartTime string
Start time of the workflow.
jobId String
ARM Id of the job being executed.
scenarioName String
Scenario name.
startTime String
Start time of the workflow.
jobId string
ARM Id of the job being executed.
scenarioName string
Scenario name.
startTime string
Start time of the workflow.
job_id str
ARM Id of the job being executed.
scenario_name str
Scenario name.
start_time str
Start time of the workflow.
jobId String
ARM Id of the job being executed.
scenarioName String
Scenario name.
startTime String
Start time of the workflow.

ExtendedLocationResponse

Name This property is required. string
The name of the extended location.
Type This property is required. string
The extended location type.
Name This property is required. string
The name of the extended location.
Type This property is required. string
The extended location type.
name This property is required. String
The name of the extended location.
type This property is required. String
The extended location type.
name This property is required. string
The name of the extended location.
type This property is required. string
The extended location type.
name This property is required. str
The name of the extended location.
type This property is required. str
The extended location type.
name This property is required. String
The name of the extended location.
type This property is required. String
The extended location type.

RecoveryPlanA2ADetailsResponse

PrimaryExtendedLocation ExtendedLocationResponse
The primary extended location.
PrimaryZone string
The primary zone.
RecoveryExtendedLocation ExtendedLocationResponse
The recovery extended location.
RecoveryZone string
The recovery zone.
primaryExtendedLocation ExtendedLocationResponse
The primary extended location.
primaryZone String
The primary zone.
recoveryExtendedLocation ExtendedLocationResponse
The recovery extended location.
recoveryZone String
The recovery zone.
primaryExtendedLocation ExtendedLocationResponse
The primary extended location.
primaryZone string
The primary zone.
recoveryExtendedLocation ExtendedLocationResponse
The recovery extended location.
recoveryZone string
The recovery zone.
primary_extended_location ExtendedLocationResponse
The primary extended location.
primary_zone str
The primary zone.
recovery_extended_location ExtendedLocationResponse
The recovery extended location.
recovery_zone str
The recovery zone.
primaryExtendedLocation Property Map
The primary extended location.
primaryZone String
The primary zone.
recoveryExtendedLocation Property Map
The recovery extended location.
recoveryZone String
The recovery zone.

RecoveryPlanActionResponse

ActionName This property is required. string
The action name.
CustomDetails This property is required. Pulumi.AzureNative.RecoveryServices.Inputs.RecoveryPlanAutomationRunbookActionDetailsResponse | Pulumi.AzureNative.RecoveryServices.Inputs.RecoveryPlanManualActionDetailsResponse | Pulumi.AzureNative.RecoveryServices.Inputs.RecoveryPlanScriptActionDetailsResponse
The custom details.
FailoverDirections This property is required. List<string>
The list of failover directions.
FailoverTypes This property is required. List<string>
The list of failover types.
ActionName This property is required. string
The action name.
CustomDetails This property is required. RecoveryPlanAutomationRunbookActionDetailsResponse | RecoveryPlanManualActionDetailsResponse | RecoveryPlanScriptActionDetailsResponse
The custom details.
FailoverDirections This property is required. []string
The list of failover directions.
FailoverTypes This property is required. []string
The list of failover types.
actionName This property is required. String
The action name.
customDetails This property is required. RecoveryPlanAutomationRunbookActionDetailsResponse | RecoveryPlanManualActionDetailsResponse | RecoveryPlanScriptActionDetailsResponse
The custom details.
failoverDirections This property is required. List<String>
The list of failover directions.
failoverTypes This property is required. List<String>
The list of failover types.
actionName This property is required. string
The action name.
customDetails This property is required. RecoveryPlanAutomationRunbookActionDetailsResponse | RecoveryPlanManualActionDetailsResponse | RecoveryPlanScriptActionDetailsResponse
The custom details.
failoverDirections This property is required. string[]
The list of failover directions.
failoverTypes This property is required. string[]
The list of failover types.
action_name This property is required. str
The action name.
custom_details This property is required. RecoveryPlanAutomationRunbookActionDetailsResponse | RecoveryPlanManualActionDetailsResponse | RecoveryPlanScriptActionDetailsResponse
The custom details.
failover_directions This property is required. Sequence[str]
The list of failover directions.
failover_types This property is required. Sequence[str]
The list of failover types.
actionName This property is required. String
The action name.
customDetails This property is required. Property Map | Property Map | Property Map
The custom details.
failoverDirections This property is required. List<String>
The list of failover directions.
failoverTypes This property is required. List<String>
The list of failover types.

RecoveryPlanAutomationRunbookActionDetailsResponse

FabricLocation This property is required. string
The fabric location.
RunbookId string
The runbook ARM Id.
Timeout string
The runbook timeout.
FabricLocation This property is required. string
The fabric location.
RunbookId string
The runbook ARM Id.
Timeout string
The runbook timeout.
fabricLocation This property is required. String
The fabric location.
runbookId String
The runbook ARM Id.
timeout String
The runbook timeout.
fabricLocation This property is required. string
The fabric location.
runbookId string
The runbook ARM Id.
timeout string
The runbook timeout.
fabric_location This property is required. str
The fabric location.
runbook_id str
The runbook ARM Id.
timeout str
The runbook timeout.
fabricLocation This property is required. String
The fabric location.
runbookId String
The runbook ARM Id.
timeout String
The runbook timeout.

RecoveryPlanGroupResponse

GroupType This property is required. string
The group type.
EndGroupActions []RecoveryPlanActionResponse
The end group actions.
ReplicationProtectedItems []RecoveryPlanProtectedItemResponse
The list of protected items.
StartGroupActions []RecoveryPlanActionResponse
The start group actions.
groupType This property is required. String
The group type.
endGroupActions List<RecoveryPlanActionResponse>
The end group actions.
replicationProtectedItems List<RecoveryPlanProtectedItemResponse>
The list of protected items.
startGroupActions List<RecoveryPlanActionResponse>
The start group actions.
groupType This property is required. string
The group type.
endGroupActions RecoveryPlanActionResponse[]
The end group actions.
replicationProtectedItems RecoveryPlanProtectedItemResponse[]
The list of protected items.
startGroupActions RecoveryPlanActionResponse[]
The start group actions.
groupType This property is required. String
The group type.
endGroupActions List<Property Map>
The end group actions.
replicationProtectedItems List<Property Map>
The list of protected items.
startGroupActions List<Property Map>
The start group actions.

RecoveryPlanManualActionDetailsResponse

Description string
The manual action description.
Description string
The manual action description.
description String
The manual action description.
description string
The manual action description.
description str
The manual action description.
description String
The manual action description.

RecoveryPlanPropertiesResponse

AllowedOperations List<string>
The list of allowed operations.
CurrentScenario Pulumi.AzureNative.RecoveryServices.Inputs.CurrentScenarioDetailsResponse
The current scenario details.
CurrentScenarioStatus string
The recovery plan status.
CurrentScenarioStatusDescription string
The recovery plan status description.
FailoverDeploymentModel string
The failover deployment model.
FriendlyName string
The friendly name.
Groups List<Pulumi.AzureNative.RecoveryServices.Inputs.RecoveryPlanGroupResponse>
The recovery plan groups.
LastPlannedFailoverTime string
The start time of the last planned failover.
LastTestFailoverTime string
The start time of the last test failover.
LastUnplannedFailoverTime string
The start time of the last unplanned failover.
PrimaryFabricFriendlyName string
The primary fabric friendly name.
PrimaryFabricId string
The primary fabric Id.
ProviderSpecificDetails List<Pulumi.AzureNative.RecoveryServices.Inputs.RecoveryPlanA2ADetailsResponse>
The provider id and provider specific details.
RecoveryFabricFriendlyName string
The recovery fabric friendly name.
RecoveryFabricId string
The recovery fabric Id.
ReplicationProviders List<string>
The list of replication providers.
AllowedOperations []string
The list of allowed operations.
CurrentScenario CurrentScenarioDetailsResponse
The current scenario details.
CurrentScenarioStatus string
The recovery plan status.
CurrentScenarioStatusDescription string
The recovery plan status description.
FailoverDeploymentModel string
The failover deployment model.
FriendlyName string
The friendly name.
Groups []RecoveryPlanGroupResponse
The recovery plan groups.
LastPlannedFailoverTime string
The start time of the last planned failover.
LastTestFailoverTime string
The start time of the last test failover.
LastUnplannedFailoverTime string
The start time of the last unplanned failover.
PrimaryFabricFriendlyName string
The primary fabric friendly name.
PrimaryFabricId string
The primary fabric Id.
ProviderSpecificDetails []RecoveryPlanA2ADetailsResponse
The provider id and provider specific details.
RecoveryFabricFriendlyName string
The recovery fabric friendly name.
RecoveryFabricId string
The recovery fabric Id.
ReplicationProviders []string
The list of replication providers.
allowedOperations List<String>
The list of allowed operations.
currentScenario CurrentScenarioDetailsResponse
The current scenario details.
currentScenarioStatus String
The recovery plan status.
currentScenarioStatusDescription String
The recovery plan status description.
failoverDeploymentModel String
The failover deployment model.
friendlyName String
The friendly name.
groups List<RecoveryPlanGroupResponse>
The recovery plan groups.
lastPlannedFailoverTime String
The start time of the last planned failover.
lastTestFailoverTime String
The start time of the last test failover.
lastUnplannedFailoverTime String
The start time of the last unplanned failover.
primaryFabricFriendlyName String
The primary fabric friendly name.
primaryFabricId String
The primary fabric Id.
providerSpecificDetails List<RecoveryPlanA2ADetailsResponse>
The provider id and provider specific details.
recoveryFabricFriendlyName String
The recovery fabric friendly name.
recoveryFabricId String
The recovery fabric Id.
replicationProviders List<String>
The list of replication providers.
allowedOperations string[]
The list of allowed operations.
currentScenario CurrentScenarioDetailsResponse
The current scenario details.
currentScenarioStatus string
The recovery plan status.
currentScenarioStatusDescription string
The recovery plan status description.
failoverDeploymentModel string
The failover deployment model.
friendlyName string
The friendly name.
groups RecoveryPlanGroupResponse[]
The recovery plan groups.
lastPlannedFailoverTime string
The start time of the last planned failover.
lastTestFailoverTime string
The start time of the last test failover.
lastUnplannedFailoverTime string
The start time of the last unplanned failover.
primaryFabricFriendlyName string
The primary fabric friendly name.
primaryFabricId string
The primary fabric Id.
providerSpecificDetails RecoveryPlanA2ADetailsResponse[]
The provider id and provider specific details.
recoveryFabricFriendlyName string
The recovery fabric friendly name.
recoveryFabricId string
The recovery fabric Id.
replicationProviders string[]
The list of replication providers.
allowed_operations Sequence[str]
The list of allowed operations.
current_scenario CurrentScenarioDetailsResponse
The current scenario details.
current_scenario_status str
The recovery plan status.
current_scenario_status_description str
The recovery plan status description.
failover_deployment_model str
The failover deployment model.
friendly_name str
The friendly name.
groups Sequence[RecoveryPlanGroupResponse]
The recovery plan groups.
last_planned_failover_time str
The start time of the last planned failover.
last_test_failover_time str
The start time of the last test failover.
last_unplanned_failover_time str
The start time of the last unplanned failover.
primary_fabric_friendly_name str
The primary fabric friendly name.
primary_fabric_id str
The primary fabric Id.
provider_specific_details Sequence[RecoveryPlanA2ADetailsResponse]
The provider id and provider specific details.
recovery_fabric_friendly_name str
The recovery fabric friendly name.
recovery_fabric_id str
The recovery fabric Id.
replication_providers Sequence[str]
The list of replication providers.
allowedOperations List<String>
The list of allowed operations.
currentScenario Property Map
The current scenario details.
currentScenarioStatus String
The recovery plan status.
currentScenarioStatusDescription String
The recovery plan status description.
failoverDeploymentModel String
The failover deployment model.
friendlyName String
The friendly name.
groups List<Property Map>
The recovery plan groups.
lastPlannedFailoverTime String
The start time of the last planned failover.
lastTestFailoverTime String
The start time of the last test failover.
lastUnplannedFailoverTime String
The start time of the last unplanned failover.
primaryFabricFriendlyName String
The primary fabric friendly name.
primaryFabricId String
The primary fabric Id.
providerSpecificDetails List<Property Map>
The provider id and provider specific details.
recoveryFabricFriendlyName String
The recovery fabric friendly name.
recoveryFabricId String
The recovery fabric Id.
replicationProviders List<String>
The list of replication providers.

RecoveryPlanProtectedItemResponse

Id string
The ARM Id of the recovery plan protected item.
VirtualMachineId string
The virtual machine Id.
Id string
The ARM Id of the recovery plan protected item.
VirtualMachineId string
The virtual machine Id.
id String
The ARM Id of the recovery plan protected item.
virtualMachineId String
The virtual machine Id.
id string
The ARM Id of the recovery plan protected item.
virtualMachineId string
The virtual machine Id.
id str
The ARM Id of the recovery plan protected item.
virtual_machine_id str
The virtual machine Id.
id String
The ARM Id of the recovery plan protected item.
virtualMachineId String
The virtual machine Id.

RecoveryPlanScriptActionDetailsResponse

FabricLocation This property is required. string
The fabric location.
Path This property is required. string
The script path.
Timeout string
The script timeout.
FabricLocation This property is required. string
The fabric location.
Path This property is required. string
The script path.
Timeout string
The script timeout.
fabricLocation This property is required. String
The fabric location.
path This property is required. String
The script path.
timeout String
The script timeout.
fabricLocation This property is required. string
The fabric location.
path This property is required. string
The script path.
timeout string
The script timeout.
fabric_location This property is required. str
The fabric location.
path This property is required. str
The script path.
timeout str
The script timeout.
fabricLocation This property is required. String
The fabric location.
path This property is required. String
The script path.
timeout String
The script timeout.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native