Express Route Circuits - List

Service:: ExpressRoute

API-versie:: 2025-05-01

Hiermee haalt u alle expresroutecircuits op in een resourcegroep.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ExpressRouteCircuitListResult	Azure-operatie succesvol voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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"
      }
    }
  ]
}

Definities

Name	Description
AdvertisedPublicPrefixProperties	Voorvoegseleigenschappen die nodig zijn om validatie uit te voeren met behulp van openssl-handtekening.
AdvertisedPublicPrefixPropertiesValidationState	Geadverteerd openbaar voorvoegsel Status die aangeeft of het voorvoegsel is gevalideerd of niet.
AuthorizationUseStatus	De autorisatiegebruiksstatus.
CircuitConnectionStatus	Verbindingsstatus van Express Route Circuit.
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
ExpressRouteCircuit	ExpressRouteCircuit-resource.
ExpressRouteCircuitAuthorization	Autorisatie in een ExpressRouteCircuit-resource.
ExpressRouteCircuitConnection	ExpressRoute-circuitverbinding in een ExpressRouteCircuitPeering-resource.
ExpressRouteCircuitListResult	De reactie van een ExpressRouteCircuit-lijstoperatie.
ExpressRouteCircuitPeering	Peering in een ExpressRouteCircuit-resource.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	De geadverteerd openbare voorvoegselstatus van de Peering-resource.
ExpressRouteCircuitPeeringConfig	Hiermee geeft u de peeringconfiguratie op.
ExpressRouteCircuitPeeringState	De status van peering.
ExpressRouteCircuitServiceProviderProperties	Bevat ServiceProviderProperties in een ExpressRouteCircuit.
ExpressRouteCircuitSku	Bevat SKU in een ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	De familie van de SKU.
ExpressRouteCircuitSkuTier	De laag van de SKU.
ExpressRouteCircuitStats	Bevat statistieken die zijn gekoppeld aan de peering.
ExpressRouteConnectionId	De id van de ExpressRouteConnection.
ExpressRoutePeeringState	De status van peering.
ExpressRoutePeeringType	Het peeringtype.
Ipv6CircuitConnectionConfig	Eigenschappen van de IPv6-circuitverbinding voor globaal bereik.
Ipv6ExpressRouteCircuitPeeringConfig	Bevat IPv6-peeringconfiguratie.
PeerExpressRouteCircuitConnection	Peer Express Route-circuitverbinding in een ExpressRouteCircuitPeering-resource.
ProvisioningState	Inrichtingsstatussen van een resource.
ServiceProviderProvisioningState	De status ServiceProviderProvisioningState van de resource.
SubResource	Verwijzing naar een andere subresource.

AdvertisedPublicPrefixProperties

Object

Voorvoegseleigenschappen die nodig zijn om validatie uit te voeren met behulp van openssl-handtekening.

Name	Type	Description
prefix	string	Geadverteerd openbaar voorvoegsel.
signature	string	Ondertekende tekenreeks die wordt gegenereerd door validationId te versleutelen met een persoonlijke sleutel.
validationId	string	Validatietekenreeks die informatie over peering van circuits bevat.
validationState	AdvertisedPublicPrefixPropertiesValidationState	Geadverteerd openbaar voorvoegsel Status die aangeeft of het voorvoegsel is gevalideerd of niet.

AdvertisedPublicPrefixPropertiesValidationState

Opsomming

Geadverteerd openbaar voorvoegsel Status die aangeeft of het voorvoegsel is gevalideerd of niet.

Waarde	Description
NotConfigured	NotConfigured
Configuring	Configureren
Configured	Geconfigureerd
ValidationNeeded	ValidatieNodig
ValidationFailed	Validatiefailed
ManualValidationNeeded	HandleidingValidatieNodig
AsnValidationFailed	AsnValidationFailed
CertificateMissingInRoutingRegistry	CertificateMissingInRoutingRegistry
InvalidSignatureEncoding	InvalidSignatureEncoding
SignatureVerificationFailed	HandtekeningVerificatie mislukt

