Express Route Circuits - List

Service:: ExpressRoute

Version d'API:: 2025-05-01

Obtient tous les circuits d’itinéraire express dans un groupe de ressources.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ExpressRouteCircuitListResult	Opération Azure terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

List ExpressRouteCircuits in a resource group

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits?api-version=2025-05-01

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets all the express route circuits in a resource group.
 *
 * @summary Gets all the express route circuits in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/ExpressRouteCircuitListByResourceGroup.json
 */
async function listExpressRouteCircuitsInAResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.expressRouteCircuits.list(resourceGroupName)) {
    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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "name": "circuitName1",
      "type": "Microsoft.Network/expressRouteCircuits",
      "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1",
      "location": "westus",
      "properties": {
        "allowClassicOperations": false,
        "authorizations": [
          {
            "name": "MyAuthorization1",
            "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1",
            "properties": {
              "authorizationKey": "authkey",
              "authorizationUseStatus": "Available",
              "provisioningState": "Succeeded"
            }
          }
        ],
        "circuitProvisioningState": "Enabled",
        "gatewayManagerEtag": "113",
        "peerings": [],
        "provisioningState": "Succeeded",
        "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1",
        "serviceProviderProperties": {
          "bandwidthInMbps": 200,
          "peeringLocation": "peeringLocation",
          "serviceProviderName": "providerName"
        },
        "serviceProviderProvisioningState": "Provisioned"
      },
      "sku": {
        "name": "Standard_MeteredData",
        "family": "MeteredData",
        "tier": "Standard"
      }
    },
    {
      "name": "circuitName2",
      "type": "Microsoft.Network/expressRouteCircuits",
      "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2",
      "location": "westus",
      "properties": {
        "allowClassicOperations": false,
        "authorizations": [
          {
            "name": "MyAuthorization2",
            "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"",
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2",
            "properties": {
              "authorizationKey": "authkey",
              "authorizationUseStatus": "Available",
              "provisioningState": "Succeeded"
            }
          }
        ],
        "circuitProvisioningState": "Enabled",
        "gatewayManagerEtag": "",
        "peerings": [],
        "provisioningState": "Succeeded",
        "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609",
        "serviceProviderProperties": {
          "bandwidthInMbps": 200,
          "peeringLocation": "peeringLocation",
          "serviceProviderName": "providerName"
        },
        "serviceProviderProvisioningState": "NotProvisioned"
      },
      "sku": {
        "name": "Standard_MeteredData",
        "family": "MeteredData",
        "tier": "Standard"
      }
    }
  ]
}

Définitions

Nom	Description
AdvertisedPublicPrefixProperties	Propriétés de préfixe requises pour effectuer la validation à l’aide de la signature openssl.
AdvertisedPublicPrefixPropertiesValidationState	État du préfixe public annoncé qui indique si le préfixe est validé ou non.
AuthorizationUseStatus	État d’utilisation de l’autorisation.
CircuitConnectionStatus	État de la connexion du circuit de route express.
CloudError	Une réponse d’erreur du service.
CloudErrorBody	Une réponse d’erreur du service.
ExpressRouteCircuit	Ressource ExpressRouteCircuit.
ExpressRouteCircuitAuthorization	Autorisation dans une ressource ExpressRouteCircuit.
ExpressRouteCircuitConnection	Connexion de circuit ExpressRoute dans une ressource ExpressRouteCircuitPeering.
ExpressRouteCircuitListResult	La réponse d’une opération de liste ExpressRouteCircuit.
ExpressRouteCircuitPeering	Peering dans une ressource ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État de préfixe public annoncé de la ressource Peering.
ExpressRouteCircuitPeeringConfig	Spécifie la configuration de peering.
ExpressRouteCircuitPeeringState	État du peering.
ExpressRouteCircuitServiceProviderProperties	Contient ServiceProviderProperties dans un ExpressRouteCircuit.
ExpressRouteCircuitSku	Contient la référence SKU dans un ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	Famille de la référence SKU.
ExpressRouteCircuitSkuTier	Niveau de la référence SKU.
ExpressRouteCircuitStats	Contient des statistiques associées au peering.
ExpressRouteConnectionId	ID d’ExpressRouteConnection.
ExpressRoutePeeringState	État du peering.
ExpressRoutePeeringType	Type de peering.
Ipv6CircuitConnectionConfig	Propriétés de connexion de circuit IPv6 pour une portée globale.
Ipv6ExpressRouteCircuitPeeringConfig	Contient la configuration de peering IPv6.
PeerExpressRouteCircuitConnection	Connexion de circuit de route express d’homologue dans une ressource ExpressRouteCircuitPeering.
ProvisioningState	États de provisionnement d’une ressource.
ServiceProviderProvisioningState	État ServiceProviderProvisioningState de la ressource.
SubResource	Référence à une autre sous-ressource.

