Express Route Circuits - Get

Referência

Serviço:: ExpressRoute

Versão da API:: 2023-11-01

Obtém informações sobre o circuito de rota expressa especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
circuitName	path	True	string	O nome do circuito de rota expressa.
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. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	ExpressRouteCircuit	Pedido bem-sucedido. A operação retorna o recurso ExpressRouteCircuit resultante.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get ExpressRouteCircuit

Pedido de amostra

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


/**
 * Samples for ExpressRouteCircuits GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitGet.json
     */
    /**
     * Sample code: Get ExpressRouteCircuit.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCircuit(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuits().getByResourceGroupWithResponse("rg1",
            "circuitName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python express_route_circuit_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.express_route_circuits.get(
        resource_group_name="rg1",
        circuit_name="circuitName",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f4c6c8697c59f966db0d1e36b62df3af3bca9065/specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitGet.json
func ExampleExpressRouteCircuitsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExpressRouteCircuitsClient().Get(ctx, "rg1", "circuitName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExpressRouteCircuit = armnetwork.ExpressRouteCircuit{
	// 	Name: to.Ptr("circuitName"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCircuits"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName"),
	// 	Location: to.Ptr("westus"),
	// 	Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 	Properties: &armnetwork.ExpressRouteCircuitPropertiesFormat{
	// 		AllowClassicOperations: to.Ptr(false),
	// 		Authorizations: []*armnetwork.ExpressRouteCircuitAuthorization{
	// 		},
	// 		CircuitProvisioningState: to.Ptr("Enabled"),
	// 		Peerings: []*armnetwork.ExpressRouteCircuitPeering{
	// 		},
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		ServiceKey: to.Ptr("a1410692-0000-4ceb-b94a-b90b94d398d1"),
	// 		ServiceProviderProperties: &armnetwork.ExpressRouteCircuitServiceProviderProperties{
	// 			BandwidthInMbps: to.Ptr[int32](200),
	// 			PeeringLocation: to.Ptr("peeringLocation"),
	// 			ServiceProviderName: to.Ptr("providerName"),
	// 		},
	// 		ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
	// 	},
	// 	SKU: &armnetwork.ExpressRouteCircuitSKU{
	// 		Name: to.Ptr("Standard_MeteredData"),
	// 		Family: to.Ptr(armnetwork.ExpressRouteCircuitSKUFamilyMeteredData),
	// 		Tier: to.Ptr(armnetwork.ExpressRouteCircuitSKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified express route circuit.
 *
 * @summary Gets information about the specified express route circuit.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-11-01/examples/ExpressRouteCircuitGet.json
 */
async function getExpressRouteCircuit() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "circuitName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuits.get(resourceGroupName, circuitName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "name": "circuitName",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "type": "Microsoft.Network/expressRouteCircuits",
  "location": "westus",
  "properties": {
    "provisioningState": "Succeeded",
    "peerings": [],
    "authorizations": [],
    "serviceProviderProperties": {
      "serviceProviderName": "providerName",
      "peeringLocation": "peeringLocation",
      "bandwidthInMbps": 200
    },
    "circuitProvisioningState": "Enabled",
    "allowClassicOperations": false,
    "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1",
    "serviceProviderProvisioningState": "NotProvisioned"
  },
  "sku": {
    "name": "Standard_MeteredData",
    "tier": "Standard",
    "family": "MeteredData"
  }
}

Definições

Name	Description
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 de rota expressa em um recurso ExpressRouteCircuitPeering.
ExpressRouteCircuitPeering	Emparelhamento em um recurso ExpressRouteCircuit.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado do prefixo público anunciado do recurso de emparelhamento.
ExpressRouteCircuitPeeringConfig	Especifica a configuração de emparelhamento.
ExpressRouteCircuitPeeringState	O estado do peering.
ExpressRouteCircuitServiceProviderProperties	Contém ServiceProviderProperties em um ExpressRouteCircuit.
ExpressRouteCircuitSku	Contém SKU em um ExpressRouteCircuit.
ExpressRouteCircuitSkuFamily	A família do SKU.
ExpressRouteCircuitSkuTier	A camada do SKU.
ExpressRouteCircuitStats	Contém estatísticas associadas ao emparelhamento.
ExpressRouteConnectionId	A ID do ExpressRouteConnection.
ExpressRoutePeeringState	O estado do peering.
ExpressRoutePeeringType	O tipo de emparelhamento.
Ipv6CircuitConnectionConfig	Propriedades de Conexão de Circuito IPv6 para alcance global.
Ipv6ExpressRouteCircuitPeeringConfig	Contém configuração de emparelhamento IPv6.
PeerExpressRouteCircuitConnection	Conexão de Circuito de Rota Expressa Ponto a Ponto em um recurso ExpressRouteCircuitPeering.
ProvisioningState	O estado de provisionamento atual.
ServiceProviderProvisioningState	O estado ServiceProviderProvisioningState do recurso.
SubResource	Referência a outro subrecurso.

AuthorizationUseStatus

O status de uso da autorização.

Name	Tipo	Description
Available	string
InUse	string

CircuitConnectionStatus

Estado de conexão do Circuito de Rota Expressa.

Name	Tipo	Description
Connected	string
Connecting	string
Disconnected	string

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	CloudErrorBody	Corpo do erro na nuvem.

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	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ExpressRouteCircuit

Recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.allowClassicOperations	boolean	Permita 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.enableDirectPortRateLimit	boolean	Sinalizador que indica o status de limitação de taxa do circuito de porta direta da Rota Expressa.
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 o status de alcance global.
properties.peerings	ExpressRouteCircuitPeering[]	A lista de pares.
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. Tag externa para encapsulamento QinQ.
sku	ExpressRouteCircuitSku	O SKU.
tags	object	Tags de recursos.
type	string	Tipo de recurso.