AuthorizationUseStatus

Opsomming

De autorisatiegebruiksstatus.

Waarde	Description
Available	Beschikbaar
InUse	Gebruik

CircuitConnectionStatus

Opsomming

Verbindingsstatus van Express Route Circuit.

Waarde	Description
Connected	Connected
Connecting	Connecting
Disconnected	Ontkoppeld

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Wolk fout lichaam.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende details over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

ExpressRouteCircuit

Object

ExpressRouteCircuit-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.allowClassicOperations	boolean	Klassieke bewerkingen toestaan.
properties.authorizationKey	string	De authorizationKey.
properties.authorizationStatus	string	De autorisatiestatus van het circuit.
properties.authorizations	ExpressRouteCircuitAuthorization[]	De lijst met autorisaties.
properties.bandwidthInGbps	number (float)	De bandbreedte van het circuit wanneer het circuit wordt ingericht op een ExpressRoutePort-resource.
properties.circuitProvisioningState	string	De status CircuitProvisioningState van de resource.
properties.enableDirectPortRateLimit	boolean	Vlag die de snelheidsbeperkingsstatus van het ExpressRoute-directpoortcircuit aangeeft.
properties.expressRoutePort	SubResource	De verwijzing naar de ExpressRoutePort-resource wanneer het circuit is ingericht op een ExpressRoutePort-resource.
properties.gatewayManagerEtag	string	De GatewayManager Etag.
properties.globalReachEnabled	boolean	Vlag die de status van globaal bereik aangeeft.
properties.peerings	ExpressRouteCircuitPeering[]	De lijst met peerings.
properties.provisioningState	ProvisioningState	De voorzieningsstatus van de resource voor het expresroutecircuit.
properties.serviceKey	string	De ServiceKey.
properties.serviceProviderNotes	string	De ServiceProviderNotes.
properties.serviceProviderProperties	ExpressRouteCircuitServiceProviderProperties	De ServiceProviderProperties.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	De status ServiceProviderProvisioningState van de resource.
properties.stag	integer (int32)	De identificatie van het circuitverkeer. Buitenste tag voor QinQ-inkapseling.
sku	ExpressRouteCircuitSku	De SKU.
tags	object	Resourcetags.
type	string	Type bron

ExpressRouteCircuitAuthorization

Object

Autorisatie in een ExpressRouteCircuit-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de resource.
properties.authorizationKey	string	De autorisatiesleutel.
properties.authorizationUseStatus	AuthorizationUseStatus	De autorisatiegebruiksstatus.
properties.connectionResourceUri	string	De verwijzing naar de ExpressRoute-verbindingsresource met behulp van de autorisatie.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de autorisatieresource.
type	string	Type bron

ExpressRouteCircuitConnection

Object

ExpressRoute-circuitverbinding in een ExpressRouteCircuitPeering-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de resource.
properties.addressPrefix	string	/29 IP-adresruimte voor het carven van klantadressen voor tunnels.
properties.authorizationKey	string	De autorisatiesleutel.
properties.circuitConnectionStatus	CircuitConnectionStatus	Verbindingsstatus van Express Route Circuit.
properties.expressRouteCircuitPeering	SubResource	Verwijzing naar de privépeeringsresource van het Express Route-circuit van het circuit dat verbinding initieert.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	IPv6-adresvoorvoegselProperties van de expressroute-circuitverbinding.
properties.peerExpressRouteCircuitPeering	SubResource	Verwijzing naar de privépeeringsresource van het Express Route-circuit van het gekoppelde circuit.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de verbindingsresource voor het expresroutecircuit.
type	string	Type bron

ExpressRouteCircuitListResult

Object

De reactie van een ExpressRouteCircuit-lijstoperatie.

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	ExpressRouteCircuit[]	De ExpressRouteCircuit-items op deze pagina

