Express Route Circuits - List

Layanan:: ExpressRoute

Versi API:: 2025-05-01

Mendapatkan semua sirkuit rute ekspres dalam grup sumber daya.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ExpressRouteCircuitListResult	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Respon sampel

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

Definisi

Nama	Deskripsi
AdvertisedPublicPrefixProperties	Properti awalan diperlukan untuk melakukan validasi menggunakan tanda tangan openssl.
AdvertisedPublicPrefixPropertiesValidationState	Status Awalan Publik yang Diiklankan yang menunjukkan apakah awalan divalidasi atau tidak.
AuthorizationUseStatus	Status penggunaan otorisasi.
CircuitConnectionStatus	Status koneksi Sirkuit Rute Ekspres.
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
ExpressRouteCircuit	Sumber daya ExpressRouteCircuit.
ExpressRouteCircuitAuthorization	Otorisasi dalam sumber daya ExpressRouteCircuit.
ExpressRouteCircuitConnection	Koneksi Sirkuit Rute Ekspres dalam sumber daya ExpressRouteCircuitPeering.
ExpressRouteCircuitListResult	Respons operasi daftar ExpressRouteCircuit.
ExpressRouteCircuitPeering	Peering dalam sumber daya ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Status awalan publik yang diiklankan dari sumber daya Peering.
ExpressRouteCircuitPeeringConfig	Menentukan konfigurasi peering.
ExpressRouteCircuitPeeringState	Status peering.
ExpressRouteCircuitServiceProviderProperties	Berisi ServiceProviderProperties dalam ExpressRouteCircuit.
ExpressRouteCircuitSku	Berisi SKU dalam ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	Keluarga SKU.
ExpressRouteCircuitSkuTier	Tingkat SKU.
ExpressRouteCircuitStats	Berisi statistik yang terkait dengan peering.
ExpressRouteConnectionId	The ID of the ExpressRouteConnection.
ExpressRoutePeeringState	Status peering.
ExpressRoutePeeringType	Jenis peering.
Ipv6CircuitConnectionConfig	Properti Koneksi Sirkuit IPv6 untuk jangkauan global.
Ipv6ExpressRouteCircuitPeeringConfig	Berisi konfigurasi peering IPv6.
PeerExpressRouteCircuitConnection	Koneksi Sirkuit Rute Ekspres Peer dalam sumber daya ExpressRouteCircuitPeering.
ProvisioningState	Status provisi sumber daya.
ServiceProviderProvisioningState	Status ServiceProviderProvisioningState sumber daya.
SubResource	Referensi ke sub sumber daya lain.

AdvertisedPublicPrefixProperties

Objek

Properti awalan diperlukan untuk melakukan validasi menggunakan tanda tangan openssl.

Nama	Jenis	Deskripsi
prefix	string	Awalan publik yang diiklankan.
signature	string	String yang ditandatangani dihasilkan dengan mengenkripsi validationId dengan kunci privat.
validationId	string	String validasi yang berisi info peering sirkuit.
validationState	AdvertisedPublicPrefixPropertiesValidationState	Status Awalan Publik yang Diiklankan yang menunjukkan apakah awalan divalidasi atau tidak.

AdvertisedPublicPrefixPropertiesValidationState

Enumerasi

Status Awalan Publik yang Diiklankan yang menunjukkan apakah awalan divalidasi atau tidak.

Nilai	Deskripsi
NotConfigured	Tidak Dikonfigurasi
Configuring	Mengkonfigurasi
Configured	Dikonfigurasi
ValidationNeeded	ValidasiDibutuhkan
ValidationFailed	ValidationFailed
ManualValidationNeeded	Validasi ManualDibutuhkan
AsnValidationFailed	AsnValidationFailed
CertificateMissingInRoutingRegistry	CertificateMissingInRoutingRegistry
InvalidSignatureEncoding	InvalidSignatureEncoding
SignatureVerificationFailed	Verifikasi Tanda TanganGagal

AuthorizationUseStatus

