Express Route Cross Connections - List By Resource Group

Service:

ExpressRoute

API Version:

2023-09-01

Recupera tutte le connessioni ExpressRouteCrossConnections in un gruppo di risorse.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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 di servizio.
api-version	query	True	string	Versione API client.

Risposte

Nome	Tipo	Descrizione
200 OK	ExpressRouteCrossConnectionListResult	Richiesta completata. L'operazione restituisce un elenco di risorse ExpressRouteCrossConnection. Se non sono presenti risorse di connessione incrociata, viene restituito un elenco vuoto.
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.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ExpressRouteCrossConnectionListByResourceGroup

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections?api-version=2023-09-01

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_cross_connection_list_by_resource_group.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_cross_connections.list_by_resource_group(
        resource_group_name="CrossConnection-SiliconValley",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionListByResourceGroup.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json
func ExampleExpressRouteCrossConnectionsClient_NewListByResourceGroupPager() {
	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)
	}
	pager := clientFactory.NewExpressRouteCrossConnectionsClient().NewListByResourceGroupPager("CrossConnection-SiliconValley", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExpressRouteCrossConnectionListResult = armnetwork.ExpressRouteCrossConnectionListResult{
		// 	Value: []*armnetwork.ExpressRouteCrossConnection{
		// 		{
		// 			Name: to.Ptr("<circuitServiceKey>"),
		// 			Type: to.Ptr("Microsoft.Network/expressRouteCrossConnections"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>"),
		// 			Location: to.Ptr("brazilsouth"),
		// 			Properties: &armnetwork.ExpressRouteCrossConnectionProperties{
		// 				BandwidthInMbps: to.Ptr[int32](1000),
		// 				ExpressRouteCircuit: &armnetwork.ExpressRouteCircuitReference{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"),
		// 				},
		// 				PeeringLocation: to.Ptr("SiliconValley"),
		// 				Peerings: []*armnetwork.ExpressRouteCrossConnectionPeering{
		// 				},
		// 				PrimaryAzurePort: to.Ptr("bvtazureixp01"),
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				STag: to.Ptr[int32](2),
		// 				SecondaryAzurePort: to.Ptr("bvtazureixp01"),
		// 				ServiceProviderProvisioningState: to.Ptr(armnetwork.ServiceProviderProvisioningStateNotProvisioned),
		// 			},
		// 	}},
		// }
	}
}

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 Retrieves all the ExpressRouteCrossConnections in a resource group.
 *
 * @summary Retrieves all the ExpressRouteCrossConnections in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json
 */
async function expressRouteCrossConnectionListByResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.expressRouteCrossConnections.listByResourceGroup(
    resourceGroupName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json
// this example is just showing the usage of "ExpressRouteCrossConnections_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this ExpressRouteCrossConnectionResource
ExpressRouteCrossConnectionCollection collection = resourceGroupResource.GetExpressRouteCrossConnections();

// invoke the operation and iterate over the result
await foreach (ExpressRouteCrossConnectionResource 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
    ExpressRouteCrossConnectionData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "<circuitServiceKey>",
      "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
      "type": "Microsoft.Network/expressRouteCrossConnections",
      "location": "brazilsouth",
      "properties": {
        "provisioningState": "Enabled",
        "expressRouteCircuit": {
          "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1"
        },
        "peerings": [],
        "peeringLocation": "SiliconValley",
        "bandwidthInMbps": 1000,
        "primaryAzurePort": "bvtazureixp01",
        "secondaryAzurePort": "bvtazureixp01",
        "sTag": 2,
        "serviceProviderProvisioningState": "NotProvisioned"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore dal servizio.
CloudErrorBody	Risposta di errore dal servizio.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Stato del prefisso pubblico annunciato della risorsa peering.
ExpressRouteCircuitPeeringConfig	Specifica la configurazione del peering.
ExpressRouteCircuitPeeringState	Stato del peering.
ExpressRouteCircuitReference	Riferimento a un circuito ExpressRoute.
ExpressRouteCrossConnection	Risorsa ExpressRouteCrossConnection.
ExpressRouteCrossConnectionListResult	Risposta per la chiamata al servizio API ListExpressRouteCrossConnection.
ExpressRouteCrossConnectionPeering	Peering in una risorsa ExpressRoute Cross Connection.
ExpressRoutePeeringState	Stato del peering.
ExpressRoutePeeringType	Tipo di peering.
Ipv6ExpressRouteCircuitPeeringConfig	Contiene la configurazione del peering IPv6.
ProvisioningState	Stato di provisioning corrente.
ServiceProviderProvisioningState	Stato ServiceProviderProvisioningState della risorsa.
SubResource	Riferimento a un'altra sottorisorsa.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	CloudErrorBody	Corpo dell'errore cloud.

CloudErrorBody

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, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Stato del prefisso pubblico annunciato della risorsa peering.

Nome	Tipo	Descrizione
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Specifica la configurazione del peering.

Nome	Tipo	Descrizione
advertisedCommunities	string[]	Le comunità del peering bgp. Specificato per il peering Microsoft.
advertisedPublicPrefixes	string[]	Riferimento a AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Stato del prefisso pubblico annunciato della risorsa peering.
customerASN	integer	CustomerASN del peering.
legacyMode	integer	Modalità legacy del peering.
routingRegistryName	string	RoutingRegistryName della configurazione.

ExpressRouteCircuitPeeringState

Stato del peering.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ExpressRouteCircuitReference

Riferimento a un circuito ExpressRoute.

Nome	Tipo	Descrizione
id	string	ID circuito ExpressRoute corrispondente.

ExpressRouteCrossConnection

Risorsa ExpressRouteCrossConnection.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.bandwidthInMbps	integer	Larghezza di banda del circuito In Mbps.
properties.expressRouteCircuit	ExpressRouteCircuitReference	The ExpressRouteCircuit.
properties.peeringLocation	string	Percorso di peering del circuito ExpressRoute.
properties.peerings	ExpressRouteCrossConnectionPeering[]	Elenco di peering.
properties.primaryAzurePort	string	Nome della porta primaria.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa tra connessioni expressroute.
properties.sTag	integer	Identificatore del traffico del circuito.
properties.secondaryAzurePort	string	Nome della porta secondaria.
properties.serviceProviderNotes	string	Note aggiuntive di sola lettura impostate dal provider di connettività.
properties.serviceProviderProvisioningState	ServiceProviderProvisioningState	Stato di provisioning del circuito nel sistema del provider di connettività.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa.

ExpressRouteCrossConnectionListResult

Risposta per la chiamata al servizio API ListExpressRouteCrossConnection.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set di risultati successivo.
value	ExpressRouteCrossConnection[]	Elenco di risorse ExpressRouteCrossConnection.

ExpressRouteCrossConnectionPeering

Peering in una risorsa ExpressRoute Cross Connection.

Nome	Tipo	Descrizione
etag	string	Stringa di sola lettura univoca che cambia ogni volta che la risorsa viene aggiornata.
id	string	ID risorsa.
name	string	Nome della risorsa univoca all'interno di un gruppo di risorse. Questo nome può essere usato per accedere alla risorsa.
properties.azureASN	integer	AsN di Azure.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configurazione del peering IPv6.
properties.lastModifiedBy	string	Ultima modifica del peering.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configurazione del peering Microsoft.
properties.peerASN	integer	ASN peer.
properties.peeringType	ExpressRoutePeeringType	Tipo di peering.
properties.primaryAzurePort	string	Porta primaria.
properties.primaryPeerAddressPrefix	string	Prefisso dell'indirizzo primario.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa peering tra connessioni expressroute.
properties.secondaryAzurePort	string	Porta secondaria.
properties.secondaryPeerAddressPrefix	string	Prefisso dell'indirizzo secondario.
properties.sharedKey	string	Chiave condivisa.
properties.state	ExpressRoutePeeringState	Stato del peering.
properties.vlanId	integer	ID VLAN.

ExpressRoutePeeringState

Stato del peering.

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

ExpressRoutePeeringType

Tipo di peering.

Nome	Tipo	Descrizione
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Contiene la configurazione del peering IPv6.

Nome	Tipo	Descrizione
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Configurazione del peering Microsoft.
primaryPeerAddressPrefix	string	Prefisso dell'indirizzo primario.
routeFilter	SubResource	Riferimento alla risorsa RouteFilter.
secondaryPeerAddressPrefix	string	Prefisso dell'indirizzo secondario.
state	ExpressRouteCircuitPeeringState	Stato del peering.

ProvisioningState

Stato di provisioning corrente.

Nome	Tipo	Descrizione
Deleting	string
Failed	string
Succeeded	string
Updating	string

ServiceProviderProvisioningState

Stato ServiceProviderProvisioningState della risorsa.

Nome	Tipo	Descrizione
Deprovisioning	string
NotProvisioned	string
Provisioned	string
Provisioning	string

SubResource

Riferimento a un'altra sottorisorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa.