Express Route Circuits - List

Serviço:: ExpressRoute

Versão da API:: 2025-05-01

Obtém todos os circuitos de rota expressa em um grupo de recursos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ExpressRouteCircuitListResult	Operação do Azure concluída com sucesso.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Definições

Name	Description
AdvertisedPublicPrefixProperties	Propriedades de prefixo necessárias para executar a validação usando a assinatura openssl.
AdvertisedPublicPrefixPropertiesValidationState	Prefixo público anunciado Estado que indica se o prefixo está validado ou não.
AuthorizationUseStatus	O status de uso da autorização.
CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpressRouteCircuit	Recurso ExpressRouteCircuit.
ExpressRouteCircuitAuthorization	Autorização em um recurso ExpressRouteCircuit.
ExpressRouteCircuitConnection	Conexão de circuito de rota expressa em um recurso ExpressRouteCircuitPeering.
ExpressRouteCircuitListResult	A resposta de uma operação de lista ExpressRouteCircuit.
ExpressRouteCircuitPeering	Emparelhamento em um recurso ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado do prefixo público anunciado do recurso de emparelhamento.
ExpressRouteCircuitPeeringConfig	Especifica a configuração de emparelhamento.
ExpressRouteCircuitPeeringState	O estado do peering.
ExpressRouteCircuitServiceProviderProperties	Contém ServiceProviderProperties em um ExpressRouteCircuit.
ExpressRouteCircuitSku	Contém SKU em um ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	A família do SKU.
ExpressRouteCircuitSkuTier	A camada do SKU.
ExpressRouteCircuitStats	Contém estatísticas associadas ao emparelhamento.
ExpressRouteConnectionId	A ID do ExpressRouteConnection.
ExpressRoutePeeringState	O estado do peering.
ExpressRoutePeeringType	O tipo de emparelhamento.
Ipv6CircuitConnectionConfig	Propriedades de Conexão de Circuito IPv6 para alcance global.
Ipv6ExpressRouteCircuitPeeringConfig	Contém configuração de emparelhamento IPv6.
PeerExpressRouteCircuitConnection	Conexão de Circuito de Rota Expressa Ponto a Ponto em um recurso ExpressRouteCircuitPeering.
ProvisioningState	Estados de provisionamento de um recurso.
ServiceProviderProvisioningState	O estado ServiceProviderProvisioningState do recurso.
SubResource	Referência a outro subrecurso.

AdvertisedPublicPrefixProperties

Object

Propriedades de prefixo necessárias para executar a validação usando a assinatura openssl.

Name	Tipo	Description
prefix	string	Prefixo público anunciado.
signature	string	String assinada gerada pela criptografia validationId com uma chave privada.
validationId	string	Cadeia de caracteres de validação que contém informações de emparelhamento de circuito.
validationState	AdvertisedPublicPrefixPropertiesValidationState	Prefixo público anunciado Estado que indica se o prefixo está validado ou não.

AdvertisedPublicPrefixPropertiesValidationState

Enumeração

Prefixo público anunciado Estado que indica se o prefixo está validado ou não.

Valor	Description
NotConfigured	NotConfigured
Configuring	Configuração
Configured	Configurado
ValidationNeeded	ValidaçãoNecessária
ValidationFailed	ValidaçãoFalhou
ManualValidationNeeded	Manual ValidaçãoNecessária
AsnValidationFailed	AsnValidaçãoFalhada
CertificateMissingInRoutingRegistry	CertificateMissingInRoutingRegistry
InvalidSignatureEncoding	CodificaçãoAssinaturaInvalid
SignatureVerificationFailed	Falha na Verificação da Assinatura

AuthorizationUseStatus

Enumeração

O status de uso da autorização.

Valor	Description
Available	Disponível
InUse	Inutilização

CircuitConnectionStatus

Enumeração

Estado de conexão do Circuito de Rota Expressa.

Valor	Description
Connected	Connected
Connecting	Connecting
Disconnected	Disconnected

CloudError

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

CloudErrorBody

Object

Uma resposta de erro do serviço.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteCircuit

Object

Recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.allowClassicOperations	boolean	Permita operações clássicas.
properties.authorizationKey	string	A authorizationKey.
properties.authorizationStatus	string	O status de autorização do Circuito.
properties.authorizations	ExpressRouteCircuitAuthorization[]	A lista de autorizações.
properties.bandwidthInGbps	number (float)	A largura de banda do circuito quando o circuito é provisionado em um recurso ExpressRoutePort.
properties.circuitProvisioningState	string	O estado CircuitProvisioningState do recurso.
properties.enableDirectPortRateLimit	boolean	Sinalizador que indica o status de limitação de taxa do circuito de porta direta da Rota Expressa.
properties.expressRoutePort	SubResource	A referência ao recurso ExpressRoutePort quando o circuito é provisionado em um recurso ExpressRoutePort.
properties.gatewayManagerEtag	string	O GatewayManager Etag.
properties.globalReachEnabled	boolean	Sinalizador que indica o status de alcance global.
properties.peerings	ExpressRouteCircuitPeering[]	A lista de pares.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de circuito de rota expressa.
properties.serviceKey	string	A ServiceKey.
properties.serviceProviderNotes	string	O ServiceProviderNotes.
properties.serviceProviderProperties	ExpressRouteCircuitServiceProviderProperties	O ServiceProviderProperties.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	O estado ServiceProviderProvisioningState do recurso.
properties.stag	integer (int32)	O identificador do tráfego do circuito. Tag externa para encapsulamento QinQ.
sku	ExpressRouteCircuitSku	O SKU.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

ExpressRouteCircuitAuthorization

Object

Autorização em um recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.authorizationKey	string	A chave de autorização.
properties.authorizationUseStatus	AuthorizationUseStatus	O status de uso da autorização.
properties.connectionResourceUri	string	A referência ao recurso de conexão ExpressRoute usando a autorização.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de autorização.
type	string	Tipo de recurso.

ExpressRouteCircuitConnection

Object

Conexão de circuito de rota expressa em um recurso ExpressRouteCircuitPeering.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.addressPrefix	string	/29 espaço de endereço IP para criar endereços de clientes para túneis.
properties.authorizationKey	string	A chave de autorização.
properties.circuitConnectionStatus	CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.
properties.expressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito que inicia a conexão.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da conexão do circuito de rota expressa.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito emparelhado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão de circuito de rota expressa.
type	string	Tipo de recurso.

ExpressRouteCircuitListResult

Object

A resposta de uma operação de lista ExpressRouteCircuit.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	ExpressRouteCircuit[]	Os itens do ExpressRouteCircuit nesta página

ExpressRouteCircuitPeering

Object

Emparelhamento em um recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.azureASN	integer (int32)	O ASN do Azure.
properties.connections	ExpressRouteCircuitConnection[]	A lista de conexões de circuito associadas ao Emparelhamento Privado do Azure para este circuito.
properties.expressRouteConnection	ExpressRouteConnectionId	A conexão ExpressRoute.
properties.gatewayManagerEtag	string	O GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento IPv6.
properties.lastModifiedBy	string	Quem foi o último a modificar o peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento da Microsoft.
properties.peerASN	integer (int64) minimum: 1 maximum: 4294967295	O ASN par.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	A lista de conexões de circuito emparelhadas associadas ao Emparelhamento Privado do Azure para este circuito.
properties.peeringType	ExpressRoutePeeringType	O tipo de emparelhamento.
properties.primaryAzurePort	string	A porta principal.
properties.primaryPeerAddressPrefix	string	O prefixo do endereço principal.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de emparelhamento de circuito de rota expressa.
properties.routeFilter	SubResource	A referência ao recurso RouteFilter.
properties.secondaryAzurePort	string	A porta secundária.
properties.secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
properties.sharedKey	string	A chave compartilhada.
properties.state	ExpressRoutePeeringState	O estado de emparelhamento.
properties.stats	ExpressRouteCircuitStats	As estatísticas de emparelhamento do circuito de rota expressa.
properties.vlanId	integer (int32)	O Identificador VLAN.
type	string	Tipo de recurso.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Enumeração

O estado do prefixo público anunciado do recurso de emparelhamento.

Valor	Description
NotConfigured	NotConfigured
Configuring	Configuração
Configured	Configurado
ValidationNeeded	ValidaçãoNecessária

ExpressRouteCircuitPeeringConfig

Object

Especifica a configuração de emparelhamento.