Enumerasi

Status penggunaan otorisasi.

Nilai	Deskripsi
Available	Tersedia
InUse	Tidak Digunakan

CircuitConnectionStatus

Enumerasi

Status koneksi Sirkuit Rute Ekspres.

Nilai	Deskripsi
Connected	Tersambung
Connecting	Menyambungkan
Disconnected	Terputus

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Badan kesalahan cloud.

CloudErrorBody

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

ExpressRouteCircuit

Objek

Sumber daya ExpressRouteCircuit.

Nama	Jenis	Deskripsi
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
location	string	Lokasi sumber daya.
name	string	Nama sumber daya.
properties.allowClassicOperations	boolean	Izinkan operasi klasik.
properties.authorizationKey	string	AuthorizationKey.
properties.authorizationStatus	string	Status otorisasi Sirkuit.
properties.authorizations	ExpressRouteCircuitAuthorization[]	Daftar otorisasi.
properties.bandwidthInGbps	number (float)	Bandwidth sirkuit saat sirkuit disediakan pada sumber daya ExpressRoutePort.
properties.circuitProvisioningState	string	Status CircuitProvisioningState sumber daya.
properties.enableDirectPortRateLimit	boolean	Bendera yang menunjukkan status pembatasan tarif sirkuit port langsung ExpressRoute.
properties.expressRoutePort	SubResource	Referensi ke sumber daya ExpressRoutePort saat sirkuit disediakan pada sumber daya ExpressRoutePort.
properties.gatewayManagerEtag	string	Etag GatewayManager.
properties.globalReachEnabled	boolean	Bendera yang menunjukkan status jangkauan global.
properties.peerings	ExpressRouteCircuitPeering[]	Daftar peering.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya sirkuit rute ekspres.
properties.serviceKey	string	Kunci Layanan.
properties.serviceProviderNotes	string	Catatan Penyedia Layanan.
properties.serviceProviderProperties	ExpressRouteCircuitServiceProviderProperties	The ServiceProviderProperties.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	Status ServiceProviderProvisioningState sumber daya.
properties.stag	integer (int32)	Pengidentifikasi lalu lintas sirkuit. Tag luar untuk enkapsulasi QinQ.
sku	ExpressRouteCircuitSku	The SKU.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya.

ExpressRouteCircuitAuthorization

Objek

Otorisasi dalam sumber daya ExpressRouteCircuit.

Nama	Jenis	Deskripsi
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.authorizationKey	string	Kunci otorisasi.
properties.authorizationUseStatus	AuthorizationUseStatus	Status penggunaan otorisasi.
properties.connectionResourceUri	string	Referensi ke sumber daya koneksi ExpressRoute menggunakan otorisasi.
properties.provisioningState	ProvisioningState	Status provisi sumber daya otorisasi.
type	string	Jenis sumber daya.

ExpressRouteCircuitConnection

Objek

Koneksi Sirkuit Rute Ekspres dalam sumber daya ExpressRouteCircuitPeering.

Nama	Jenis	Deskripsi
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.addressPrefix	string	/29 ruang alamat IP untuk mengukir alamat Pelanggan untuk terowongan.
properties.authorizationKey	string	Kunci otorisasi.
properties.circuitConnectionStatus	CircuitConnectionStatus	Status koneksi Sirkuit Rute Ekspres.
properties.expressRouteCircuitPeering	SubResource	Referensi ke Express Route Circuit Private Peering Resource dari koneksi yang memulai sirkuit.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Prefiks Alamat IPv6Properti dari koneksi sirkuit rute ekspres.
properties.peerExpressRouteCircuitPeering	SubResource	Referensi ke Express Route Circuit Private Peering Resource dari sirkuit yang di-peering.
properties.provisioningState	ProvisioningState	Status provisi sumber daya koneksi sirkuit rute ekspres.
type	string	Jenis sumber daya.

ExpressRouteCircuitListResult

Objek