ExpressRouteCircuitPeering

Object

Peering in een ExpressRouteCircuit-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de resource.
properties.azureASN	integer (int32)	De Azure ASN.
properties.connections	ExpressRouteCircuitConnection[]	De lijst met circuitverbindingen die zijn gekoppeld aan Azure Private Peering voor dit circuit.
properties.expressRouteConnection	ExpressRouteConnectionId	De ExpressRoute-verbinding.
properties.gatewayManagerEtag	string	De GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	De IPv6-peeringconfiguratie.
properties.lastModifiedBy	string	Wie was de laatste om de peering te wijzigen.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	De Microsoft-peeringconfiguratie.
properties.peerASN	integer (int64) minimum: 1 maximum: 4294967295	De peer-ASN.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	De lijst met peered circuitverbindingen die zijn gekoppeld aan Azure Private Peering voor dit circuit.
properties.peeringType	ExpressRoutePeeringType	Het peeringtype.
properties.primaryAzurePort	string	De primaire poort.
properties.primaryPeerAddressPrefix	string	Het primaire adresvoorvoegsel.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de peeringresource voor het expresroutecircuit.
properties.routeFilter	SubResource	De verwijzing naar de RouteFilter-resource.
properties.secondaryAzurePort	string	De secundaire poort.
properties.secondaryPeerAddressPrefix	string	Het secundaire adresvoorvoegsel.
properties.sharedKey	string	De gedeelde sleutel.
properties.state	ExpressRoutePeeringState	De peeringstatus.
properties.stats	ExpressRouteCircuitStats	De peeringstatistieken van expressroute-circuit.
properties.vlanId	integer (int32)	De VLAN-ID.
type	string	Type bron

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Opsomming

De geadverteerd openbare voorvoegselstatus van de Peering-resource.

Waarde	Description
NotConfigured	NotConfigured
Configuring	Configureren
Configured	Geconfigureerd
ValidationNeeded	ValidatieNodig

ExpressRouteCircuitPeeringConfig

Object

Hiermee geeft u de peeringconfiguratie op.

Name	Type	Description
advertisedCommunities	string[]	De community's van bgp-peering. Opgegeven voor Microsoft-peering.
advertisedPublicPrefixInfo	AdvertisedPublicPrefixProperties[]	Lijst met voorvoegselinformatie die nodig is om validatie uit te voeren.
advertisedPublicPrefixes	string[]	De verwijzing naar AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	De geadverteerd openbare voorvoegselstatus van de Peering-resource.
customerASN	integer (int32)	De CustomerASN van de peering.
legacyMode	integer (int32)	De verouderde modus van de peering.
routingRegistryName	string	De RoutingRegistryName van de configuratie.

ExpressRouteCircuitPeeringState

Opsomming

De status van peering.

Waarde	Description
Disabled	Uitgeschakeld
Enabled	Ingeschakeld

ExpressRouteCircuitServiceProviderProperties

Object

Bevat ServiceProviderProperties in een ExpressRouteCircuit.

Name	Type	Description
bandwidthInMbps	integer (int32)	De BandwidthInMbps.
peeringLocation	string	De peeringlocatie.
serviceProviderName	string	De serviceProviderName.

ExpressRouteCircuitSku

Object

Bevat SKU in een ExpressRouteCircuit.

Name	Type	Description
family	ExpressRouteCircuitSkuFamily	De familie van de SKU.
name	string	De naam van de SKU.
tier	ExpressRouteCircuitSkuTier	De laag van de SKU.

ExpressRouteCircuitSkuFamily

Opsomming

De familie van de SKU.

Waarde	Description
UnlimitedData	UnlimitedData
MeteredData	MeteredData

ExpressRouteCircuitSkuTier

Opsomming

De laag van de SKU.

Waarde	Description
Standard	Standard
Premium	Premium
Basic	Basic
Local	Lokaal

