Replication Recovery Plans - Get

サービス:

Recovery Services - Site Recovery

API バージョン:

2025-01-01

要求された復旧計画を取得します。
復旧計画の詳細を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
recoveryPlanName	path	True	string	復旧計画の名前。
resourceGroupName	path	True	string	Recovery Services コンテナーが存在するリソース グループの名前。
resourceName	path	True	string	Recovery Services コンテナーの名前。
subscriptionId	path	True	string	サブスクリプション ID。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	RecoveryPlan	[OK]

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装します。

例

Gets the requested recovery plan.

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1?api-version=2025-01-01

Java

/**
 * Samples for ReplicationRecoveryPlans Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples
     * /ReplicationRecoveryPlans_Get.json
     */
    /**
     * Sample code: Gets the requested recovery plan.
     * 
     * @param manager Entry point to SiteRecoveryManager.
     */
    public static void getsTheRequestedRecoveryPlan(
        com.azure.resourcemanager.recoveryservicessiterecovery.SiteRecoveryManager manager) {
        manager.replicationRecoveryPlans().getWithResponse("resourceGroupPS1", "vault1", "RPtest1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicessiterecovery import SiteRecoveryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicessiterecovery
# USAGE
    python replication_recovery_plans_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SiteRecoveryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="c183865e-6077-46f2-a3b1-deb0f4f4650a",
        resource_group_name="resourceGroupPS1",
        resource_name="vault1",
    )

    response = client.replication_recovery_plans.get(
        recovery_plan_name="RPtest1",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationRecoveryPlans_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicessiterecovery_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicessiterecovery/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fc983fb08e5fd8a7a821eb6491f5338ce52a9cf/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationRecoveryPlans_Get.json
func ExampleReplicationRecoveryPlansClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicessiterecovery.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewReplicationRecoveryPlansClient().Get(ctx, "resourceGroupPS1", "vault1", "RPtest1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RecoveryPlan = armrecoveryservicessiterecovery.RecoveryPlan{
	// 	Name: to.Ptr("RPtest1"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/replicationRecoveryPlans"),
	// 	ID: to.Ptr("/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1"),
	// 	Properties: &armrecoveryservicessiterecovery.RecoveryPlanProperties{
	// 		AllowedOperations: []*string{
	// 			to.Ptr("PlannedFailover"),
	// 			to.Ptr("UnplannedFailover"),
	// 			to.Ptr("TestFailover")},
	// 			FailoverDeploymentModel: to.Ptr("ResourceManager"),
	// 			FriendlyName: to.Ptr("RPtest1"),
	// 			Groups: []*armrecoveryservicessiterecovery.RecoveryPlanGroup{
	// 				{
	// 					EndGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 					GroupType: to.Ptr(armrecoveryservicessiterecovery.RecoveryPlanGroupTypeShutdown),
	// 					ReplicationProtectedItems: []*armrecoveryservicessiterecovery.RecoveryPlanProtectedItem{
	// 					},
	// 					StartGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 				},
	// 				{
	// 					EndGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 					GroupType: to.Ptr(armrecoveryservicessiterecovery.RecoveryPlanGroupTypeFailover),
	// 					ReplicationProtectedItems: []*armrecoveryservicessiterecovery.RecoveryPlanProtectedItem{
	// 					},
	// 					StartGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 				},
	// 				{
	// 					EndGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 					GroupType: to.Ptr(armrecoveryservicessiterecovery.RecoveryPlanGroupTypeBoot),
	// 					ReplicationProtectedItems: []*armrecoveryservicessiterecovery.RecoveryPlanProtectedItem{
	// 						{
	// 							ID: to.Ptr("/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b"),
	// 							VirtualMachineID: to.Ptr("f8491e4f-817a-40dd-a90c-af773978c75b"),
	// 					}},
	// 					StartGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 				},
	// 				{
	// 					EndGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 					GroupType: to.Ptr(armrecoveryservicessiterecovery.RecoveryPlanGroupTypeBoot),
	// 					ReplicationProtectedItems: []*armrecoveryservicessiterecovery.RecoveryPlanProtectedItem{
	// 						{
	// 							ID: to.Ptr("/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6"),
	// 							VirtualMachineID: to.Ptr("c0c14913-3d7a-48ea-9531-cc99e0e686e6"),
	// 					}},
	// 					StartGroupActions: []*armrecoveryservicessiterecovery.RecoveryPlanAction{
	// 					},
	// 			}},
	// 			PrimaryFabricFriendlyName: to.Ptr("cloud1"),
	// 			PrimaryFabricID: to.Ptr("/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1"),
	// 			RecoveryFabricFriendlyName: to.Ptr("Microsoft Azure"),
	// 			RecoveryFabricID: to.Ptr("Microsoft Azure"),
	// 			ReplicationProviders: []*string{
	// 				to.Ptr("HyperVReplicaAzure")},
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SiteRecoveryManagementClient } = require("@azure/arm-recoveryservices-siterecovery");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the details of the recovery plan.
 *
 * @summary Gets the details of the recovery plan.
 * x-ms-original-file: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationRecoveryPlans_Get.json
 */
async function getsTheRequestedRecoveryPlan() {
  const subscriptionId =
    process.env["RECOVERYSERVICESSITERECOVERY_SUBSCRIPTION_ID"] ||
    "c183865e-6077-46f2-a3b1-deb0f4f4650a";
  const resourceGroupName =
    process.env["RECOVERYSERVICESSITERECOVERY_RESOURCE_GROUP"] || "resourceGroupPS1";
  const resourceName = "vault1";
  const recoveryPlanName = "RPtest1";
  const credential = new DefaultAzureCredential();
  const client = new SiteRecoveryManagementClient(credential, subscriptionId);
  const result = await client.replicationRecoveryPlans.get(
    resourceGroupName,
    resourceName,
    recoveryPlanName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.RecoveryServicesSiteRecovery.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.RecoveryServicesSiteRecovery;

// Generated from example definition: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationRecoveryPlans_Get.json
// this example is just showing the usage of "ReplicationRecoveryPlans_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "c183865e-6077-46f2-a3b1-deb0f4f4650a";
string resourceGroupName = "resourceGroupPS1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SiteRecoveryRecoveryPlanResource
string resourceName = "vault1";
SiteRecoveryRecoveryPlanCollection collection = resourceGroupResource.GetSiteRecoveryRecoveryPlans(resourceName);

// invoke the operation
string recoveryPlanName = "RPtest1";
NullableResponse<SiteRecoveryRecoveryPlanResource> response = await collection.GetIfExistsAsync(recoveryPlanName);
SiteRecoveryRecoveryPlanResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SiteRecoveryRecoveryPlanData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2025-01-01

{
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationRecoveryPlans/RPtest1",
  "name": "RPtest1",
  "type": "Microsoft.RecoveryServices/vaults/replicationRecoveryPlans",
  "properties": {
    "friendlyName": "RPtest1",
    "primaryFabricId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1",
    "primaryFabricFriendlyName": "cloud1",
    "recoveryFabricId": "Microsoft Azure",
    "recoveryFabricFriendlyName": "Microsoft Azure",
    "failoverDeploymentModel": "ResourceManager",
    "replicationProviders": [
      "HyperVReplicaAzure"
    ],
    "allowedOperations": [
      "PlannedFailover",
      "UnplannedFailover",
      "TestFailover"
    ],
    "groups": [
      {
        "groupType": "Shutdown",
        "replicationProtectedItems": [],
        "startGroupActions": [],
        "endGroupActions": []
      },
      {
        "groupType": "Failover",
        "replicationProtectedItems": [],
        "startGroupActions": [],
        "endGroupActions": []
      },
      {
        "groupType": "Boot",
        "replicationProtectedItems": [
          {
            "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/f8491e4f-817a-40dd-a90c-af773978c75b",
            "virtualMachineId": "f8491e4f-817a-40dd-a90c-af773978c75b"
          }
        ],
        "startGroupActions": [],
        "endGroupActions": []
      },
      {
        "groupType": "Boot",
        "replicationProtectedItems": [
          {
            "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectedItems/c0c14913-3d7a-48ea-9531-cc99e0e686e6",
            "virtualMachineId": "c0c14913-3d7a-48ea-9531-cc99e0e686e6"
          }
        ],
        "startGroupActions": [],
        "endGroupActions": []
      }
    ]
  }
}

定義

名前	説明
CurrentScenarioDetails	保護されたエンティティの現在のシナリオの詳細。
ExtendedLocation	リソースの拡張された場所。
ExtendedLocationType	拡張された場所の種類。
PossibleOperationsDirections	フェールオーバーの方向の一覧。
RecoveryPlan	復旧計画の詳細。
RecoveryPlanA2ADetails	復旧計画 A2A 固有の詳細。
RecoveryPlanAction	復旧計画のアクションの詳細。
RecoveryPlanActionLocation	ファブリックの場所。
RecoveryPlanAutomationRunbookActionDetails	復旧計画の Automation Runbook アクションの詳細。
RecoveryPlanGroup	復旧計画グループの詳細。
RecoveryPlanGroupType	グループの種類。
RecoveryPlanManualActionDetails	復旧計画の手動アクションの詳細。
RecoveryPlanProperties	復旧計画のプロパティ。
RecoveryPlanProtectedItem	復旧計画の保護された項目。
RecoveryPlanScriptActionDetails	復旧計画スクリプトアクションの詳細。
ReplicationProtectedItemOperation	フェールオーバーの種類の一覧。

CurrentScenarioDetails

Object

保護されたエンティティの現在のシナリオの詳細。

名前	型	説明
jobId	string	実行中のジョブの ARM ID。
scenarioName	string	シナリオ名。
startTime	string (date-time)	ワークフローの開始時刻。

ExtendedLocation

Object

リソースの拡張された場所。

名前	型	説明
name	string	拡張された場所の名前。
type	ExtendedLocationType	拡張された場所の種類。

ExtendedLocationType

列挙

拡張された場所の種類。

値	説明
EdgeZone

PossibleOperationsDirections

列挙

フェールオーバーの方向の一覧。

値	説明
PrimaryToRecovery
RecoveryToPrimary

RecoveryPlan

Object

復旧計画の詳細。

名前	型	説明
id	string	リソース ID
location	string	リソースの場所
name	string	リソース名
properties	RecoveryPlanProperties	カスタムの詳細。
type	string	リソースの種類

RecoveryPlanA2ADetails

Object

復旧計画 A2A 固有の詳細。

名前	型	説明
instanceType	string: A2A	インスタンス型を取得します。
primaryExtendedLocation	ExtendedLocation	プライマリ拡張場所。
primaryZone	string	プライマリ ゾーン。
recoveryExtendedLocation	ExtendedLocation	復旧の拡張場所。
recoveryZone	string	復旧ゾーン。

RecoveryPlanAction

Object

復旧計画のアクションの詳細。

名前	型	説明
actionName	string	アクション名。
customDetails	RecoveryPlanActionDetails: RecoveryPlanAutomationRunbookActionDetails RecoveryPlanManualActionDetails RecoveryPlanScriptActionDetails	カスタムの詳細。
failoverDirections	PossibleOperationsDirections[]	フェールオーバーの方向の一覧。
failoverTypes	ReplicationProtectedItemOperation[]	フェールオーバーの種類の一覧。

RecoveryPlanActionLocation

列挙

ファブリックの場所。

値	説明
Primary
Recovery

RecoveryPlanAutomationRunbookActionDetails

Object

復旧計画の Automation Runbook アクションの詳細。

名前	型	説明
fabricLocation	RecoveryPlanActionLocation	ファブリックの場所。
instanceType	string: AutomationRunbookActionDetails	アクションの詳細の種類を取得します (使用可能な値については、RecoveryPlanActionDetailsTypes 列挙型を参照してください)。
runbookId	string	Runbook ARM ID。
timeout	string	Runbook のタイムアウト。

RecoveryPlanGroup

Object

復旧計画グループの詳細。

名前	型	説明
endGroupActions	RecoveryPlanAction[]	グループの終了アクション。
groupType	RecoveryPlanGroupType	グループの種類。
replicationProtectedItems	RecoveryPlanProtectedItem[]	保護された項目の一覧。
startGroupActions	RecoveryPlanAction[]	グループの開始アクション。

RecoveryPlanGroupType

列挙

グループの種類。

値	説明
Boot
Failover
Shutdown

RecoveryPlanManualActionDetails

Object

復旧計画の手動アクションの詳細。

名前	型	説明
description	string	手動アクションの説明。
instanceType	string: ManualActionDetails	アクションの詳細の種類を取得します (使用可能な値については、RecoveryPlanActionDetailsTypes 列挙型を参照してください)。

RecoveryPlanProperties

Object

復旧計画のプロパティ。

名前	型	説明
allowedOperations	string[]	許可される操作の一覧。
currentScenario	CurrentScenarioDetails	現在のシナリオの詳細。
currentScenarioStatus	string	復旧計画の状態。
currentScenarioStatusDescription	string	復旧計画の状態の説明。
failoverDeploymentModel	string	フェールオーバー デプロイ モデル。
friendlyName	string	フレンドリ名。
groups	RecoveryPlanGroup[]	復旧計画グループ。
lastPlannedFailoverTime	string (date-time)	最後に計画されたフェールオーバーの開始時刻。
lastTestFailoverTime	string (date-time)	最後のテスト フェールオーバーの開始時刻。
lastUnplannedFailoverTime	string (date-time)	計画外の最後のフェールオーバーの開始時刻。
primaryFabricFriendlyName	string	プライマリ ファブリックのフレンドリ名。
primaryFabricId	string	プライマリ ファブリック ID。
providerSpecificDetails	RecoveryPlanProviderSpecificDetails[]: RecoveryPlanA2ADetails[]	プロバイダー ID とプロバイダー固有の詳細。
recoveryFabricFriendlyName	string	回復ファブリックのフレンドリ名。
recoveryFabricId	string	復旧ファブリック ID。
replicationProviders	string[]	レプリケーション プロバイダーの一覧。

RecoveryPlanProtectedItem

Object

復旧計画の保護された項目。

名前	型	説明
id	string	復旧計画で保護された項目の ARM ID。
virtualMachineId	string	仮想マシン ID。

RecoveryPlanScriptActionDetails

Object

復旧計画スクリプトアクションの詳細。

名前	型	説明
fabricLocation	RecoveryPlanActionLocation	ファブリックの場所。
instanceType	string: ScriptActionDetails	アクションの詳細の種類を取得します (使用可能な値については、RecoveryPlanActionDetailsTypes 列挙型を参照してください)。
path	string	スクリプト パス。
timeout	string	スクリプトのタイムアウト。

ReplicationProtectedItemOperation

列挙

フェールオーバーの種類の一覧。

値	説明
CancelFailover
ChangePit
Commit
CompleteMigration
DisableProtection
Failback
FinalizeFailback
PlannedFailover
RepairReplication
ReverseReplicate
SwitchProtection
TestFailover
TestFailoverCleanup
UnplannedFailover