Respons operasi daftar ExpressRouteCircuit.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	ExpressRouteCircuit[]	Item ExpressRouteCircuit di halaman ini

ExpressRouteCircuitPeering

Objek

Peering dalam sumber daya ExpressRouteCircuit.

Nama	Jenis	Deskripsi
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.azureASN	integer (int32)	ASN Azure.
properties.connections	ExpressRouteCircuitConnection[]	Daftar koneksi sirkuit yang terkait dengan Azure Private Peering untuk sirkuit ini.
properties.expressRouteConnection	ExpressRouteConnectionId	Koneksi ExpressRoute.
properties.gatewayManagerEtag	string	Etag GatewayManager.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Konfigurasi peering IPv6.
properties.lastModifiedBy	string	Siapa yang terakhir memodifikasi peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Konfigurasi peering Microsoft.
properties.peerASN	integer (int64) minimum: 1 maximum: 4294967295	ASN serekan.
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	Daftar koneksi sirkuit peered yang terkait dengan Azure Private Peering untuk sirkuit ini.
properties.peeringType	ExpressRoutePeeringType	Jenis peering.
properties.primaryAzurePort	string	Port utama.
properties.primaryPeerAddressPrefix	string	Awalan alamat utama.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya peering sirkuit rute ekspres.
properties.routeFilter	SubResource	Referensi ke sumber daya RouteFilter.
properties.secondaryAzurePort	string	Port sekunder.
properties.secondaryPeerAddressPrefix	string	Awalan alamat sekunder.
properties.sharedKey	string	Kunci bersama.
properties.state	ExpressRoutePeeringState	Status peering.
properties.stats	ExpressRouteCircuitStats	Statistik peering sirkuit rute ekspres.
properties.vlanId	integer (int32)	ID VLAN.
type	string	Jenis sumber daya.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Enumerasi

Status awalan publik yang diiklankan dari sumber daya Peering.

Nilai	Deskripsi
NotConfigured	Tidak Dikonfigurasi
Configuring	Mengkonfigurasi
Configured	Dikonfigurasi
ValidationNeeded	ValidasiDibutuhkan

ExpressRouteCircuitPeeringConfig

Objek

Menentukan konfigurasi peering.

Nama	Jenis	Deskripsi
advertisedCommunities	string[]	Komunitas peering bgp. Ditentukan untuk peering microsoft.
advertisedPublicPrefixInfo	AdvertisedPublicPrefixProperties[]	Daftar informasi awalan yang diperlukan untuk melakukan validasi.
advertisedPublicPrefixes	string[]	Referensi ke AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Status awalan publik yang diiklankan dari sumber daya Peering.
customerASN	integer (int32)	CustomerASN dari peering.
legacyMode	integer (int32)	Mode warisan peering.
routingRegistryName	string	RoutingRegistryName konfigurasi.

ExpressRouteCircuitPeeringState

Enumerasi

Status peering.

Nilai	Deskripsi
Disabled	Nonaktif
Enabled	Enabled

ExpressRouteCircuitServiceProviderProperties

Objek

Berisi ServiceProviderProperties dalam ExpressRouteCircuit.

Nama	Jenis	Deskripsi
bandwidthInMbps	integer (int32)	The BandwidthInMbps.
peeringLocation	string	Lokasi peering.
serviceProviderName	string	ServiceProviderName.

ExpressRouteCircuitSku

Objek

Berisi SKU dalam ExpressRouteCircuit.

Nama	Jenis	Deskripsi
family	ExpressRouteCircuitSkuFamily	Keluarga SKU.
name	string	Nama SKU.
tier	ExpressRouteCircuitSkuTier	Tingkat SKU.

ExpressRouteCircuitSkuFamily

Enumerasi

Keluarga SKU.

Nilai	Deskripsi
UnlimitedData	Data Tidak Terbatas
MeteredData	Data Terukur

ExpressRouteCircuitSkuTier

Enumerasi

Tingkat SKU.

Nilai	Deskripsi
Standard	Standar
Premium	Premium
Basic	Dasar
Local	Lokal

