Express Route Cross Connection Peerings - List

Service:

ExpressRoute

API Version:

2023-09-01

Obtient tous les peerings dans un ExpressRouteCrossConnection spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings?api-version=2023-09-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
crossConnectionName	path	True	string	Nom d’ExpressRouteCrossConnection.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	ExpressRouteCrossConnectionPeeringList	La demande a réussi. L’opération retourne une liste de ressources ExpressRouteCrossConnectionPeering.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ExpressRouteCrossConnectionBgpPeeringList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings?api-version=2023-09-01

Java

/**
 * Samples for ExpressRouteCrossConnectionPeerings List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * ExpressRouteCrossConnectionBgpPeeringList.json
     */
    /**
     * Sample code: ExpressRouteCrossConnectionBgpPeeringList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRouteCrossConnectionBgpPeeringList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCrossConnectionPeerings()
            .list("CrossConnection-SiliconValley", "<circuitServiceKey>", 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_cross_connection_bgp_peering_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="subid",
    )

    response = client.express_route_cross_connection_peerings.list(
        resource_group_name="CrossConnection-SiliconValley",
        cross_connection_name="<circuitServiceKey>",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionBgpPeeringList.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/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/ExpressRouteCrossConnectionBgpPeeringList.json
func ExampleExpressRouteCrossConnectionPeeringsClient_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.NewExpressRouteCrossConnectionPeeringsClient().NewListPager("CrossConnection-SiliconValley", "<circuitServiceKey>", 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.ExpressRouteCrossConnectionPeeringList = armnetwork.ExpressRouteCrossConnectionPeeringList{
		// 	Value: []*armnetwork.ExpressRouteCrossConnectionPeering{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings/AzurePrivatePeering"),
		// 			Name: to.Ptr("AzurePrivatePeering"),
		// 			Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
		// 			Properties: &armnetwork.ExpressRouteCrossConnectionPeeringProperties{
		// 				AzureASN: to.Ptr[int32](12076),
		// 				GatewayManagerEtag: to.Ptr(""),
		// 				IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
		// 					PrimaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::/126"),
		// 					SecondaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::4/126"),
		// 					State: to.Ptr(armnetwork.ExpressRouteCircuitPeeringStateEnabled),
		// 				},
		// 				LastModifiedBy: to.Ptr("Customer"),
		// 				PeerASN: to.Ptr[int64](200),
		// 				PeeringType: to.Ptr(armnetwork.ExpressRoutePeeringTypeAzurePrivatePeering),
		// 				PrimaryAzurePort: to.Ptr(""),
		// 				PrimaryPeerAddressPrefix: to.Ptr("192.168.16.252/30"),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				SecondaryAzurePort: to.Ptr(""),
		// 				SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
		// 				State: to.Ptr(armnetwork.ExpressRoutePeeringStateEnabled),
		// 				VlanID: to.Ptr[int32](200),
		// 			},
		// 	}},
		// }
	}
}

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 all peerings in a specified ExpressRouteCrossConnection.
 *
 * @summary Gets all peerings in a specified ExpressRouteCrossConnection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json
 */
async function expressRouteCrossConnectionBgpPeeringList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const crossConnectionName = "<circuitServiceKey>";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.expressRouteCrossConnectionPeerings.list(
    resourceGroupName,
    crossConnectionName,
  )) {
    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

dotnet

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/ExpressRouteCrossConnectionBgpPeeringList.json
// this example is just showing the usage of "ExpressRouteCrossConnectionPeerings_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 ExpressRouteCrossConnectionResource created on azure
// for more information of creating ExpressRouteCrossConnectionResource, please refer to the document of ExpressRouteCrossConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
string crossConnectionName = "<circuitServiceKey>";
ResourceIdentifier expressRouteCrossConnectionResourceId = ExpressRouteCrossConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, crossConnectionName);
ExpressRouteCrossConnectionResource expressRouteCrossConnection = client.GetExpressRouteCrossConnectionResource(expressRouteCrossConnectionResourceId);

// get the collection of this ExpressRouteCrossConnectionPeeringResource
ExpressRouteCrossConnectionPeeringCollection collection = expressRouteCrossConnection.GetExpressRouteCrossConnectionPeerings();

