Share via


Express Route Circuits - List

Obtient tous les circuits expressroute dans un groupe de ressources.

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

Paramètres URI

Nom Dans Obligatoire Type Description
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

ExpressRouteCircuitListResult

Demande réussie. L’opération retourne la ressource ExpressRouteCircuitAuthorization résultante.

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

List ExpressRouteCircuits in a resource group

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits?api-version=2023-09-01

Sample Response

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

Définitions

Nom Description
AuthorizationUseStatus

L’utilisation de l’autorisation status.

CircuitConnectionStatus

État de connexion du circuit Express Route.

CloudError

Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

ExpressRouteCircuit

Ressource ExpressRouteCircuit.

ExpressRouteCircuitAuthorization

Autorisation dans une ressource ExpressRouteCircuit.

ExpressRouteCircuitConnection

Connexion de circuit Express Route dans une ressource ExpressRouteCircuitPeering.

ExpressRouteCircuitListResult

Réponse à l’appel de service d’API ListExpressRouteCircuit.

ExpressRouteCircuitPeering

Peering dans une ressource ExpressRouteCircuit.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

ExpressRouteCircuitPeeringConfig

Spécifie la configuration de peering.

ExpressRouteCircuitPeeringState

État du peering.

ExpressRouteCircuitServiceProviderProperties

Contient ServiceProviderProperties dans un Circuit ExpressRoute.

ExpressRouteCircuitSku

Contient une référence SKU dans un circuit ExpressRoute.

ExpressRouteCircuitSkuFamily

Famille de la référence SKU.

ExpressRouteCircuitSkuTier

Niveau de la référence SKU.

ExpressRouteCircuitStats

Contient les 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 la portée globale.

Ipv6ExpressRouteCircuitPeeringConfig

Contient la configuration de peering IPv6.

PeerExpressRouteCircuitConnection

Peer Express Route Circuit Connection dans une ressource ExpressRouteCircuitPeering.

ProvisioningState

État d’approvisionnement actuel.

ServiceProviderProvisioningState

État ServiceProviderProvisioningState de la ressource.

SubResource

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

AuthorizationUseStatus

L’utilisation de l’autorisation status.

Nom Type Description
Available

string

InUse

string

CircuitConnectionStatus

État de connexion du circuit Express Route.

Nom Type Description
Connected

string

Connecting

string

Disconnected

string

CloudError

Réponse d’erreur du service.

Nom Type Description
error

CloudErrorBody

Corps de l’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 des détails supplémentaires sur l’erreur.

message

string

Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

ExpressRouteCircuit

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 la ressource

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties.allowClassicOperations

boolean

Autoriser les opérations classiques.

properties.authorizationKey

string

AuthorizationKey.

properties.authorizationStatus

string

Autorisation status du circuit.

properties.authorizations

ExpressRouteCircuitAuthorization[]

Liste des autorisations.

properties.bandwidthInGbps

number

Bande passante du circuit lorsque le circuit est approvisionné sur une ressource ExpressRoutePort.

properties.circuitProvisioningState

string

État CircuitProvisioningState de la ressource.

properties.expressRoutePort

SubResource

Référence à la ressource ExpressRoutePort lorsque le circuit est provisionné sur une ressource ExpressRoutePort.

properties.gatewayManagerEtag

string

Etag GatewayManager.

properties.globalReachEnabled

boolean

Indicateur indiquant la portée globale status.

properties.peerings

ExpressRouteCircuitPeering[]

Liste des peerings.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de circuit express route.

properties.serviceKey

string

The ServiceKey.

properties.serviceProviderNotes

string

The ServiceProviderNotes.

properties.serviceProviderProperties

ExpressRouteCircuitServiceProviderProperties

The ServiceProviderProperties.

properties.serviceProviderProvisioningState

ServiceProviderProvisioningState

État ServiceProviderProvisioningState de la ressource.

properties.stag

integer

Identificateur du trafic du circuit. Balise externe pour l’encapsulation QinQ.

sku

ExpressRouteCircuitSku

Référence SKU.

tags

object

Balises de ressource.

type

string

Type de ressource.

ExpressRouteCircuitAuthorization

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 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.authorizationKey

string

Clé d’autorisation.

properties.authorizationUseStatus

AuthorizationUseStatus

L’utilisation de l’autorisation status.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource d’autorisation.

type

string

Type de la ressource.

ExpressRouteCircuitConnection

Connexion de circuit Express Route 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 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.addressPrefix

string

/29 espace d’adressage IP pour découper les adresses des clients pour les tunnels.

properties.authorizationKey

string

Clé d’autorisation.

properties.circuitConnectionStatus

CircuitConnectionStatus

État de connexion du circuit Express Route.

properties.expressRouteCircuitPeering

SubResource

Référence à la ressource de peering privé express Route Circuit du circuit initialisant la connexion.

properties.ipv6CircuitConnectionConfig

Ipv6CircuitConnectionConfig

IPv6 Address PrefixProperties de la connexion du circuit express route.

properties.peerExpressRouteCircuitPeering

SubResource