ExpressRouteCircuitStats

Objek

Berisi statistik yang terkait dengan peering.

Nama	Jenis	Deskripsi
primarybytesIn	integer (int64)	Byte UtamaIn dari peering.
primarybytesOut	integer (int64)	ByteOut utama dari peering.
secondarybytesIn	integer (int64)	ByteIn sekunder dari peering.
secondarybytesOut	integer (int64)	BytesOut sekunder dari peering.

ExpressRouteConnectionId

Objek

The ID of the ExpressRouteConnection.

Nama	Jenis	Deskripsi
id	string	The ID of the ExpressRouteConnection.

ExpressRoutePeeringState

Enumerasi

Status peering.

Nilai	Deskripsi
Disabled	Nonaktif
Enabled	Enabled

ExpressRoutePeeringType

Enumerasi

Jenis peering.

Nilai	Deskripsi
AzurePublicPeering	AzurePublicPeering
AzurePrivatePeering	AzurePrivatePeering
MicrosoftPeering	MicrosoftPeering

Ipv6CircuitConnectionConfig

Objek

Properti Koneksi Sirkuit IPv6 untuk jangkauan global.

Nama	Jenis	Deskripsi
addressPrefix	string	/125 ruang alamat IP untuk mengukir alamat pelanggan untuk jangkauan global.
circuitConnectionStatus	CircuitConnectionStatus	Status koneksi Sirkuit Rute Ekspres.

Ipv6ExpressRouteCircuitPeeringConfig

Objek

Berisi konfigurasi peering IPv6.

Nama	Jenis	Deskripsi
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Konfigurasi peering Microsoft.
primaryPeerAddressPrefix	string	Awalan alamat utama.
routeFilter	SubResource	Referensi ke sumber daya RouteFilter.
secondaryPeerAddressPrefix	string	Awalan alamat sekunder.
state	ExpressRouteCircuitPeeringState	Status peering.

PeerExpressRouteCircuitConnection

Objek

Koneksi Sirkuit Rute Ekspres Peer dalam sumber daya ExpressRouteCircuitPeering.

Nama	Jenis	Deskripsi
etag	string	String baca-saja unik yang berubah setiap kali sumber daya diperbarui.
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.addressPrefix	string	/29 ruang alamat IP untuk mengukir alamat Pelanggan untuk terowongan.
properties.authResourceGuid	string	Panduan sumber daya otorisasi yang digunakan untuk koneksi sirkuit rute ekspres.
properties.circuitConnectionStatus	CircuitConnectionStatus	Status koneksi Sirkuit Rute Ekspres.
properties.connectionName	string	Nama sumber daya koneksi sirkuit rute ekspres.
properties.expressRouteCircuitPeering	SubResource	Referensi ke Sumber Daya Peering Pribadi Sirkuit Rute Ekspres sirkuit.
properties.peerExpressRouteCircuitPeering	SubResource	Referensi ke Express Route Circuit Private Peering Resource dari sirkuit yang di-peering.
properties.provisioningState	ProvisioningState	Status penyediaan sumber daya koneksi sirkuit rute ekspres rekan.
type	string	Jenis sumber daya.

ProvisioningState

Enumerasi

Status provisi sumber daya.

Nilai	Deskripsi
Failed	Kegagalan
Succeeded	Berhasil
Canceled	Dibatalkan
Creating	Membuat
Updating	Memperbarui
Deleting	Menghapus

ServiceProviderProvisioningState

Enumerasi

Status ServiceProviderProvisioningState sumber daya.

Nilai	Deskripsi
NotProvisioned	Tidak Disediakan
Provisioning	Provisioning
Provisioned	Disiapkan
Deprovisioning	Deprovisi

SubResource

Objek

Referensi ke sub sumber daya lain.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.

Bagikan melalui

Express Route Circuits - List

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

List ExpressRouteCircuits in a resource group

Permintaan sampel

Respon sampel

Definisi

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