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=2020-11-01

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

As credenciais de assinatura que identificam exclusivamente a Microsoft Azure assinatura. 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

Name Type Description
200 OK

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

Other Status Codes

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

Segurança

azure_auth

Azure Active Directory fluxo OAuth2.

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

Scopes

Name 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=2020-11-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

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 do ExpressRoute em um recurso ExpressRouteCircuitPeering.

ExpressRouteCircuitListResult

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

ExpressRouteCircuitPeering

Peering em um recurso ExpressRouteCircuit.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

ExpressRouteCircuitPeeringConfig

Especifica a configuração de peering.

ExpressRouteCircuitPeeringState

O estado do peering.

ExpressRouteCircuitServiceProviderProperties

Contém ServiceProviderProperties em um ExpressRouteCircuit.

ExpressRouteCircuitSku

Contém sKU em um ExpressRouteCircuit.

ExpressRouteCircuitSkuFamily

A família da SKU.

ExpressRouteCircuitSkuTier

A camada da SKU.

ExpressRouteCircuitStats

Contém estatísticas associadas ao peering.

ExpressRouteConnectionId

A ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do peering.

ExpressRoutePeeringType

O tipo de peering.

Ipv6CircuitConnectionConfig

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

Ipv6ExpressRouteCircuitPeeringConfig

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

PeerExpressRouteCircuitConnection

Conexão de circuito do ExpressRoute par em um recurso ExpressRouteCircuitPeering.

ProvisioningState

O estado de provisionamento atual.

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

SubResource

Referência a outra sub-fonte.

AuthorizationUseStatus

O status de uso da autorização.

Name Type Description
Available
  • string
InUse
  • string

CircuitConnectionStatus

Estado de conexão do Circuito de Rota Expressa.

Name Type Description
Connected
  • string
Connecting
  • string
Disconnected
  • string

CloudError

Uma resposta de erro do serviço.

Name Type Description
error

Corpo do erro de nuvem.

CloudErrorBody

Uma resposta de erro do serviço.

Name Type Description
code
  • string

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

details

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.

Name Type Description
etag
  • string

Uma cadeia de caracteres exclusiva somente leitura que muda 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.authorizations

A lista de autorizações.

properties.bandwidthInGbps
  • number

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

properties.circuitProvisioningState
  • string

O estado CircuitProvisioningState do recurso.

properties.expressRoutePort

A referência ao recurso ExpressRoutePort quando o circuito é provisionado em um recurso do ExpressRoutePort.

properties.gatewayManagerEtag
  • string

O GatewayManager Etag.

properties.globalReachEnabled
  • boolean

Sinalizador que denota o status de alcance global.

properties.peerings

A lista de pares.

properties.provisioningState

O estado de provisionamento do recurso de circuito de rota expressa.

properties.serviceKey
  • string

A ServiceKey.

properties.serviceProviderNotes
  • string

O ServiceProviderNotes.

properties.serviceProviderProperties

O ServiceProviderProperties.

properties.serviceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

properties.stag
  • integer

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

sku

A SKU.

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.

ExpressRouteCircuitAuthorization

Autorização em um recurso ExpressRouteCircuit.

Name Type Description
etag
  • string

Uma cadeia de caracteres exclusiva somente leitura que muda 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

O status de uso da autorização.

properties.provisioningState

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

type
  • string

Tipo do recurso.

ExpressRouteCircuitConnection

Conexão de Circuito do ExpressRoute em um recurso ExpressRouteCircuitPeering.

Name Type Description
etag
  • string

Uma cadeia de caracteres exclusiva somente leitura que muda 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 de endereço IP para dividir os endereços do cliente para túneis.

properties.authorizationKey
  • string

A chave de autorização.

properties.circuitConnectionStatus

Estado de conexão do Circuito de Rota Expressa.

properties.expressRouteCircuitPeering

Referência ao Recurso de Peering Privado do Circuito de Rota Expressa da conexão de início do circuito.

properties.ipv6CircuitConnectionConfig

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

properties.peerExpressRouteCircuitPeering

Referência ao Recurso de Peering Privado do Circuito de Rota Expressa do circuito ponto a ponto.

properties.provisioningState

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

type
  • string

Tipo do recurso.

ExpressRouteCircuitListResult

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

Name Type Description
nextLink
  • string

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

value

Uma lista de ExpressRouteCircuits em um grupo de recursos.

ExpressRouteCircuitPeering

Peering em um recurso ExpressRouteCircuit.

Name Type Description
etag
  • string

Uma cadeia de caracteres exclusiva somente leitura que muda 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

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

properties.expressRouteConnection

A conexão do ExpressRoute.