ExpressRouteCircuitAuthorization

Autorização em um recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.authorizationKey	string	A chave de autorização.
properties.authorizationUseStatus	AuthorizationUseStatus	O status de uso da autorização.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de autorização.
type	string	Tipo de recurso.

ExpressRouteCircuitConnection

Conexão de circuito de rota expressa em um recurso ExpressRouteCircuitPeering.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.addressPrefix	string	/29 espaço de endereço IP para criar endereços de clientes para túneis.
properties.authorizationKey	string	A chave de autorização.
properties.circuitConnectionStatus	CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.
properties.expressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito que inicia a conexão.
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	Prefixo de Endereço IPv6Propriedades da conexão do circuito de rota expressa.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito emparelhado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão de circuito de rota expressa.
type	string	Tipo de recurso.

ExpressRouteCircuitPeering

Emparelhamento em um recurso ExpressRouteCircuit.

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de 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 este circuito.
properties.expressRouteConnection	ExpressRouteConnectionId	A conexão 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 peering.
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 principal.
properties.primaryPeerAddressPrefix	string	O prefixo do endereço principal.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de emparelhamento de 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	O ID VLAN.
type	string	Tipo de recurso.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

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

Name	Tipo	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Especifica a configuração de emparelhamento.

Name	Tipo	Description
advertisedCommunities	string[]	As comunidades de bgp peering. Especificado para emparelhamento da Microsoft.
advertisedPublicPrefixes	string[]	A referência a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	O estado do prefixo público anunciado do recurso de emparelhamento.
customerASN	integer	O CustomerASN do emparelhamento.
legacyMode	integer	O modo legado do emparelhamento.
routingRegistryName	string	O RoutingRegistryName da configuração.

ExpressRouteCircuitPeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRouteCircuitServiceProviderProperties

Contém ServiceProviderProperties em um ExpressRouteCircuit.

Name	Tipo	Description
bandwidthInMbps	integer	O BandwidthInMbps.
peeringLocation	string	O local de emparelhamento.
serviceProviderName	string	O serviceProviderName.

ExpressRouteCircuitSku

Contém SKU em um ExpressRouteCircuit.

Name	Tipo	Description
family	ExpressRouteCircuitSkuFamily	A família do SKU.
name	string	O nome do SKU.
tier	ExpressRouteCircuitSkuTier	A camada do SKU.

ExpressRouteCircuitSkuFamily

A família do SKU.

Name	Tipo	Description
MeteredData	string
UnlimitedData	string

ExpressRouteCircuitSkuTier

A camada do SKU.

Name	Tipo	Description
Basic	string
Local	string
Premium	string
Standard	string

ExpressRouteCircuitStats

Contém estatísticas associadas ao emparelhamento.

Name	Tipo	Description
primarybytesIn	integer	Os BytesIn primários 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.

Name	Tipo	Description
id	string	A ID do ExpressRouteConnection.

ExpressRoutePeeringState

O estado do peering.

Name	Tipo	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

O tipo de emparelhamento.

Name	Tipo	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6CircuitConnectionConfig

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

Name	Tipo	Description
addressPrefix	string	/125 espaço de endereços IP para criar endereços de clientes para alcance global.
circuitConnectionStatus	CircuitConnectionStatus	Estado de conexão do Circuito de Rota Expressa.

Ipv6ExpressRouteCircuitPeeringConfig

Contém configuração de emparelhamento IPv6.

Name	Tipo	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A configuração de emparelhamento da Microsoft.
primaryPeerAddressPrefix	string	O prefixo do endereço principal.
routeFilter	SubResource	A referência ao recurso RouteFilter.
secondaryPeerAddressPrefix	string	O prefixo de endereço secundário.
state	ExpressRouteCircuitPeeringState	O estado do peering.

PeerExpressRouteCircuitConnection

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

Name	Tipo	Description
etag	string	Uma cadeia de caracteres somente leitura exclusiva que muda sempre que o recurso é atualizado.
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties.addressPrefix	string	/29 espaço de endereço IP para criar endereços de clientes 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	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	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito.
properties.peerExpressRouteCircuitPeering	SubResource	Referência ao Express Route Circuit Private Peering Resource do circuito emparelhado.
properties.provisioningState	ProvisioningState	O estado de provisionamento do recurso de conexão de circuito de rota expressa ponto a ponto.
type	string	Tipo de recurso.

ProvisioningState

O estado de provisionamento 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 outro subrecurso.

Name	Tipo	Description
id	string	ID do recurso.

Partilhar via

Express Route Circuits - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get ExpressRouteCircuit

Pedido de amostra

Resposta da amostra

Definições

AuthorizationUseStatus

CircuitConnectionStatus

CloudError

CloudErrorBody

ExpressRouteCircuit

ExpressRouteCircuitAuthorization

ExpressRouteCircuitConnection

ExpressRouteCircuitPeering

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

ExpressRouteCircuitPeeringConfig

ExpressRouteCircuitPeeringState

ExpressRouteCircuitServiceProviderProperties

ExpressRouteCircuitSku

ExpressRouteCircuitSkuFamily

ExpressRouteCircuitSkuTier

ExpressRouteCircuitStats

ExpressRouteConnectionId

ExpressRoutePeeringState

ExpressRoutePeeringType

Ipv6CircuitConnectionConfig

Ipv6ExpressRouteCircuitPeeringConfig

PeerExpressRouteCircuitConnection

ProvisioningState

ServiceProviderProvisioningState

SubResource

Recursos adicionais