Express Route Circuits - Get

Service:

ExpressRoute

API Version:

2024-03-01

Gets information about the specified express route circuit.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}?api-version=2024-03-01

URI Parameters

Name	In	Required	Type	Description
circuitName	path	True	string	The name of express route circuit.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ExpressRouteCircuit	Request successful. The operation returns the resulting ExpressRouteCircuit resource.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

Get ExpressRouteCircuit

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName?api-version=2024-03-01

Java

/**
 * Samples for ExpressRouteCircuits GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/ExpressRouteCircuitGet.json
     */
    /**
     * Sample code: Get ExpressRouteCircuit.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCircuit(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuits().getByResourceGroupWithResponse("rg1",
            "circuitName", 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.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python express_route_circuit_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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.express_route_circuits.get(
        resource_group_name="rg1",
        circuit_name="circuitName",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/ExpressRouteCircuitGet.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 armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/ExpressRouteCircuitGet.json
func ExampleExpressRouteCircuitsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExpressRouteCircuitsClient().Get(ctx, "rg1", "circuitName", 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.ExpressRouteCircuit = armnetwork.ExpressRouteCircuit{
	// 	Name: to.Ptr("circuitName"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCircuits"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.ExpressRouteCircuitPropertiesFormat{
	// 		AllowClassicOperations: to.Ptr(false),
	// 		Authorizations: []*armnetwork.ExpressRouteCircuitAuthorization{
	// 		},
	// 		CircuitProvisioningState: to.Ptr("Enabled"),
	// 		Peerings: []*armnetwork.ExpressRouteCircuitPeering{
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		ServiceKey: to.Ptr("a1410692-0000-4ceb-b94a-b90b94d398d1"),
	// 		ServiceProviderProperties: &armnetwork.ExpressRouteCircuitServiceProviderProperties{
	// 			BandwidthInMbps: to.Ptr[int32](200),
	// 			PeeringLocation: to.Ptr("peeringLocation"),
	// 			ServiceProviderName: to.Ptr("providerName"),
	// 		},
	// 		ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
	// 	},
	// 	SKU: &armnetwork.ExpressRouteCircuitSKU{
	// 		Name: to.Ptr("Standard_MeteredData"),
	// 		Family: to.Ptr(armnetwork.ExpressRouteCircuitSKUFamilyMeteredData),
	// 		Tier: to.Ptr(armnetwork.ExpressRouteCircuitSKUTierStandard),
	// 	},
	// }
}

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 { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified express route circuit.
 *
 * @summary Gets information about the specified express route circuit.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/ExpressRouteCircuitGet.json
 */
async function getExpressRouteCircuit() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "circuitName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuits.get(resourceGroupName, circuitName);
  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.Network.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-03-01/examples/ExpressRouteCircuitGet.json
// this example is just showing the usage of "ExpressRouteCircuits_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 = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ExpressRouteCircuitResource
ExpressRouteCircuitCollection collection = resourceGroupResource.GetExpressRouteCircuits();

// invoke the operation
string circuitName = "circuitName";
NullableResponse<ExpressRouteCircuitResource> response = await collection.GetIfExistsAsync(circuitName);
ExpressRouteCircuitResource 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
    ExpressRouteCircuitData 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

{
  "name": "circuitName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "type": "Microsoft.Network/expressRouteCircuits",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "peerings": [],
    "authorizations": [],
    "serviceProviderProperties": {
      "serviceProviderName": "providerName",
      "peeringLocation": "peeringLocation",
      "bandwidthInMbps": 200
    },
    "circuitProvisioningState": "Enabled",
    "allowClassicOperations": false,
    "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1",
    "serviceProviderProvisioningState": "NotProvisioned"
  },
  "sku": {
    "name": "Standard_MeteredData",
    "tier": "Standard",
    "family": "MeteredData"
  }
}

Definitions

Name	Description
AuthorizationUseStatus	The authorization use status.
CircuitConnectionStatus	Express Route Circuit connection state.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRouteCircuit	ExpressRouteCircuit resource.
ExpressRouteCircuitAuthorization	Authorization in an ExpressRouteCircuit resource.
ExpressRouteCircuitConnection	Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.
ExpressRouteCircuitPeering	Peering in an ExpressRouteCircuit resource.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	The advertised public prefix state of the Peering resource.
ExpressRouteCircuitPeeringConfig	Specifies the peering configuration.
ExpressRouteCircuitPeeringState	The state of peering.
ExpressRouteCircuitServiceProviderProperties	Contains ServiceProviderProperties in an ExpressRouteCircuit.
ExpressRouteCircuitSku	Contains SKU in an ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	The family of the SKU.
ExpressRouteCircuitSkuTier	The tier of the SKU.
ExpressRouteCircuitStats	Contains stats associated with the peering.
ExpressRouteConnectionId	The ID of the ExpressRouteConnection.
ExpressRoutePeeringState	The state of peering.
ExpressRoutePeeringType	The peering type.
Ipv6CircuitConnectionConfig	IPv6 Circuit Connection properties for global reach.
Ipv6ExpressRouteCircuitPeeringConfig	Contains IPv6 peering config.
PeerExpressRouteCircuitConnection	Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.
ProvisioningState	The current provisioning state.
ServiceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.
SubResource	Reference to another subresource.

AuthorizationUseStatus

The authorization use status.

Name	Type	Description
Available	string
InUse	string

CircuitConnectionStatus

Express Route Circuit connection state.

Name	Type	Description
Connected	string
Connecting	string
Disconnected	string

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ExpressRouteCircuit

ExpressRouteCircuit resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.allowClassicOperations	boolean	Allow classic operations.
properties.authorizationKey	string	The authorizationKey.
properties.authorizationStatus	string	The authorization status of the Circuit.
properties.authorizations	ExpressRouteCircuitAuthorization[]	The list of authorizations.
properties.bandwidthInGbps	number	The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
properties.circuitProvisioningState	string	The CircuitProvisioningState state of the resource.
properties.enableDirectPortRateLimit	boolean	Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
properties.expressRoutePort	SubResource	The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.globalReachEnabled	boolean	Flag denoting global reach status.
properties.peerings	ExpressRouteCircuitPeering[]	The list of peerings.
properties.provisioningState	ProvisioningState	The provisioning state of the express route circuit resource.
properties.serviceKey	string	The ServiceKey.
properties.serviceProviderNotes	string	The ServiceProviderNotes.
properties.serviceProviderProperties	ExpressRouteCircuitServiceProviderProperties	The ServiceProviderProperties.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	The ServiceProviderProvisioningState state of the resource.
properties.stag	integer	The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
sku	ExpressRouteCircuitSku	The SKU.
tags	object	Resource tags.
type	string	Resource type.

ExpressRouteCircuitAuthorization

Authorization in an ExpressRouteCircuit resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.authorizationKey	string	The authorization key.
properties.authorizationUseStatus	AuthorizationUseStatus	The authorization use status.
properties.connectionResourceUri	string	The reference to the ExpressRoute connection resource using the authorization.
properties.provisioningState	ProvisioningState	The provisioning state of the authorization resource.
type	string	Type of the resource.

ExpressRouteCircuitConnection

Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.addressPrefix	string	/29 IP address space to carve out Customer addresses for tunnels.
properties.authorizationKey	string	The authorization key.
properties.circuitConnectionStatus	CircuitConnectionStatus	Express Route Circuit connection state.
properties.expressRouteCircuitPeering	SubResource	Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	IPv6 Address PrefixProperties of the express route circuit connection.
properties.peerExpressRouteCircuitPeering	SubResource	Reference to Express Route Circuit Private Peering Resource of the peered circuit.
properties.provisioningState	ProvisioningState	The provisioning state of the express route circuit connection resource.
type	string	Type of the resource.

ExpressRouteCircuitPeering