Référence à la ressource de peering privé express Route Circuit du circuit appairé.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de connexion de circuit express route.

type

string

Type de la ressource.

ExpressRouteCircuitListResult

Réponse à l’appel de service d’API ListExpressRouteCircuit.

Nom Type Description
nextLink

string

URL permettant d’obtenir l’ensemble de résultats suivant.

value

ExpressRouteCircuit[]

Liste d’ExpressRouteCircuits dans un groupe de ressources.

ExpressRouteCircuitPeering

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 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.connections

ExpressRouteCircuitConnection[]

Liste des connexions de circuit associées à Azure Private Peering pour ce circuit.

properties.expressRouteConnection

ExpressRouteConnectionId

Connexion ExpressRoute.

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 homologue.

properties.peeredConnections

PeerExpressRouteCircuitConnection[]

Liste des connexions de circuit appairées associées à Azure Private Peering pour ce circuit.

properties.peeringType

ExpressRoutePeeringType

Type de peering.

properties.primaryAzurePort

string

Port principal.

properties.primaryPeerAddressPrefix

string

Préfixe d’adresse principale.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de peering de circuit express route.

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

ID de réseau local virtuel.

type

string

Type de la ressource.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

État du préfixe public annoncé 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 de peering bgp. Spécifié pour le peering Microsoft.

advertisedPublicPrefixes

string[]

Référence à AdvertisedPublicPrefixes.

advertisedPublicPrefixesState

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

customerASN

integer

CustomerASN du peering.

legacyMode

integer

Mode hérité du peering.

routingRegistryName

string

RoutingRegistryName de la configuration.

ExpressRouteCircuitPeeringState

État du peering.

Nom Type Description
Disabled

string

Enabled

string

ExpressRouteCircuitServiceProviderProperties

Contient ServiceProviderProperties dans un Circuit ExpressRoute.

Nom Type Description
bandwidthInMbps

integer

The BandwidthInMbps.

peeringLocation

string

Emplacement de peering.

serviceProviderName

string

ServiceProviderName.

ExpressRouteCircuitSku

Contient une référence SKU dans un circuit ExpressRoute.

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

Famille de la référence SKU.

Nom Type Description
MeteredData

string

UnlimitedData

string

ExpressRouteCircuitSkuTier

Niveau de la référence SKU.

Nom Type Description
Basic

string

Local

string

Premium

string

Standard

string

ExpressRouteCircuitStats

Contient les statistiques associées au peering.

Nom Type Description
primarybytesIn

integer

BytesIn principal du peering.

primarybytesOut

integer

BytesOut principal du peering.

secondarybytesIn

integer

BytesIn secondaire du peering.

secondarybytesOut

integer

BytesOut secondaire du peering.

ExpressRouteConnectionId

ID d’ExpressRouteConnection.

Nom Type Description
id

string

ID d’ExpressRouteConnection.

ExpressRoutePeeringState

État du peering.

Nom Type Description
Disabled

string

Enabled

string

ExpressRoutePeeringType

Type de peering.

Nom Type Description
AzurePrivatePeering

string

AzurePublicPeering

string

MicrosoftPeering

string

Ipv6CircuitConnectionConfig

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

Nom Type Description
addressPrefix

string

/125 espace d’adressage IP pour découper les adresses des clients pour une portée globale.

circuitConnectionStatus

CircuitConnectionStatus

État de connexion du circuit Express Route.

Ipv6ExpressRouteCircuitPeeringConfig

Contient la configuration de peering IPv6.

Nom Type Description
microsoftPeeringConfig

ExpressRouteCircuitPeeringConfig

Configuration du peering Microsoft.

primaryPeerAddressPrefix

string

Préfixe d’adresse principale.

routeFilter

SubResource

Référence à la ressource RouteFilter.

secondaryPeerAddressPrefix

string

Préfixe d’adresse secondaire.

state

ExpressRouteCircuitPeeringState

État du peering.

PeerExpressRouteCircuitConnection

Peer Express Route Circuit Connection 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 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.addressPrefix

string

/29 espace d’adressage IP pour découper les adresses des clients pour les tunnels.

properties.authResourceGuid

string

GUID de ressource de l’autorisation utilisée pour la connexion du circuit express route.

properties.circuitConnectionStatus

CircuitConnectionStatus

État de connexion du circuit Express Route.

properties.connectionName

string

Nom de la ressource de connexion du circuit expressroute.

properties.expressRouteCircuitPeering

SubResource

Référence à la ressource de peering privé du circuit Express Route.

properties.peerExpressRouteCircuitPeering

SubResource

Référence à la ressource de peering privé express Route Circuit du circuit appairé.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de connexion de circuit express route homologue.

type

string

Type de la ressource.

ProvisioningState

État d’approvisionnement actuel.

Nom Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

ServiceProviderProvisioningState

État ServiceProviderProvisioningState de la ressource.

Nom Type Description
Deprovisioning

string

NotProvisioned

string

Provisioned

string

Provisioning

string

SubResource

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

Nom Type Description
id

string

ID de la ressource