properties.gatewayManagerEtag
  • string

O GatewayManager Etag.

properties.ipv6PeeringConfig

A configuração de peering IPv6.

properties.lastModifiedBy
  • string

Quem foi o último a modificar o peering.

properties.microsoftPeeringConfig

A configuração de peering da Microsoft.

properties.peerASN
  • integer

O ASN par.

properties.peeredConnections

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

properties.peeringType

O tipo de peering.

properties.primaryAzurePort
  • string

A porta primária.

properties.primaryPeerAddressPrefix
  • string

O prefixo de endereço primário.

properties.provisioningState

O estado de provisionamento do recurso de peering de circuito de rota expressa.

properties.routeFilter

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

O estado de peering.

properties.stats

As estatísticas de peering 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 de Peering.

Name Type Description
Configured
  • string
Configuring
  • string
NotConfigured
  • string
ValidationNeeded
  • string

ExpressRouteCircuitPeeringConfig

Especifica a configuração de peering.

Name Type Description
advertisedCommunities
  • string[]

As comunidades do paring bgp. Especificado para o peering da Microsoft.

advertisedPublicPrefixes
  • string[]

A referência a AdvertisedPublicPrefixes.

advertisedPublicPrefixesState

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

customerASN
  • integer

O CustomerASN do peering.

legacyMode
  • integer

O modo herddo do peering.

routingRegistryName
  • string

O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

O estado do peering.

Name Type Description
Disabled
  • string
Enabled
  • string

ExpressRouteCircuitServiceProviderProperties

Contém ServiceProviderProperties em um ExpressRouteCircuit.

Name Type Description
bandwidthInMbps
  • integer

O BandwidthInMbps.

peeringLocation
  • string

O local de peering.

serviceProviderName
  • string

O serviceProviderName.

ExpressRouteCircuitSku

Contém sKU em um ExpressRouteCircuit.

Name Type Description
family

A família da SKU.

name
  • string

O nome da SKU.

tier

A camada da SKU.

ExpressRouteCircuitSkuFamily

A família da SKU.

Name Type Description
MeteredData
  • string
UnlimitedData
  • string

ExpressRouteCircuitSkuTier

A camada da SKU.

Name Type Description
Basic
  • string
Local
  • string
Premium
  • string
Standard
  • string

ExpressRouteCircuitStats

Contém estatísticas associadas ao peering.

Name Type Description
primarybytesIn
  • integer

O BytesIn primário do peering.

primarybytesOut
  • integer

O BytesOut primário do peering.

secondarybytesIn
  • integer

O BytesIn secundário do peering.

secondarybytesOut
  • integer

O BytesOut secundário do peering.

ExpressRouteConnectionId

A ID do ExpressRouteConnection.

Name Type Description
id
  • string

A ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do peering.

Name Type Description
Disabled
  • string
Enabled
  • string

ExpressRoutePeeringType

O tipo de peering.

Name Type Description
AzurePrivatePeering
  • string
AzurePublicPeering
  • string
MicrosoftPeering
  • string

Ipv6CircuitConnectionConfig

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

Name Type Description
addressPrefix
  • string

/125 de endereço IP para dividir os endereços do cliente para alcance global.

circuitConnectionStatus

Estado de conexão do Circuito de Rota Expressa.

Ipv6ExpressRouteCircuitPeeringConfig

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

Name Type Description
microsoftPeeringConfig

A configuração de peering da Microsoft.

primaryPeerAddressPrefix
  • string

O prefixo de endereço primário.

routeFilter

A referência ao recurso RouteFilter.

secondaryPeerAddressPrefix
  • string

O prefixo de endereço secundário.

state

O estado do peering.

PeerExpressRouteCircuitConnection

Conexão de circuito do ExpressRoute par em um recurso ExpressRouteCircuitPeering.

Name Type Description
etag
  • string

Uma cadeia de caracteres exclusiva somente leitura que muda 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 de endereço IP para dividir os endereços do cliente 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

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

Referência ao Recurso de Peering Privado do Circuito de Rota Expressa do circuito.

properties.peerExpressRouteCircuitPeering

Referência ao Recurso de Peering Privado do Circuito de Rota Expressa do circuito ponto a ponto.

properties.provisioningState

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

type
  • string

Tipo do recurso.

ProvisioningState

O estado de provisionamento atual.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ServiceProviderProvisioningState

O estado ServiceProviderProvisioningState do recurso.

Name Type Description
Deprovisioning
  • string
NotProvisioned
  • string
Provisioned
  • string
Provisioning
  • string

SubResource

Referência a outra sub-fonte.

Name Type Description
id
  • string

ID do recurso.