AdvertisedPublicPrefixProperties

Objet

Propriétés de préfixe requises pour effectuer la validation à l’aide de la signature openssl.

Nom	Type	Description
prefix	string	Préfixe public annoncé.
signature	string	Chaîne signée générée en chiffrant validationId avec une clé privée.
validationId	string	Chaîne de validation contenant des informations d’appairage de circuits.
validationState	AdvertisedPublicPrefixPropertiesValidationState	État du préfixe public annoncé qui indique si le préfixe est validé ou non.

AdvertisedPublicPrefixPropertiesValidationState

Énumération

État du préfixe public annoncé qui indique si le préfixe est validé ou non.

Valeur	Description
NotConfigured	Non configuré
Configuring	Configuration
Configured	Configuré
ValidationNeeded	Validation nécessaire
ValidationFailed	Échec de la validation
ManualValidationNeeded	ValidationManuelNécessaire
AsnValidationFailed	AsnValidationÉchouée
CertificateMissingInRoutingRegistry	CertificatMissingInRoutingRegistry
InvalidSignatureEncoding	InvalidSignatureEncoding
SignatureVerificationFailed	Échec de la vérification de la signature

AuthorizationUseStatus

Énumération

État d’utilisation de l’autorisation.

Valeur	Description
Available	Disponible
InUse	InUse

CircuitConnectionStatus

Énumération

État de la connexion du circuit de route express.

Valeur	Description
Connected	Connecté
Connecting	Connecting
Disconnected	Déconnecté

CloudError

Objet

Une réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Corps de l’erreur Cloud.

CloudErrorBody

Objet

Une 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 programme.
details	CloudErrorBody[]	Une 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.

ExpressRouteCircuit

Objet

Ressource ExpressRouteCircuit.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.allowClassicOperations	boolean	Autoriser les opérations classiques.
properties.authorizationKey	string	AuthorizationKey.
properties.authorizationStatus	string	Le statut d’autorisation du Circuit.
properties.authorizations	ExpressRouteCircuitAuthorization[]	Liste des autorisations.
properties.bandwidthInGbps	number (float)	Bande passante du circuit lorsque le circuit est approvisionné sur une ressource ExpressRoutePort.
properties.circuitProvisioningState	string	État CircuitProvisioningState de la ressource.
properties.enableDirectPortRateLimit	boolean	Indicateur indiquant l’état de limitation de débit du circuit expressRoute direct-port.
properties.expressRoutePort	SubResource	Référence à la ressource ExpressRoutePort lorsque le circuit est provisionné sur une ressource ExpressRoutePort.
properties.gatewayManagerEtag	string	L’Etag GatewayManager.
properties.globalReachEnabled	boolean	Indicateur indiquant l’état d’accès global.
properties.peerings	ExpressRouteCircuitPeering[]	Liste des peerings.
properties.provisioningState	ProvisioningState	État de provisionnement de la ressource de circuit de route express.
properties.serviceKey	string	La ServiceKey.
properties.serviceProviderNotes	string	Le ServiceProviderNotes.
properties.serviceProviderProperties	ExpressRouteCircuitServiceProviderProperties	Les PropriétésFournisseurs.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	État ServiceProviderProvisioningState de la ressource.
properties.stag	integer (int32)	L’identifiant du trafic du circuit. Étiquette externe pour l’encapsulation QinQ.
sku	ExpressRouteCircuitSku	Référence SKU.
tags	object	Balises de ressource.
type	string	Type de ressource.

ExpressRouteCircuitAuthorization

Objet