// invoke the operation and iterate over the result
await foreach (ExpressRouteCrossConnectionPeeringResource 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
    ExpressRouteCrossConnectionPeeringData 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

Status code:

200

{
  "value": [
    {
      "name": "AzurePrivatePeering",
      "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings/AzurePrivatePeering",
      "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
      "properties": {
        "provisioningState": "Succeeded",
        "peeringType": "AzurePrivatePeering",
        "azureASN": 12076,
        "peerASN": 200,
        "primaryPeerAddressPrefix": "192.168.16.252/30",
        "secondaryPeerAddressPrefix": "192.168.18.252/30",
        "primaryAzurePort": "",
        "secondaryAzurePort": "",
        "state": "Enabled",
        "vlanId": 200,
        "gatewayManagerEtag": "",
        "lastModifiedBy": "Customer",
        "ipv6PeeringConfig": {
          "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
          "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
          "state": "Enabled"
        }
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État du préfixe public publié de la ressource Peering.
ExpressRouteCircuitPeeringConfig	Spécifie la configuration de peering.
ExpressRouteCircuitPeeringState	État du peering.
ExpressRouteCrossConnectionPeering	Peering dans une ressource De connexion croisée ExpressRoute.
ExpressRouteCrossConnectionPeeringList	La réponse à l’appel de service de l’API ListPeering récupère tous les peerings qui appartiennent à une connexion ExpressRouteCrossConnection.
ExpressRoutePeeringState	État du peering.
ExpressRoutePeeringType	Type de peering.
Ipv6ExpressRouteCircuitPeeringConfig	Contient la configuration de peering IPv6.
ProvisioningState	État d’approvisionnement actuel.
SubResource	Référence à une autre sous-ressource.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps d’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

État du préfixe public publié de la ressource Peering.

Nom	Type	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Spécifie la configuration de peering.

Nom	Type	Description
advertisedCommunities	string[]	Communautés du peering bgp. Spécifié pour le peering microsoft.
advertisedPublicPrefixes	string[]	Référence à AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État du préfixe public publié de la ressource Peering.
customerASN	integer	CustomerASN du peering.
legacyMode	integer	Mode hérité du peering.
routingRegistryName	string	RoutageRegistryName de la configuration.

ExpressRouteCircuitPeeringState

État du peering.

Nom	Type	Description
Disabled	string
Enabled	string

ExpressRouteCrossConnectionPeering

Peering dans une ressource De connexion croisée ExpressRoute.

Nom	Type	Description
etag	string	Chaîne unique en lecture seule qui change chaque fois que la ressource est mise à jour.
id	string	ID de la ressource
name	string	Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.
properties.azureASN	integer	ASN Azure.
properties.gatewayManagerEtag	string	Etag GatewayManager.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configuration du peering IPv6.
properties.lastModifiedBy	string	Qui a été le dernier à modifier le peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configuration du peering Microsoft.
properties.peerASN	integer	ASN d’homologue.
properties.peeringType	ExpressRoutePeeringType	Type de peering.
properties.primaryAzurePort	string	Port principal.
properties.primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
properties.provisioningState	ProvisioningState	État d’approvisionnement de la ressource de peering de connexions croisées de routage express.
properties.secondaryAzurePort	string	Port secondaire.
properties.secondaryPeerAddressPrefix	string	Préfixe d’adresse secondaire.
properties.sharedKey	string	Clé partagée.
properties.state	ExpressRoutePeeringState	État de peering.
properties.vlanId	integer	ID de réseau local virtuel.

ExpressRouteCrossConnectionPeeringList

La réponse à l’appel de service de l’API ListPeering récupère tous les peerings qui appartiennent à une connexion ExpressRouteCrossConnection.

Nom	Type	Description
nextLink	string	URL permettant d’obtenir l’ensemble de résultats suivant.
value	ExpressRouteCrossConnectionPeering[]	Peerings dans une connexion croisée de route express.

ExpressRoutePeeringState

État du peering.

Nom	Type	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

Type de peering.

Nom	Type	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Contient la configuration de peering IPv6.

Nom	Type	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configuration du peering Microsoft.
primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
routeFilter	SubResource	Référence à la ressource RouteFilter.
secondaryPeerAddressPrefix	string	Préfixe d’adresse secondaire.
state	ExpressRouteCircuitPeeringState	État du peering.

ProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Référence à une autre sous-ressource.

Nom	Type	Description
id	string	ID de la ressource