Express Route Connections - Get

Servicio:

Virtual WAN

Versión de la API:

2024-05-01

Obtiene el objeto ExpressRouteConnection especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
connectionName	path	True	string	Nombre de la conexión de ExpressRoute.
expressRouteGatewayName	path	True	string	Nombre de la puerta de enlace de ExpressRoute.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	ExpressRouteConnection	Solicitud correcta. La operación devuelve ExpressRouteConnection.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ExpressRouteConnectionGet

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName?api-version=2024-05-01

Java

/**
 * Samples for ExpressRouteConnections Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionGet.
     * json
     */
    /**
     * Sample code: ExpressRouteConnectionGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRouteConnectionGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteConnections().getWithResponse("resourceGroupName",
            "expressRouteGatewayName", "connectionName", 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

Python

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_connection_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_connections.get(
        resource_group_name="resourceGroupName",
        express_route_gateway_name="expressRouteGatewayName",
        connection_name="connectionName",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionGet.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

Go

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/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionGet.json
func ExampleExpressRouteConnectionsClient_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.NewExpressRouteConnectionsClient().Get(ctx, "resourceGroupName", "expressRouteGatewayName", "connectionName", 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.ExpressRouteConnection = armnetwork.ExpressRouteConnection{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName"),
	// 	Name: to.Ptr("connectionName"),
	// 	Properties: &armnetwork.ExpressRouteConnectionProperties{
	// 		AuthorizationKey: to.Ptr("authorizationKey"),
	// 		EnableInternetSecurity: to.Ptr(false),
	// 		EnablePrivateLinkFastPath: to.Ptr(false),
	// 		ExpressRouteCircuitPeering: &armnetwork.ExpressRouteCircuitPeeringID{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering"),
	// 		},
	// 		ExpressRouteGatewayBypass: to.Ptr(false),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		RoutingConfiguration: &armnetwork.RoutingConfiguration{
	// 			AssociatedRouteTable: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
	// 			},
	// 			InboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"),
	// 			},
	// 			OutboundRouteMap: &armnetwork.SubResource{
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"),
	// 			},
	// 			PropagatedRouteTables: &armnetwork.PropagatedRouteTable{
	// 				IDs: []*armnetwork.SubResource{
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"),
	// 					},
	// 					{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"),
	// 				}},
	// 				Labels: []*string{
	// 					to.Ptr("label1"),
	// 					to.Ptr("label2")},
	// 				},
	// 			},
	// 			RoutingWeight: to.Ptr[int32](1),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets the specified ExpressRouteConnection.
 *
 * @summary Gets the specified ExpressRouteConnection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionGet.json
 */
async function expressRouteConnectionGet() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "resourceGroupName";
  const expressRouteGatewayName = "expressRouteGatewayName";
  const connectionName = "connectionName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteConnections.get(
    resourceGroupName,
    expressRouteGatewayName,
    connectionName,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionGet.json
// this example is just showing the usage of "ExpressRouteConnections_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ExpressRouteGatewayResource created on azure
// for more information of creating ExpressRouteGatewayResource, please refer to the document of ExpressRouteGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "resourceGroupName";
string expressRouteGatewayName = "expressRouteGatewayName";
ResourceIdentifier expressRouteGatewayResourceId = ExpressRouteGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, expressRouteGatewayName);
ExpressRouteGatewayResource expressRouteGateway = client.GetExpressRouteGatewayResource(expressRouteGatewayResourceId);

// get the collection of this ExpressRouteConnectionResource
ExpressRouteConnectionCollection collection = expressRouteGateway.GetExpressRouteConnections();

// invoke the operation
string connectionName = "connectionName";
NullableResponse<ExpressRouteConnectionResource> response = await collection.GetIfExistsAsync(connectionName);
ExpressRouteConnectionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ExpressRouteConnectionData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Respuesta de muestra

status code:

200