Autorisation dans une ressource ExpressRouteCircuit.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.authorizationKey	string	Clé d’autorisation.
properties.authorizationUseStatus	AuthorizationUseStatus	État d’utilisation de l’autorisation.
properties.connectionResourceUri	string	Référence à la ressource de connexion ExpressRoute à l’aide de l’autorisation.
properties.provisioningState	ProvisioningState	État de provisionnement de la ressource d’autorisation.
type	string	Type de ressource.

ExpressRouteCircuitConnection

Objet

Connexion de circuit ExpressRoute dans une ressource ExpressRouteCircuitPeering.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.addressPrefix	string	/29'espace d’adressage IP pour extraire les adresses client pour les tunnels.
properties.authorizationKey	string	Clé d’autorisation.
properties.circuitConnectionStatus	CircuitConnectionStatus	État de la connexion du circuit de route express.
properties.expressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit qui lance la connexion.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Préfixe d’adresse IPv6Properties de la connexion de circuit express route.
properties.peerExpressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit appairé.
properties.provisioningState	ProvisioningState	État de provisionnement de la ressource de connexion de circuit de route express.
type	string	Type de ressource.

ExpressRouteCircuitListResult

Objet

La réponse d’une opération de liste ExpressRouteCircuit.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	ExpressRouteCircuit[]	Les éléments ExpressRouteCircuit sur cette page

ExpressRouteCircuitPeering

Objet

Peering dans une ressource ExpressRouteCircuit.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.azureASN	integer (int32)	ASN Azure.
properties.connections	ExpressRouteCircuitConnection[]	Liste des connexions de circuit associées au peering privé Azure pour ce circuit.
properties.expressRouteConnection	ExpressRouteConnectionId	Connexion ExpressRoute.
properties.gatewayManagerEtag	string	L’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 (int64) minimum: 1 maximum: 4294967295	ASN d’homologue.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	Liste des connexions de circuit appairé associées à l’appairage privé Azure pour ce circuit.
properties.peeringType	ExpressRoutePeeringType	Type de peering.
properties.primaryAzurePort	string	Port principal.
properties.primaryPeerAddressPrefix	string	Préfixe d’adresse primaire.
properties.provisioningState	ProvisioningState	État de provisionnement de la ressource d’appairage de circuits de route express.
properties.routeFilter	SubResource	Référence à la ressource RouteFilter.
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.stats	ExpressRouteCircuitStats	Statistiques de peering du circuit express route.
properties.vlanId	integer (int32)	ID de l’VLAN.
type	string	Type de ressource.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Énumération

État de préfixe public annoncé de la ressource Peering.

Valeur	Description
NotConfigured	Non configuré
Configuring	Configuration
Configured	Configuré
ValidationNeeded	Validation nécessaire

ExpressRouteCircuitPeeringConfig

Objet

Spécifie la configuration de peering.

Nom	Type	Description
advertisedCommunities	string[]	Communautés de peering bgp. Spécifié pour le peering Microsoft.
advertisedPublicPrefixInfo	AdvertisedPublicPrefixProperties[]	Liste des informations de préfixe requises pour effectuer la validation.
advertisedPublicPrefixes	string[]	Référence à AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	État de préfixe public annoncé de la ressource Peering.
customerASN	integer (int32)	CustomerASN du peering.
legacyMode	integer (int32)	Mode hérité du peering.
routingRegistryName	string	RoutingRegistryName de la configuration.

ExpressRouteCircuitPeeringState

Énumération

État du peering.

Valeur	Description
Disabled	Désactivé
Enabled	Activé

ExpressRouteCircuitServiceProviderProperties

Objet

Contient ServiceProviderProperties dans un ExpressRouteCircuit.

Nom	Type	Description
bandwidthInMbps	integer (int32)	Bande passanteInMbps.
peeringLocation	string	Emplacement de peering.
serviceProviderName	string	ServiceProviderName.

ExpressRouteCircuitSku

Objet

Contient la référence SKU dans un ExpressRouteCircuit.

Nom	Type	Description
family	ExpressRouteCircuitSkuFamily	Famille de la référence SKU.
name	string	Nom de la référence SKU.
tier	ExpressRouteCircuitSkuTier	Niveau de la référence SKU.

ExpressRouteCircuitSkuFamily

Énumération

Famille de la référence SKU.