ExpressRouteCircuitStats

Object

Bevat statistieken die zijn gekoppeld aan de peering.

Name	Type	Description
primarybytesIn	integer (int64)	De primaire bytesIn van de peering.
primarybytesOut	integer (int64)	De primaire BytesOut van de peering.
secondarybytesIn	integer (int64)	De secundaire BytesIn van de peering.
secondarybytesOut	integer (int64)	De secundaire BytesOut van de peering.

ExpressRouteConnectionId

Object

De id van de ExpressRouteConnection.

Name	Type	Description
id	string	De id van de ExpressRouteConnection.

ExpressRoutePeeringState

Opsomming

De status van peering.

Waarde	Description
Disabled	Uitgeschakeld
Enabled	Ingeschakeld

ExpressRoutePeeringType

Opsomming

Het peeringtype.

Waarde	Description
AzurePublicPeering	AzurePublicPeering
AzurePrivatePeering	AzurePrivatePeering
MicrosoftPeering	MicrosoftPeering

Ipv6CircuitConnectionConfig

Object

Eigenschappen van de IPv6-circuitverbinding voor globaal bereik.

Name	Type	Description
addressPrefix	string	/125 IP-adresruimte om klantadressen op te geven voor wereldwijd bereik.
circuitConnectionStatus	CircuitConnectionStatus	Verbindingsstatus van Express Route Circuit.

Ipv6ExpressRouteCircuitPeeringConfig

Object

Bevat IPv6-peeringconfiguratie.

Name	Type	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	De Microsoft-peeringconfiguratie.
primaryPeerAddressPrefix	string	Het primaire adresvoorvoegsel.
routeFilter	SubResource	De verwijzing naar de RouteFilter-resource.
secondaryPeerAddressPrefix	string	Het secundaire adresvoorvoegsel.
state	ExpressRouteCircuitPeeringState	De status van peering.

PeerExpressRouteCircuitConnection

Object

Peer Express Route-circuitverbinding in een ExpressRouteCircuitPeering-resource.

Name	Type	Description
etag	string	Een unieke alleen-lezen tekenreeks die wordt gewijzigd wanneer de resource wordt bijgewerkt.
id	string	Resource-id.
name	string	Naam van de resource.
properties.addressPrefix	string	/29 IP-adresruimte voor het carven van klantadressen voor tunnels.
properties.authResourceGuid	string	De resource-guid van de autorisatie die wordt gebruikt voor de verbinding met het expresroutecircuit.
properties.circuitConnectionStatus	CircuitConnectionStatus	Verbindingsstatus van Express Route Circuit.
properties.connectionName	string	De naam van de verbindingsbron voor het expresroutecircuit.
properties.expressRouteCircuitPeering	SubResource	Verwijzing naar Express Route Circuit Private Peering Resource van het circuit.
properties.peerExpressRouteCircuitPeering	SubResource	Verwijzing naar de privépeeringsresource van het Express Route-circuit van het gekoppelde circuit.
properties.provisioningState	ProvisioningState	De inrichtingsstatus van de verbindingsresource voor peer-expresroutercircuits.
type	string	Type bron

ProvisioningState

Opsomming

Inrichtingsstatussen van een resource.

Waarde	Description
Failed	Mislukt
Succeeded	Geslaagd
Canceled	Geannuleerd
Creating	Creëren
Updating	Bijwerken
Deleting	Verwijderen

ServiceProviderProvisioningState

Opsomming

De status ServiceProviderProvisioningState van de resource.

Waarde	Description
NotProvisioned	NietVoorzien.
Provisioning	Provisioning
Provisioned	Geconfigureerd
Deprovisioning	Uitschakelen

SubResource

Object

Verwijzing naar een andere subresource.

Name	Type	Description
id	string	Resource-id.

Delen via

Express Route Circuits - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

List ExpressRouteCircuits in a resource group

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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