{
  "name": "connectionName",
  "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName",
  "properties": {
    "provisioningState": "Provisioned",
    "expressRouteCircuitPeering": {
      "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering"
    },
    "authorizationKey": "authorizationKey",
    "routingWeight": 1,
    "enableInternetSecurity": false,
    "expressRouteGatewayBypass": false,
    "enablePrivateLinkFastPath": false,
    "routingConfiguration": {
      "associatedRouteTable": {
        "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
      },
      "propagatedRouteTables": {
        "labels": [
          "label1",
          "label2"
        ],
        "ids": [
          {
            "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2"
          },
          {
            "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3"
          }
        ]
      },
      "inboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1"
      },
      "outboundRouteMap": {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2"
      }
    }
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
ExpressRouteCircuitPeeringId	Identificador de emparejamiento de circuitos ExpressRoute.
ExpressRouteConnection	Recurso ExpressRouteConnection.
PropagatedRouteTable	Lista de RouteTables a las que anunciar las rutas.
ProvisioningState	Estado de aprovisionamiento actual.
RoutingConfiguration	Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.
StaticRoute	Lista de todas las rutas estáticas.
StaticRoutesConfig	Configuración de rutas estáticas en este hubVnetConnectionConfiguration para rutas estáticas en este HubVnetConnection.
SubResource	Referencia a otro subrecurso.
VnetLocalRouteOverrideCriteria	Parámetro que determina si se omite la NVA en la red virtual radial para el tráfico con destino en la red virtual de radio.
VnetRoute	Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

ExpressRouteCircuitPeeringId

Object

Identificador de emparejamiento de circuitos ExpressRoute.

Nombre	Tipo	Description
id	string	Identificador del emparejamiento de circuitos ExpressRoute.

ExpressRouteConnection

Object

Recurso ExpressRouteConnection.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.authorizationKey	string	Clave de autorización para establecer la conexión.
properties.enableInternetSecurity	boolean	Habilite la seguridad de Internet.
properties.enablePrivateLinkFastPath	boolean	Omita la puerta de enlace de ExpressRoute al acceder a vínculos privados. FastPath de ExpressRoute (expressRouteGatewayBypass) debe estar habilitado.
properties.expressRouteCircuitPeering	ExpressRouteCircuitPeeringId	Emparejamiento de circuitos ExpressRoute.
properties.expressRouteGatewayBypass	boolean	Habilite FastPath en el centro de firewall de vWan.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de conexión de expressroute.
properties.routingConfiguration	RoutingConfiguration	Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas en esta conexión.
properties.routingWeight	integer	Peso de enrutamiento asociado a la conexión.

PropagatedRouteTable

Object

Lista de RouteTables a las que anunciar las rutas.

Nombre	Tipo	Description
ids	SubResource[]	Lista de identificadores de recursos de todas las RouteTables.
labels	string[]	Lista de etiquetas.

ProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

Configuración de enrutamiento que indica las tablas de rutas asociadas y propagadas para esta conexión.

Nombre	Tipo	Description
associatedRouteTable	SubResource	El identificador de recurso RouteTable asociado a este RoutingConfiguration.
inboundRouteMap	SubResource	El identificador de recurso del objeto RouteMap asociado a este Objeto RoutingConfiguration para las rutas aprendidas de entrada.
outboundRouteMap	SubResource	El identificador de recurso derouteMap asociado a este routingConfiguration para las rutas anunciadas salientes.
propagatedRouteTables	PropagatedRouteTable	Lista de RouteTables a las que anunciar las rutas.
vnetRoutes	VnetRoute	Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

StaticRoute

Object

Lista de todas las rutas estáticas.

Nombre	Tipo	Description
addressPrefixes	string[]	Lista de todos los prefijos de dirección.
name	string	Nombre de StaticRoute que es único dentro de una instancia de VnetRoute.
nextHopIpAddress	string	Dirección IP del próximo salto.

StaticRoutesConfig

Object

Configuración de rutas estáticas en este hubVnetConnectionConfiguration para rutas estáticas en este HubVnetConnection.

Nombre	Tipo	Description
propagateStaticRoutes	boolean	Boolean que indica si las rutas estáticas de esta conexión se propagan automáticamente a las tablas de rutas a las que se propaga esta conexión.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parámetro que determina si se omite la NVA en la red virtual de radio para el tráfico con destino en radio.

SubResource

Object

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador de recurso.

VnetLocalRouteOverrideCriteria

Enumeración

Parámetro que determina si se omite la NVA en la red virtual radial para el tráfico con destino en la red virtual de radio.

Valor	Description
Contains
Equal

VnetRoute

Object

Lista de rutas que controlan el enrutamiento desde VirtualHub a una conexión de red virtual.

Nombre	Tipo	Description
bgpConnections	SubResource[]	Lista de referencias a objetos HubBgpConnection.
staticRoutes	StaticRoute[]	Lista de todas las rutas estáticas.
staticRoutesConfig	StaticRoutesConfig	Configuración de rutas estáticas en este HubVnetConnection.