Valeur	Description
UnlimitedData	UnlimitedData
MeteredData	MeteredData

ExpressRouteCircuitSkuTier

Énumération

Niveau de la référence SKU.

Valeur	Description
Standard	Norme
Premium	Premium
Basic	Basic
Local	Local

ExpressRouteCircuitStats

Objet

Contient des statistiques associées au peering.

Nom	Type	Description
primarybytesIn	integer (int64)	Octets principaux du peering.
primarybytesOut	integer (int64)	Octets principaux De l’appairage.
secondarybytesIn	integer (int64)	Octets secondaires du peering.
secondarybytesOut	integer (int64)	Octets secondairesOut du peering.

ExpressRouteConnectionId

Objet

ID d’ExpressRouteConnection.

Nom	Type	Description
id	string	ID d’ExpressRouteConnection.

ExpressRoutePeeringState

Énumération

État du peering.

Valeur	Description
Disabled	Désactivé
Enabled	Activé

ExpressRoutePeeringType

Énumération

Type de peering.

Valeur	Description
AzurePublicPeering	AzurePublicPeering
AzurePrivatePeering	AzurePrivatePeering
MicrosoftPeering	MicrosoftPeering

Ipv6CircuitConnectionConfig

Objet

Propriétés de connexion de circuit IPv6 pour une portée globale.

Nom	Type	Description
addressPrefix	string	/125'espace d’adressage IP pour découper les adresses client pour une portée globale.
circuitConnectionStatus	CircuitConnectionStatus	État de la connexion du circuit de route express.

Ipv6ExpressRouteCircuitPeeringConfig

Objet

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.

PeerExpressRouteCircuitConnection

Objet

Connexion de circuit de route express d’homologue dans une ressource ExpressRouteCircuitPeering.

Nom	Type	Description
etag	string	Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour.
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.addressPrefix	string	/29'espace d’adressage IP pour extraire les adresses client pour les tunnels.
properties.authResourceGuid	string	GUID de ressource de l’autorisation utilisée pour la connexion au circuit de route express.
properties.circuitConnectionStatus	CircuitConnectionStatus	État de la connexion du circuit de route express.
properties.connectionName	string	Nom de la ressource de connexion au circuit de route express.
properties.expressRouteCircuitPeering	SubResource	Référence à la ressource d’appairage privé du circuit de route express du circuit.
properties.peerExpressRouteCircuitPeering	SubResource	Référence à la ressource de peering privé du circuit Express Route Circuit du circuit appairé.
properties.provisioningState	ProvisioningState	État de provisionnement de la ressource de connexion de circuit de route express homologue.
type	string	Type de ressource.

ProvisioningState

Énumération

États de provisionnement d’une ressource.

Valeur	Description
Failed	Échec
Succeeded	Réussi
Canceled	Opération annulée
Creating	Création
Updating	Mise à jour
Deleting	Suppression

ServiceProviderProvisioningState

Énumération

État ServiceProviderProvisioningState de la ressource.

Valeur	Description
NotProvisioned	NotProvisioned
Provisioning	Provisioning
Provisioned	provisionné
Deprovisioning	Annulation de l'approvisionnement

SubResource

Objet

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

Nom	Type	Description
id	string	ID de ressource.

Partager via

Express Route Circuits - List

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

List ExpressRouteCircuits in a resource group

Exemple de requête

Exemple de réponse

Définitions

AdvertisedPublicPrefixProperties

AdvertisedPublicPrefixPropertiesValidationState

AuthorizationUseStatus

CircuitConnectionStatus

CloudError

CloudErrorBody

ExpressRouteCircuit

ExpressRouteCircuitAuthorization

ExpressRouteCircuitConnection

ExpressRouteCircuitListResult

ExpressRouteCircuitPeering

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringState

ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitSku

ExpressRouteCircuitSkuFamily

ExpressRouteCircuitSkuTier

ExpressRouteCircuitStats

ExpressRouteConnectionId

ExpressRoutePeeringState

ExpressRoutePeeringType

Ipv6CircuitConnectionConfig

Ipv6ExpressRouteCircuitPeeringConfig

PeerExpressRouteCircuitConnection

ProvisioningState

ServiceProviderProvisioningState

SubResource