Express Route Circuits - List

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=2023-09-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

As credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão de API do cliente.

Respostas

Nome Tipo Description
200 OK

ExpressRouteCircuitListResult

Solicitação bem-sucedida. A operação retorna o recurso de ExpressRouteCircuitAuthorization resultante.

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

Nome Description
AuthorizationUseStatus

A autorização usa status.

CircuitConnectionStatus

Estado de conexão do Circuito do Express Route.

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

Resposta para a chamada de serviço da API ListExpressRouteCircuit.

ExpressRouteCircuitPeering

Emparelhamento em um recurso ExpressRouteCircuit.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

ExpressRouteCircuitPeeringConfig

Especifica a configuração de emparelhamento.

ExpressRouteCircuitPeeringState

O estado do emparelhamento.

ExpressRouteCircuitServiceProviderProperties

Contém ServiceProviderProperties em um ExpressRouteCircuit.

ExpressRouteCircuitSku

Contém o SKU em um ExpressRouteCircuit.

ExpressRouteCircuitSkuFamily

A família da SKU.

ExpressRouteCircuitSkuTier

A camada do SKU.

ExpressRouteCircuitStats

Contém estatísticas associadas ao emparelhamento.

ExpressRouteConnectionId

A ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do emparelhamento.

ExpressRoutePeeringType

O tipo de emparelhamento.

Ipv6CircuitConnectionConfig

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

Ipv6ExpressRouteCircuitPeeringConfig

Contém a configuração de emparelhamento IPv6.

PeerExpressRouteCircuitConnection

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

ProvisioningState

O estado de provisionamento atual.

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

SubResource

Referência a outro sub-recurso.

AuthorizationUseStatus

A autorização usa status.

Nome Tipo Description
Available

string

InUse

string

CircuitConnectionStatus

Estado de conexão do Circuito do Express Route.

Nome Tipo Description
Connected

string

Connecting

string

Disconnected

string

CloudError

Uma resposta de erro do serviço.

Nome Tipo Description
error

CloudErrorBody

Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteCircuit

Recurso ExpressRouteCircuit.

Nome Tipo Description
etag

string

Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

location

string

Local do recurso.

name

string

Nome do recurso.

properties.allowClassicOperations

boolean

Permitir 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

A largura de banda do circuito quando o circuito é provisionado em um recurso expressRoutePort.

properties.circuitProvisioningState

string

O estado CircuitProvisioningState do recurso.

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 status de alcance global.

properties.peerings

ExpressRouteCircuitPeering[]

A lista de emparelhamentos.

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

O identificador do tráfego do circuito. Marca externa para encapsulamento QinQ.

sku

ExpressRouteCircuitSku

A SKU.

tags

object

Marcas de recurso.

type

string

Tipo de recurso.

ExpressRouteCircuitAuthorization

Autorização em um recurso ExpressRouteCircuit.

Nome Tipo Description
etag

string

Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.authorizationKey

string

A chave de autorização.

properties.authorizationUseStatus

AuthorizationUseStatus

A autorização usa status.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de autorização.

type

string

Tipo do recurso.

ExpressRouteCircuitConnection

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

Nome Tipo Description
etag

string

Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.addressPrefix

string

/29 espaço de endereço IP para esculpir endereços de cliente para túneis.

properties.authorizationKey

string

A chave de autorização.

properties.circuitConnectionStatus

CircuitConnectionStatus

Estado de conexão do Circuito do Express Route.

properties.expressRouteCircuitPeering

SubResource

Referência ao Recurso de Emparelhamento Privado do Circuito do ExpressRoute do circuito que inicia a conexão.

properties.ipv6CircuitConnectionConfig

Ipv6CircuitConnectionConfig

Prefixo de endereço IPv6Propriedades da conexão de circuito de rota expressa.

properties.peerExpressRouteCircuitPeering

SubResource

Referência ao Recurso de Emparelhamento Privado do Circuito do ExpressRoute do circuito emparelhado.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de conexão do circuito de rota expressa.

type

string

Tipo do recurso.

ExpressRouteCircuitListResult

Resposta para a chamada de serviço da API ListExpressRouteCircuit.

Nome Tipo Description
nextLink

string

A URL para obter o próximo conjunto de resultados.

value

ExpressRouteCircuit[]

Uma lista de ExpressRouteCircuits em um grupo de recursos.

ExpressRouteCircuitPeering

Emparelhamento em um recurso ExpressRouteCircuit.

Nome Tipo Description
etag

string

Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.azureASN

integer

O ASN do Azure.

properties.connections

ExpressRouteCircuitConnection[]

A lista de conexões de circuito associadas ao Emparelhamento Privado do Azure para esse circuito.

properties.expressRouteConnection

ExpressRouteConnectionId

A conexão do 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 emparelhamento.

properties.microsoftPeeringConfig

ExpressRouteCircuitPeeringConfig

A configuração de emparelhamento da Microsoft.

properties.peerASN

