Express Route Connections - List

Servizio:

Virtual WAN

Versione API:

2024-05-01

Elenca ExpressRouteConnections.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
expressRouteGatewayName	path	True	string	Nome del gateway ExpressRoute.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	Credenziali della sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	ExpressRouteConnectionList	Richiesta riuscita.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ExpressRouteConnectionList

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for ExpressRouteConnections List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionList.
     * json
     */
    /**
     * Sample code: ExpressRouteConnectionList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void expressRouteConnectionList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteConnections().listWithResponse("resourceGroupName",
            "expressRouteGatewayName", 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_list.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.list(
        resource_group_name="resourceGroupName",
        express_route_gateway_name="expressRouteGatewayName",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionList.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/ExpressRouteConnectionList.json
func ExampleExpressRouteConnectionsClient_List() {
	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().List(ctx, "resourceGroupName", "expressRouteGatewayName", 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.ExpressRouteConnectionList = armnetwork.ExpressRouteConnectionList{
	// 	Value: []*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 Lists ExpressRouteConnections.
 *
 * @summary Lists ExpressRouteConnections.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteConnectionList.json
 */
async function expressRouteConnectionList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "resourceGroupName";
  const expressRouteGatewayName = "expressRouteGatewayName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteConnections.list(
    resourceGroupName,
    expressRouteGatewayName,
  );
  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/ExpressRouteConnectionList.json
// this example is just showing the usage of "ExpressRouteConnections_List" 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 and iterate over the result
await foreach (ExpressRouteConnectionResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "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"
          }
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ExpressRouteCircuitPeeringId	Identificatore del peering del circuito ExpressRoute.
ExpressRouteConnection	Risorsa ExpressRouteConnection.
ExpressRouteConnectionList	Elenco ExpressRouteConnection.
PropagatedRouteTable	Elenco di RouteTables a cui annunciare le route.
ProvisioningState	Stato di provisioning corrente.
RoutingConfiguration	Configurazione di routing che indica le tabelle di route associate e propagate per questa connessione.
StaticRoute	Elenco di tutte le route statiche.
StaticRoutesConfig	Configurazione per le route statiche in questo hubVnetConnectionConfiguration per le route statiche in questo hubVnetConnection.
SubResource	Riferimento a un'altra sottorisorsa.
VnetLocalRouteOverrideCriteria	Parametro che determina se l'appliance virtuale di rete virtuale in spoke viene ignorata per il traffico con destinazione nella rete virtuale spoke.
VnetRoute	Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.

CloudError

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

ExpressRouteCircuitPeeringId

Object

Identificatore del peering del circuito ExpressRoute.

Nome	Tipo	Descrizione
id	string	ID del peering del circuito ExpressRoute.

ExpressRouteConnection

Object

Risorsa ExpressRouteConnection.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome della risorsa.
properties.authorizationKey	string	Chiave di autorizzazione per stabilire la connessione.
properties.enableInternetSecurity	boolean	Abilitare la sicurezza Internet.
properties.enablePrivateLinkFastPath	boolean	Ignorare il gateway ExpressRoute quando si accede a collegamenti privati. È necessario abilitare ExpressRoute FastPath (expressRouteGatewayBypass).
properties.expressRouteCircuitPeering	ExpressRouteCircuitPeeringId	Peering del circuito ExpressRoute.
properties.expressRouteGatewayBypass	boolean	Abilitare FastPath per l'hub firewall vWan.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione expressroute.
properties.routingConfiguration	RoutingConfiguration	Configurazione di routing che indica le tabelle di route associate e propagate in questa connessione.
properties.routingWeight	integer	Peso del routing associato alla connessione.

ExpressRouteConnectionList

Object

Elenco ExpressRouteConnection.

Nome	Tipo	Descrizione
value	ExpressRouteConnection[]	Elenco delle connessioni ExpressRoute.

PropagatedRouteTable

Object

Elenco di RouteTables a cui annunciare le route.

Nome	Tipo	Descrizione
ids	SubResource[]	Elenco di ID risorsa di tutte le tabelle RouteTable.
labels	string[]	Elenco di etichette.

ProvisioningState

Enumerazione

Stato di provisioning corrente.

Valore	Descrizione
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Object

Configurazione di routing che indica le tabelle di route associate e propagate per questa connessione.

Nome	Tipo	Descrizione
associatedRouteTable	SubResource	Id risorsa RouteTable associato a questo RoutingConfiguration.
inboundRouteMap	SubResource	ID risorsa dell'oggetto RouteMap associato a questo RoutingConfiguration per le route apprese in ingresso.
outboundRouteMap	SubResource	ID risorsa dell'oggettoRouteMap associato a questo RoutingConfiguration per le route annunciate in uscita.
propagatedRouteTables	PropagatedRouteTable	Elenco di RouteTables a cui annunciare le route.
vnetRoutes	VnetRoute	Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.

StaticRoute

Object

Elenco di tutte le route statiche.

Nome	Tipo	Descrizione
addressPrefixes	string[]	Elenco di tutti i prefissi di indirizzo.
name	string	Nome dell'oggetto StaticRoute univoco all'interno di una rete virtuale.
nextHopIpAddress	string	Indirizzo IP dell'hop successivo.

StaticRoutesConfig

Object

Configurazione per le route statiche in questo hubVnetConnectionConfiguration per le route statiche in questo hubVnetConnection.

Nome	Tipo	Descrizione
propagateStaticRoutes	boolean	Valore booleano che indica se le route statiche in questa connessione vengono propagate automaticamente alle tabelle di route a cui viene propagata la connessione.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	Parametro che determina se l'appliance virtuale di rete nella rete virtuale spoke viene ignorata per il traffico con destinazione in spoke.

SubResource

Object

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.

VnetLocalRouteOverrideCriteria

Enumerazione

Parametro che determina se l'appliance virtuale di rete virtuale in spoke viene ignorata per il traffico con destinazione nella rete virtuale spoke.

Valore	Descrizione
Contains
Equal

VnetRoute

Object

Elenco di route che controllano il routing da VirtualHub in una connessione di rete virtuale.

Nome	Tipo	Descrizione
bgpConnections	SubResource[]	Elenco di riferimenti agli oggetti HubBgpConnection.
staticRoutes	StaticRoute[]	Elenco di tutte le route statiche.
staticRoutesConfig	StaticRoutesConfig	Configurazione per le route statiche in questo hubVnetConnection.