Express Route Circuits - List
Obtém todos os circuitos de rota expresso num grupo de recursos.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits?api-version=2023-09-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. |
subscription
|
path | True |
string |
As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço. |
api-version
|
query | True |
string |
Versão da API de Cliente. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Pedido com êxito. A operação devolve o recurso expressRouteCircuitAuthorization resultante. |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual 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
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
List ExpressRouteCircuits in a resource group
Sample Request
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
Name | Description |
---|---|
Authorization |
O estado de utilização da autorização. |
Circuit |
Estado da ligação do Circuito do Express Route. |
Cloud |
Uma resposta de erro do serviço. |
Cloud |
Uma resposta de erro do serviço. |
Express |
Recurso ExpressRouteCircuit. |
Express |
Autorização num recurso ExpressRouteCircuit. |
Express |
Ligação do Circuito do Express Route num recurso ExpressRouteCircuitPeering. |
Express |
Resposta para a chamada do serviço API ListExpressRouteCircuit. |
Express |
Peering num recurso ExpressRouteCircuit. |
Express |
O estado de prefixo público anunciado do recurso peering. |
Express |
Especifica a configuração do peering. |
Express |
O estado do peering. |
Express |
Contém ServiceProviderProperties num ExpressRouteCircuit. |
Express |
Contém SKU num ExpressRouteCircuit. |
Express |
A família do SKU. |
Express |
O escalão do SKU. |
Express |
Contém estatísticas associadas ao peering. |
Express |
O ID do ExpressRouteConnection. |
Express |
O estado do peering. |
Express |
O tipo de peering. |
Ipv6Circuit |
Propriedades de Ligação do Circuito IPv6 para alcance global. |
Ipv6Express |
Contém a configuração de peering IPv6. |
Peer |
Peer Express Route Circuit Connection num recurso ExpressRouteCircuitPeering. |
Provisioning |
O estado de aprovisionamento atual. |
Service |
O estado ServiceProviderProvisioningState do recurso. |
Sub |
Referência a outra sub-origem. |
AuthorizationUseStatus
O estado de utilização da autorização.
Name | Tipo | Description |
---|---|---|
Available |
string |
|
InUse |
string |
CircuitConnectionStatus
Estado da ligação do Circuito do Express Route.
Name | Tipo | Description |
---|---|---|
Connected |
string |
|
Connecting |
string |
|
Disconnected |
string |
CloudError
Uma resposta de erro do serviço.
Name | Tipo | Description |
---|---|---|
error |
Corpo do erro da cloud. |
CloudErrorBody
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 |
Uma lista de detalhes adicionais sobre o erro. |
|
message |
string |
Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador. |
target |
string |
O destino do erro específico. Por exemplo, o nome da propriedade em erro. |
ExpressRouteCircuit
Recurso ExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado. |
id |
string |
ID do Recurso. |
location |
string |
Localização do recurso. |
name |
string |
Nome do recurso. |
properties.allowClassicOperations |
boolean |
Permitir operações clássicas. |
properties.authorizationKey |
string |
A authorizationKey. |
properties.authorizationStatus |
string |
O estado de autorização do Circuito. |
properties.authorizations |
A lista de autorizações. |
|
properties.bandwidthInGbps |
number |
A largura de banda do circuito quando o circuito é aprovisionado num recurso expressRoutePort. |
properties.circuitProvisioningState |
string |
O estado CircuitProvisioningState do recurso. |
properties.expressRoutePort |
A referência ao recurso ExpressRoutePort quando o circuito é aprovisionado num recurso expressRoutePort. |
|
properties.gatewayManagerEtag |
string |
O GatewayManager Etag. |
properties.globalReachEnabled |
boolean |
Sinalizador que indica o estado de alcance global. |
properties.peerings |
A lista de peerings. |
|
properties.provisioningState |
O estado de aprovisionamento do recurso do circuito de rota rápida. |
|
properties.serviceKey |
string |
A Chave de Serviço. |
properties.serviceProviderNotes |
string |
O ServiceProviderNotes. |
properties.serviceProviderProperties |
The ServiceProviderProperties. |
|
properties.serviceProviderProvisioningState |
O estado ServiceProviderProvisioningState do recurso. |
|
properties.stag |
integer |
O identificador do tráfego do circuito. Etiqueta externa para encapsulamento QinQ. |
sku |
O SKU. |
|
tags |
object |
Etiquetas de recursos. |
type |
string |
Tipo de recurso. |
ExpressRouteCircuitAuthorization
Autorização num recurso ExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado. |
id |
string |
ID do Recurso. |
name |
string |
O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. |
properties.authorizationKey |
string |
A chave de autorização. |
properties.authorizationUseStatus |
O estado de utilização da autorização. |
|
properties.provisioningState |
O estado de aprovisionamento do recurso de autorização. |
|
type |
string |
Tipo de recurso. |
ExpressRouteCircuitConnection
Ligação do Circuito do Express Route num recurso ExpressRouteCircuitPeering.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado. |
id |
string |
ID do Recurso. |
name |
string |
O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. |
properties.addressPrefix |
string |
/29 espaço de endereços IP para esculpir endereços de cliente para túneis. |
properties.authorizationKey |
string |
A chave de autorização. |
properties.circuitConnectionStatus |
Estado da ligação do Circuito do Express Route. |
|
properties.expressRouteCircuitPeering |
Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito que inicia a ligação. |
|
properties.ipv6CircuitConnectionConfig |
Prefixo de Endereço IPv6Propriedades da ligação do circuito de rota rápida. |
|
properties.peerExpressRouteCircuitPeering |
Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito em modo de peering. |
|
properties.provisioningState |
O estado de aprovisionamento do recurso de ligação do circuito de rota rápida. |
|
type |
string |
Tipo de recurso. |
ExpressRouteCircuitListResult
Resposta para a chamada do serviço API ListExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
nextLink |
string |
O URL para obter o próximo conjunto de resultados. |
value |
Uma lista de ExpressRouteCircuits num grupo de recursos. |
ExpressRouteCircuitPeering
Peering num recurso ExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado. |
id |
string |
ID do Recurso. |
name |
string |
O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. |
properties.azureASN |
integer |
O ASN do Azure. |
properties.connections |
A lista de ligações de circuito associadas ao Peering Privado do Azure para este circuito. |
|
properties.expressRouteConnection |
A ligaçã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 do peering da Microsoft. |
|
properties.peerASN |
integer |
O ASN do elemento da rede. |
properties.peeredConnections |
A lista de ligações de circuitos em modo de peering associadas ao Peering Privado do Azure para este circuito. |
|
properties.peeringType |
O tipo de peering. |
|
properties.primaryAzurePort |
string |
A porta primária. |
properties.primaryPeerAddressPrefix |
string |
O prefixo de endereço principal. |
properties.provisioningState |
O estado de aprovisionamento do recurso de peering do circuito de rota rápida. |
|
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 partilhada. |
properties.state |
O estado do peering. |
|
properties.stats |
As estatísticas de peering do circuito express route. |
|
properties.vlanId |
integer |
O ID da VLAN. |
type |
string |
Tipo de recurso. |
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState
O estado de prefixo público anunciado do recurso peering.
Name | Tipo | Description |
---|---|---|
Configured |
string |
|
Configuring |
string |
|
NotConfigured |
string |
|
ValidationNeeded |
string |
ExpressRouteCircuitPeeringConfig
Especifica a configuração do peering.
Name | Tipo | Description |
---|---|---|
advertisedCommunities |
string[] |
As comunidades do peering bgp. Especificado para peering da Microsoft. |
advertisedPublicPrefixes |
string[] |
A referência a AdvertisedPublicPrefixes. |
advertisedPublicPrefixesState |
O estado de prefixo público anunciado do recurso peering. |
|
customerASN |
integer |
O CustomerASN do peering. |
legacyMode |
integer |
O modo legado do peering. |
routingRegistryName |
string |
O RoutingRegistryName da configuração. |
ExpressRouteCircuitPeeringState
O estado do peering.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ExpressRouteCircuitServiceProviderProperties
Contém ServiceProviderProperties num ExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
bandwidthInMbps |
integer |
A Largura de BandaInMbps. |
peeringLocation |
string |
A localização do peering. |
serviceProviderName |
string |
O serviceProviderName. |
ExpressRouteCircuitSku
Contém SKU num ExpressRouteCircuit.
Name | Tipo | Description |
---|---|---|
family |
A família do SKU. |
|
name |
string |
O nome do SKU. |
tier |
O escalão do SKU. |
ExpressRouteCircuitSkuFamily
A família do SKU.
Name | Tipo | Description |
---|---|---|
MeteredData |
string |
|
UnlimitedData |
string |
ExpressRouteCircuitSkuTier
O escalão do SKU.
Name | Tipo | Description |
---|---|---|
Basic |
string |
|
Local |
string |
|
Premium |
string |
|
Standard |
string |
ExpressRouteCircuitStats
Contém estatísticas associadas ao peering.
Name | Tipo | Description |
---|---|---|
primarybytesIn |
integer |
O BytesIn Primário do peering. |
primarybytesOut |
integer |
O BytesOut principal do peering. |
secondarybytesIn |
integer |
O BytesIn secundário do peering. |
secondarybytesOut |
integer |
BytesOut secundário do peering. |
ExpressRouteConnectionId
O ID do ExpressRouteConnection.
Name | Tipo | Description |
---|---|---|
id |
string |
O ID do ExpressRouteConnection. |
ExpressRoutePeeringState
O estado do peering.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ExpressRoutePeeringType
O tipo de peering.
Name | Tipo | Description |
---|---|---|
AzurePrivatePeering |
string |
|
AzurePublicPeering |
string |
|
MicrosoftPeering |
string |
Ipv6CircuitConnectionConfig
Propriedades de Ligação do Circuito IPv6 para alcance global.
Name | Tipo | Description |
---|---|---|
addressPrefix |
string |
/125 espaço de endereços IP para esculpe os endereços dos clientes para alcance global. |
circuitConnectionStatus |
Estado da ligação do Circuito do Express Route. |
Ipv6ExpressRouteCircuitPeeringConfig
Contém a configuração de peering IPv6.
Name | Tipo | Description |
---|---|---|
microsoftPeeringConfig |
A configuração do peering da Microsoft. |
|
primaryPeerAddressPrefix |
string |
O prefixo de endereço principal. |
routeFilter |
A referência ao recurso RouteFilter. |
|
secondaryPeerAddressPrefix |
string |
O prefixo de endereço secundário. |
state |
O estado do peering. |
PeerExpressRouteCircuitConnection
Peer Express Route Circuit Connection num recurso ExpressRouteCircuitPeering.
Name | Tipo | Description |
---|---|---|
etag |
string |
Uma cadeia exclusiva só de leitura que é alterada sempre que o recurso é atualizado. |
id |
string |
ID do Recurso. |
name |
string |
O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso. |
properties.addressPrefix |
string |
/29 espaço de endereços IP para esculpir endereços de cliente para túneis. |
properties.authResourceGuid |
string |
O guid de recurso da autorização utilizada para a ligação do circuito de rota rápida. |
properties.circuitConnectionStatus |
Estado da ligação do Circuito do Express Route. |
|
properties.connectionName |
string |
O nome do recurso de ligação do circuito de rota rápida. |
properties.expressRouteCircuitPeering |
Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito. |
|
properties.peerExpressRouteCircuitPeering |
Referência ao Recurso de Peering Privado do Circuito do Express Route do circuito em modo de peering. |
|
properties.provisioningState |
O estado de aprovisionamento do recurso de ligação do circuito do express route peer. |
|
type |
string |
Tipo de recurso. |
ProvisioningState
O estado de aprovisionamento atual.
Name | Tipo | Description |
---|---|---|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ServiceProviderProvisioningState
O estado ServiceProviderProvisioningState do recurso.
Name | Tipo | Description |
---|---|---|
Deprovisioning |
string |
|
NotProvisioned |
string |
|
Provisioned |
string |
|
Provisioning |
string |
SubResource
Referência a outra sub-origem.
Name | Tipo | Description |
---|---|---|
id |
string |
ID do Recurso. |