Peering in an ExpressRouteCircuit resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.azureASN	integer	The Azure ASN.
properties.connections	ExpressRouteCircuitConnection[]	The list of circuit connections associated with Azure Private Peering for this circuit.
properties.expressRouteConnection	ExpressRouteConnectionId	The ExpressRoute connection.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	The IPv6 peering configuration.
properties.lastModifiedBy	string	Who was the last to modify the peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	The Microsoft peering configuration.
properties.peerASN	integer	The peer ASN.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	The list of peered circuit connections associated with Azure Private Peering for this circuit.
properties.peeringType	ExpressRoutePeeringType	The peering type.
properties.primaryAzurePort	string	The primary port.
properties.primaryPeerAddressPrefix	string	The primary address prefix.
properties.provisioningState	ProvisioningState	The provisioning state of the express route circuit peering resource.
properties.routeFilter	SubResource	The reference to the RouteFilter resource.
properties.secondaryAzurePort	string	The secondary port.
properties.secondaryPeerAddressPrefix	string	The secondary address prefix.
properties.sharedKey	string	The shared key.
properties.state	ExpressRoutePeeringState	The peering state.
properties.stats	ExpressRouteCircuitStats	The peering stats of express route circuit.
properties.vlanId	integer	The VLAN ID.
type	string	Type of the resource.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

The advertised public prefix state of the Peering resource.

Name	Type	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Specifies the peering configuration.

Name	Type	Description
advertisedCommunities	string[]	The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes	string[]	The reference to AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	The advertised public prefix state of the Peering resource.
customerASN	integer	The CustomerASN of the peering.
legacyMode	integer	The legacy mode of the peering.
routingRegistryName	string	The RoutingRegistryName of the configuration.

ExpressRouteCircuitPeeringState

The state of peering.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRouteCircuitServiceProviderProperties

Contains ServiceProviderProperties in an ExpressRouteCircuit.

Name	Type	Description
bandwidthInMbps	integer	The BandwidthInMbps.
peeringLocation	string	The peering location.
serviceProviderName	string	The serviceProviderName.

ExpressRouteCircuitSku

Contains SKU in an ExpressRouteCircuit.

Name	Type	Description
family	ExpressRouteCircuitSkuFamily	The family of the SKU.
name	string	The name of the SKU.
tier	ExpressRouteCircuitSkuTier	The tier of the SKU.

ExpressRouteCircuitSkuFamily

The family of the SKU.

Name	Type	Description
MeteredData	string
UnlimitedData	string

ExpressRouteCircuitSkuTier

The tier of the SKU.

Name	Type	Description
Basic	string
Local	string
Premium	string
Standard	string

ExpressRouteCircuitStats

Contains stats associated with the peering.

Name	Type	Description
primarybytesIn	integer	The Primary BytesIn of the peering.
primarybytesOut	integer	The primary BytesOut of the peering.
secondarybytesIn	integer	The secondary BytesIn of the peering.
secondarybytesOut	integer	The secondary BytesOut of the peering.

ExpressRouteConnectionId

The ID of the ExpressRouteConnection.

Name	Type	Description
id	string	The ID of the ExpressRouteConnection.

ExpressRoutePeeringState

The state of peering.

Name	Type	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

The peering type.

Name	Type	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6CircuitConnectionConfig

IPv6 Circuit Connection properties for global reach.

Name	Type	Description
addressPrefix	string	/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus	CircuitConnectionStatus	Express Route Circuit connection state.

Ipv6ExpressRouteCircuitPeeringConfig

Contains IPv6 peering config.

Name	Type	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	The Microsoft peering configuration.
primaryPeerAddressPrefix	string	The primary address prefix.
routeFilter	SubResource	The reference to the RouteFilter resource.
secondaryPeerAddressPrefix	string	The secondary address prefix.
state	ExpressRouteCircuitPeeringState	The state of peering.

PeerExpressRouteCircuitConnection

Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.addressPrefix	string	/29 IP address space to carve out Customer addresses for tunnels.
properties.authResourceGuid	string	The resource guid of the authorization used for the express route circuit connection.
properties.circuitConnectionStatus	CircuitConnectionStatus	Express Route Circuit connection state.
properties.connectionName	string	The name of the express route circuit connection resource.
properties.expressRouteCircuitPeering	SubResource	Reference to Express Route Circuit Private Peering Resource of the circuit.
properties.peerExpressRouteCircuitPeering	SubResource	Reference to Express Route Circuit Private Peering Resource of the peered circuit.
properties.provisioningState	ProvisioningState	The provisioning state of the peer express route circuit connection resource.
type	string	Type of the resource.

ProvisioningState

The current provisioning state.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

The ServiceProviderProvisioningState state of the resource.

Name	Type	Description
Deprovisioning	string
NotProvisioned	string
Provisioned	string
Provisioning	string

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.