Name	Tipo	Description
advertisedCommunities	string[]	As comunidades de bgp peering. Especificado para emparelhamento da Microsoft.
advertisedPublicPrefixInfo	AdvertisedPublicPrefixProperties[]	Lista de informações de prefixo necessárias para executar a validação.
advertisedPublicPrefixes	string[]	A referência a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado do prefixo público anunciado do recurso de emparelhamento.
customerASN	integer (int32)	O CustomerASN do emparelhamento.
legacyMode	integer (int32)	O modo legado do emparelhamento.
routingRegistryName	string	O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

Enumeração

O estado do peering.

Valor	Description
Disabled	Disabled
Enabled	Ativado

ExpressRouteCircuitServiceProviderProperties

Object

Contém ServiceProviderProperties em um ExpressRouteCircuit.

Name	Tipo	Description
bandwidthInMbps	integer (int32)	O BandwidthInMbps.
peeringLocation	string	O local de emparelhamento.
serviceProviderName	string	O serviceProviderName.

ExpressRouteCircuitSku

Object

Contém SKU em um ExpressRouteCircuit.

Name	Tipo	Description
family	ExpressRouteCircuitSkuFamily	A família do SKU.
name	string	O nome do SKU.
tier	ExpressRouteCircuitSkuTier	A camada do SKU.

ExpressRouteCircuitSkuFamily

Enumeração

A família do SKU.

Valor	Description
UnlimitedData	UnlimitedData
MeteredData	MeteredData

ExpressRouteCircuitSkuTier

Enumeração

A camada do SKU.

Valor	Description
Standard	Standard
Premium	Premium
Basic	Básico
Local	Local

ExpressRouteCircuitStats

Object

Contém estatísticas associadas ao emparelhamento.

Name	Tipo	Description
primarybytesIn	integer (int64)	Os BytesIn primários do emparelhamento.
primarybytesOut	integer (int64)	O BytesOut primário do emparelhamento.
secondarybytesIn	integer (int64)	O BytesIn secundário do emparelhamento.
secondarybytesOut	integer (int64)	O BytesOut secundário do emparelhamento.

ExpressRouteConnectionId

Object

A ID do ExpressRouteConnection.

Name	Tipo	Description
id	string	A ID do ExpressRouteConnection.

ExpressRoutePeeringState

Enumeração

O estado do peering.

Valor	Description
Disabled	Disabled
Enabled	Ativado

ExpressRoutePeeringType

Enumeração

O tipo de emparelhamento.

Valor	Description
AzurePublicPeering	AzurePublicPeering
AzurePrivatePeering	AzurePrivatePeering
MicrosoftPeering	MicrosoftPeering

Ipv6CircuitConnectionConfig

Object

Propriedades de Conexão de Circuito IPv6 para alcance global.

Name	Tipo	Description
addressPrefix	string	/125 espaço de endereços IP para criar endereços de clientes para alcance global.
circuitConnectionStatus	CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.

Ipv6ExpressRouteCircuitPeeringConfig

Object

Contém configuração de emparelhamento IPv6.

Name	Tipo	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento da Microsoft.
primaryPeerAddressPrefix	string	O prefixo do endereço principal.
routeFilter	SubResource	A referência ao recurso RouteFilter.
secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
state	ExpressRouteCircuitPeeringState	O estado do peering.

PeerExpressRouteCircuitConnection

Object

Conexão de Circuito de Rota Expressa Ponto a Ponto em um recurso ExpressRouteCircuitPeering.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	Nome do recurso.
properties.addressPrefix	string	/29 espaço de endereço IP para criar endereços de clientes para túneis.
properties.authResourceGuid	string	O guid de recurso da autorização usada para a conexão de circuito de rota expressa.
properties.circuitConnectionStatus	CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.
properties.connectionName	string	O nome do recurso de conexão de circuito de rota expressa.
properties.expressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito emparelhado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão de circuito de rota expressa ponto a ponto.
type	string	Tipo de recurso.

ProvisioningState

Enumeração

Estados de provisionamento de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criação
Updating	Atualização
Deleting	Eliminar

ServiceProviderProvisioningState

Enumeração

O estado ServiceProviderProvisioningState do recurso.

Valor	Description
NotProvisioned	NotProvisioned
Provisioning	Provisioning
Provisioned	Aprovisionado
Deprovisioning	Desprovisionamento

SubResource

Object

Referência a outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

Partilhar via

Express Route Circuits - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

List ExpressRouteCircuits in a resource group

Pedido de amostra

Resposta da amostra

Definições

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