integer

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 primária.

properties.primaryPeerAddressPrefix

string

O prefixo de endereço primário.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de emparelhamento do 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

A ID da VLAN.

type

string

Tipo do recurso.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

Nome Tipo Description
Configured

string

Configuring

string

NotConfigured

string

ValidationNeeded

string

ExpressRouteCircuitPeeringConfig

Especifica a configuração de emparelhamento.

Nome Tipo Description
advertisedCommunities

string[]

As comunidades de emparelhamento bgp. Especificado para emparelhamento da Microsoft.

advertisedPublicPrefixes

string[]

A referência a AdvertisedPublicPrefixes.

advertisedPublicPrefixesState

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

customerASN

integer

O CustomerASN do emparelhamento.

legacyMode

integer

O modo herdado do emparelhamento.

routingRegistryName

string

O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

O estado do emparelhamento.

Nome Tipo Description
Disabled

string

Enabled

string

ExpressRouteCircuitServiceProviderProperties

Contém ServiceProviderProperties em um ExpressRouteCircuit.

Nome Tipo Description
bandwidthInMbps

integer

O BandwidthInMbps.

peeringLocation

string

O local de emparelhamento.

serviceProviderName

string

O serviceProviderName.

ExpressRouteCircuitSku

Contém o SKU em um ExpressRouteCircuit.

Nome Tipo Description
family

ExpressRouteCircuitSkuFamily

A família da SKU.

name

string

O nome da SKU.

tier

ExpressRouteCircuitSkuTier

A camada do SKU.

ExpressRouteCircuitSkuFamily

A família da SKU.

Nome Tipo Description
MeteredData

string

UnlimitedData

string

ExpressRouteCircuitSkuTier

A camada do SKU.

Nome Tipo Description
Basic

string

Local

string

Premium

string

Standard

string

ExpressRouteCircuitStats

Contém estatísticas associadas ao emparelhamento.

Nome Tipo Description
primarybytesIn

integer

O BytesIn Primário do emparelhamento.

primarybytesOut

integer

O BytesOut primário do emparelhamento.

secondarybytesIn

integer

O BytesIn secundário do emparelhamento.

secondarybytesOut

integer

O BytesOut secundário do emparelhamento.

ExpressRouteConnectionId

A ID do ExpressRouteConnection.

Nome Tipo Description
id

string

A ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do emparelhamento.

Nome Tipo Description
Disabled

string

Enabled

string

ExpressRoutePeeringType

O tipo de emparelhamento.

Nome Tipo Description
AzurePrivatePeering

string

AzurePublicPeering

string

MicrosoftPeering

string

Ipv6CircuitConnectionConfig

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

Nome Tipo Description
addressPrefix

string

/125 espaço de endereço IP para esculpir endereços de clientes para alcance global.

circuitConnectionStatus

CircuitConnectionStatus

Estado de conexão do Circuito do Express Route.

Ipv6ExpressRouteCircuitPeeringConfig

Contém a configuração de emparelhamento IPv6.

Nome Tipo Description
microsoftPeeringConfig

ExpressRouteCircuitPeeringConfig

A configuração de emparelhamento da Microsoft.

primaryPeerAddressPrefix

string

O prefixo de endereço primário.

routeFilter

SubResource

A referência ao recurso RouteFilter.

secondaryPeerAddressPrefix

string

O prefixo de endereço secundário.

state

ExpressRouteCircuitPeeringState

O estado do emparelhamento.

PeerExpressRouteCircuitConnection

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

Nome Tipo Description
etag

string

Uma cadeia de caracteres exclusiva somente leitura que é alterada sempre que o recurso é atualizado.

id

string

ID do recurso.

name

string

O nome do recurso que é exclusivo em um grupo de recursos. Esse nome pode ser usado para acessar o recurso.

properties.addressPrefix

string

/29 espaço de endereço IP para esculpir endereços de cliente para túneis.

properties.authResourceGuid

string

O guid de recurso da autorização usada para a conexão do circuito de rota expressa.

properties.circuitConnectionStatus

CircuitConnectionStatus

Estado de conexão do Circuito do Express Route.

properties.connectionName

string

O nome do recurso de conexão do circuito de rota expressa.

properties.expressRouteCircuitPeering

SubResource

Referência ao Recurso de Emparelhamento Privado do Circuito do Express Route do circuito.

properties.peerExpressRouteCircuitPeering

SubResource

Referência ao Recurso de Emparelhamento Privado do Circuito do ExpressRoute do circuito emparelhado.

properties.provisioningState

ProvisioningState

O estado de provisionamento do recurso de conexão do circuito de rota expressa par.

type

string

Tipo do recurso.

ProvisioningState

O estado de provisionamento atual.

Nome Tipo Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

Nome Tipo Description
Deprovisioning

string

NotProvisioned

string

Provisioned

string

Provisioning

string

SubResource

Referência a outro sub-recurso.

Nome Tipo Description
id

string

ID do recurso.