Gets all global reach connections associated with a private peering in an express route circuit.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections?api-version=2023-09-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
circuitName
|
path |
True
|
string
|
The name of the circuit.
|
|
peeringName
|
path |
True
|
string
|
The name of the peering.
|
|
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
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
List ExpressRouteCircuit Connection
Sample Request
GET https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections?api-version=2023-09-01
/**
* Samples for ExpressRouteCircuitConnections List.
*/
public final class Main {
/*
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
* ExpressRouteCircuitConnectionList.json
*/
/**
* Sample code: List ExpressRouteCircuit Connection.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listExpressRouteCircuitConnection(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getExpressRouteCircuitConnections().list("rg1",
"ExpressRouteARMCircuitA", "AzurePrivatePeering", 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.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python express_route_circuit_connection_list.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="subid1",
)
response = client.express_route_circuit_connections.list(
resource_group_name="rg1",
circuit_name="ExpressRouteARMCircuitA",
peering_name="AzurePrivatePeering",
)
for item in response:
print(item)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionList.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 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/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionList.json
func ExampleExpressRouteCircuitConnectionsClient_NewListPager() {
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)
}
pager := clientFactory.NewExpressRouteCircuitConnectionsClient().NewListPager("rg1", "ExpressRouteARMCircuitA", "AzurePrivatePeering", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.ExpressRouteCircuitConnectionListResult = armnetwork.ExpressRouteCircuitConnectionListResult{
// Value: []*armnetwork.ExpressRouteCircuitConnection{
// {
// ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS"),
// Name: to.Ptr("circuitConnectionUSAUS"),
// Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
// Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
// AddressPrefix: to.Ptr("10.0.0.0/24"),
// AuthorizationKey: to.Ptr("946a1918-b7a2-4917-b43c-8c4cdaee006a"),
// CircuitConnectionStatus: to.Ptr(armnetwork.CircuitConnectionStatusConnected),
// ExpressRouteCircuitPeering: &armnetwork.SubResource{
// ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
// },
// IPv6CircuitConnectionConfig: &armnetwork.IPv6CircuitConnectionConfig{
// AddressPrefix: to.Ptr("aa:bb::1/125"),
// CircuitConnectionStatus: to.Ptr(armnetwork.CircuitConnectionStatusConnected),
// },
// PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
// ID: to.Ptr("/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"),
// },
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// },
// },
// {
// ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR"),
// Name: to.Ptr("circuitConnectionUSEUR"),
// Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
// Properties: &armnetwork.ExpressRouteCircuitConnectionPropertiesFormat{
// AddressPrefix: to.Ptr("20.0.0.0/24"),
// CircuitConnectionStatus: to.Ptr(armnetwork.CircuitConnectionStatusConnected),
// ExpressRouteCircuitPeering: &armnetwork.SubResource{
// ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"),
// },
// PeerExpressRouteCircuitPeering: &armnetwork.SubResource{
// ID: to.Ptr("/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering"),
// },
// ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets all global reach connections associated with a private peering in an express route circuit.
*
* @summary Gets all global reach connections associated with a private peering in an express route circuit.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionList.json
*/
async function listExpressRouteCircuitConnection() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid1";
const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
const circuitName = "ExpressRouteARMCircuitA";
const peeringName = "AzurePrivatePeering";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.expressRouteCircuitConnections.list(
resourceGroupName,
circuitName,
peeringName,
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCircuitConnectionList.json
// this example is just showing the usage of "ExpressRouteCircuitConnections_List" 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 ExpressRouteCircuitPeeringResource created on azure
// for more information of creating ExpressRouteCircuitPeeringResource, please refer to the document of ExpressRouteCircuitPeeringResource
string subscriptionId = "subid1";
string resourceGroupName = "rg1";
string circuitName = "ExpressRouteARMCircuitA";
string peeringName = "AzurePrivatePeering";
ResourceIdentifier expressRouteCircuitPeeringResourceId = ExpressRouteCircuitPeeringResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, circuitName, peeringName);
ExpressRouteCircuitPeeringResource expressRouteCircuitPeering = client.GetExpressRouteCircuitPeeringResource(expressRouteCircuitPeeringResourceId);
// get the collection of this ExpressRouteCircuitConnectionResource
ExpressRouteCircuitConnectionCollection collection = expressRouteCircuitPeering.GetExpressRouteCircuitConnections();
// invoke the operation and iterate over the result
await foreach (ExpressRouteCircuitConnectionResource item in collection.GetAllAsync())
{
// the variable item 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
ExpressRouteCircuitConnectionData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"name": "circuitConnectionUSAUS",
"properties": {
"expressRouteCircuitPeering": {
"id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
},
"peerExpressRouteCircuitPeering": {
"id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering"
},
"authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a",
"addressPrefix": "10.0.0.0/24",
"circuitConnectionStatus": "Connected",
"provisioningState": "Succeeded",
"ipv6CircuitConnectionConfig": {
"addressPrefix": "aa:bb::1/125",
"circuitConnectionStatus": "Connected"
}
}
},
{
"id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"name": "circuitConnectionUSEUR",
"properties": {
"expressRouteCircuitPeering": {
"id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering"
},
"peerExpressRouteCircuitPeering": {
"id": "/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering"
},
"addressPrefix": "20.0.0.0/24",
"circuitConnectionStatus": "Connected",
"provisioningState": "Succeeded"
}
}
]
}
Definitions
CircuitConnectionStatus
Express Route Circuit connection state.
| Name |
Type |
Description |
|
Connected
|
string
|
|
|
Connecting
|
string
|
|
|
Disconnected
|
string
|
|
CloudError
An error response from the service.
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.
|
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.
|
ExpressRouteCircuitConnectionListResult
Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit.
| Name |
Type |
Description |
|
nextLink
|
string
|
The URL to get the next set of results.
|
|
value
|
ExpressRouteCircuitConnection[]
|
The global reach connection associated with Private Peering in an ExpressRoute Circuit.
|
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.
|
ProvisioningState
The current provisioning state.
| Name |
Type |
Description |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
SubResource
Reference to another subresource.
| Name |
Type |
Description |
|
id
|
string
|
Resource ID.
|