Replication Network Mappings - Get

Service:: Recovery Services - Site Recovery

API Version:: 2025-01-01

Gets network mapping by name.
Gets the details of an ASR network mapping.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}?api-version=2025-01-01

URI Parameters

Name	In	Required	Type	Description
fabricName	path	True	string	Primary fabric name.
networkMappingName	path	True	string	Network mapping name.
networkName	path	True	string	Primary network name.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	NetworkMapping	OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Gets network mapping by name.

Sample request

GET https://management.azure.com/subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap?api-version=2025-01-01


/**
 * Samples for ReplicationNetworkMappings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples
     * /ReplicationNetworkMappings_Get.json
     */
    /**
     * Sample code: Gets network mapping by name.
     * 
     * @param manager Entry point to SiteRecoveryManager.
     */
    public static void
        getsNetworkMappingByName(com.azure.resourcemanager.recoveryservicessiterecovery.SiteRecoveryManager manager) {
        manager.replicationNetworkMappings().getWithResponse("srcBvte2a14C27", "srce2avaultbvtaC27",
            "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", "e2267b5c-2650-49bd-ab3f-d66aae694c06",
            "corpe2amap", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicessiterecovery import SiteRecoveryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicessiterecovery
# USAGE
    python replication_network_mappings_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="9112a37f-0f3e-46ec-9c00-060c6edca071",
        resource_group_name="srcBvte2a14C27",
        resource_name="srce2avaultbvtaC27",
    )

    response = client.replication_network_mappings.get(
        fabric_name="b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac",
        network_name="e2267b5c-2650-49bd-ab3f-d66aae694c06",
        network_mapping_name="corpe2amap",
    )
    print(response)


# x-ms-original-file: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationNetworkMappings_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

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/ReplicationNetworkMappings_Get.json
func ExampleReplicationNetworkMappingsClient_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.NewReplicationNetworkMappingsClient().Get(ctx, "srcBvte2a14C27", "srce2avaultbvtaC27", "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac", "e2267b5c-2650-49bd-ab3f-d66aae694c06", "corpe2amap", 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.NetworkMapping = armrecoveryservicessiterecovery.NetworkMapping{
	// 	Name: to.Ptr("corpe2amap"),
	// 	Type: to.Ptr("Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings"),
	// 	ID: to.Ptr("/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap"),
	// 	Properties: &armrecoveryservicessiterecovery.NetworkMappingProperties{
	// 		FabricSpecificSettings: &armrecoveryservicessiterecovery.VmmToAzureNetworkMappingSettings{
	// 			InstanceType: to.Ptr("VmmToAzure"),
	// 		},
	// 		PrimaryFabricFriendlyName: to.Ptr("CP-B3L30108-01.ntdev.corp.microsoft.com"),
	// 		PrimaryNetworkFriendlyName: to.Ptr("corp"),
	// 		PrimaryNetworkID: to.Ptr("/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06"),
	// 		RecoveryFabricArmID: to.Ptr("/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5"),
	// 		RecoveryFabricFriendlyName: to.Ptr("Microsoft Azure"),
	// 		RecoveryNetworkFriendlyName: to.Ptr("vnetavrai"),
	// 		RecoveryNetworkID: to.Ptr("/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai"),
	// 		State: to.Ptr("Paired"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets the details of an ASR network mapping.
 *
 * @summary Gets the details of an ASR network mapping.
 * x-ms-original-file: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationNetworkMappings_Get.json
 */
async function getsNetworkMappingByName() {
  const subscriptionId =
    process.env["RECOVERYSERVICESSITERECOVERY_SUBSCRIPTION_ID"] ||
    "9112a37f-0f3e-46ec-9c00-060c6edca071";
  const resourceGroupName =
    process.env["RECOVERYSERVICESSITERECOVERY_RESOURCE_GROUP"] || "srcBvte2a14C27";
  const resourceName = "srce2avaultbvtaC27";
  const fabricName = "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac";
  const networkName = "e2267b5c-2650-49bd-ab3f-d66aae694c06";
  const networkMappingName = "corpe2amap";
  const credential = new DefaultAzureCredential();
  const client = new SiteRecoveryManagementClient(credential, subscriptionId);
  const result = await client.replicationNetworkMappings.get(
    resourceGroupName,
    resourceName,
    fabricName,
    networkName,
    networkMappingName,
  );
  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

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.RecoveryServicesSiteRecovery;

// Generated from example definition: specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2025-01-01/examples/ReplicationNetworkMappings_Get.json
// this example is just showing the usage of "ReplicationNetworkMappings_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 SiteRecoveryNetworkMappingResource created on azure
// for more information of creating SiteRecoveryNetworkMappingResource, please refer to the document of SiteRecoveryNetworkMappingResource
string subscriptionId = "9112a37f-0f3e-46ec-9c00-060c6edca071";
string resourceGroupName = "srcBvte2a14C27";
string resourceName = "srce2avaultbvtaC27";
string fabricName = "b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac";
string networkName = "e2267b5c-2650-49bd-ab3f-d66aae694c06";
string networkMappingName = "corpe2amap";
ResourceIdentifier siteRecoveryNetworkMappingResourceId = SiteRecoveryNetworkMappingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName, fabricName, networkName, networkMappingName);
SiteRecoveryNetworkMappingResource siteRecoveryNetworkMapping = client.GetSiteRecoveryNetworkMappingResource(siteRecoveryNetworkMappingResourceId);

// invoke the operation
SiteRecoveryNetworkMappingResource result = await siteRecoveryNetworkMapping.GetAsync();

// 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
SiteRecoveryNetworkMappingData 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

Sample response

Status code:: 200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2025-01-01

{
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationNetworks/replicationNetworkMappings",
  "id": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/b0cef6e9a4437b81803d0b55ada4f700ab66caae59c35d62723a1589c0cd13ac/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06/replicationNetworkMappings/corpe2amap",
  "name": "corpe2amap",
  "properties": {
    "state": "Paired",
    "primaryNetworkFriendlyName": "corp",
    "primaryNetworkId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5/replicationNetworks/e2267b5c-2650-49bd-ab3f-d66aae694c06",
    "primaryFabricFriendlyName": "CP-B3L30108-01.ntdev.corp.microsoft.com",
    "recoveryNetworkFriendlyName": "vnetavrai",
    "recoveryNetworkId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/siterecoveryProd1/providers/Microsoft.Network/virtualNetworks/vnetavrai",
    "recoveryFabricArmId": "/Subscriptions/9112a37f-0f3e-46ec-9c00-060c6edca071/resourceGroups/srcBvte2a14C27/providers/Microsoft.RecoveryServices/vaults/srce2avaultbvtaC27/replicationFabrics/d49858f157601230a6ac5862fbbc6e63bf38d23ecd96cf953767945d457fe9d5",
    "recoveryFabricFriendlyName": "Microsoft Azure",
    "fabricSpecificSettings": {
      "instanceType": "VmmToAzure"
    }
  }
}

Definitions

Name	Description
AzureToAzureNetworkMappingSettings	A2A Network Mapping fabric specific settings.
NetworkMapping	Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.
NetworkMappingProperties	Network Mapping Properties.
VmmToAzureNetworkMappingSettings	E2A Network Mapping fabric specific settings.
VmmToVmmNetworkMappingSettings	E2E Network Mapping fabric specific settings.

AzureToAzureNetworkMappingSettings

Object

A2A Network Mapping fabric specific settings.

Name	Type	Description
instanceType	string: AzureToAzure	Gets the Instance type.
primaryFabricLocation	string	The primary fabric location.
recoveryFabricLocation	string	The recovery fabric location.

NetworkMapping

Object

Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	NetworkMappingProperties	The Network Mapping Properties.
type	string	Resource Type

NetworkMappingProperties

Object

Network Mapping Properties.

Name	Type	Description
fabricSpecificSettings	NetworkMappingFabricSpecificSettings: AzureToAzureNetworkMappingSettings VmmToAzureNetworkMappingSettings VmmToVmmNetworkMappingSettings	The fabric specific settings.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryNetworkFriendlyName	string	The primary network friendly name.
primaryNetworkId	string	The primary network id for network mapping.
recoveryFabricArmId	string	The recovery fabric ARM id.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryNetworkFriendlyName	string	The recovery network friendly name.
recoveryNetworkId	string	The recovery network id for network mapping.
state	string	The pairing state for network mapping.

VmmToAzureNetworkMappingSettings

Object

E2A Network Mapping fabric specific settings.

Name	Type	Description
instanceType	string: VmmToAzure	Gets the Instance type.

VmmToVmmNetworkMappingSettings

Object

E2E Network Mapping fabric specific settings.

Name	Type	Description
instanceType	string: VmmToVmm	Gets the Instance type.