Express Route Cross Connections - Get

Riferimento

Service:: ExpressRoute

API Version:: 2023-09-01

Ottiene informazioni dettagliate sull'oggetto ExpressRouteCrossConnection specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
crossConnectionName	path	True	string	Nome dell'oggetto ExpressRouteCrossConnection (chiave di servizio del circuito).
resourceGroupName	path	True	string	Nome del gruppo di risorse (posizione di peering del circuito).
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	ExpressRouteCrossConnection	Richiesta riuscita. L'operazione restituisce la risorsa ExpressRouteCrossConnection risultante.
Other Status Codes	CloudError	Risposta di errore che descrive perché 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

GetExpressRouteCrossConnection

Sample Request

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


/**
 * Samples for ExpressRouteCrossConnections GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * ExpressRouteCrossConnectionGet.json
     */
    /**
     * Sample code: GetExpressRouteCrossConnection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCrossConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCrossConnections().getByResourceGroupWithResponse(
            "CrossConnection-SiliconValley", "<circuitServiceKey>", 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_cross_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_cross_connections.get(
        resource_group_name="CrossConnection-SiliconValley",
        cross_connection_name="<circuitServiceKey>",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionGet.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/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionGet.json
func ExampleExpressRouteCrossConnectionsClient_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.NewExpressRouteCrossConnectionsClient().Get(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", 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.ExpressRouteCrossConnection = armnetwork.ExpressRouteCrossConnection{
	// 	Name: to.Ptr("<circuitServiceKey>"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCrossConnections"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>"),
	// 	Location: to.Ptr("brazilsouth"),
	// 	Etag: to.Ptr("W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\""),
	// 	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

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

/**
 * This sample demonstrates how to Gets details about the specified ExpressRouteCrossConnection.
 *
 * @summary Gets details about the specified ExpressRouteCrossConnection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ExpressRouteCrossConnectionGet.json
 */
async function getExpressRouteCrossConnection() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const crossConnectionName = "<circuitServiceKey>";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCrossConnections.get(
    resourceGroupName,
    crossConnectionName,
  );
  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

using System;
using System.Threading.Tasks;
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/ExpressRouteCrossConnectionGet.json
// this example is just showing the usage of "ExpressRouteCrossConnections_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 ExpressRouteCrossConnectionResource created on azure
// for more information of creating ExpressRouteCrossConnectionResource, please refer to the document of ExpressRouteCrossConnectionResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
string crossConnectionName = "<circuitServiceKey>";
ResourceIdentifier expressRouteCrossConnectionResourceId = ExpressRouteCrossConnectionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, crossConnectionName);
ExpressRouteCrossConnectionResource expressRouteCrossConnection = client.GetExpressRouteCrossConnectionResource(expressRouteCrossConnectionResourceId);

// invoke the operation
ExpressRouteCrossConnectionResource result = await expressRouteCrossConnection.GetAsync();

// 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
ExpressRouteCrossConnectionData 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

Sample Response

Status code:: 200

{
  "name": "<circuitServiceKey>",
  "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>",
  "type": "Microsoft.Network/expressRouteCrossConnections",
  "location": "brazilsouth",
  "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"",
  "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 express route.
ExpressRouteCrossConnection	Risorsa ExpressRouteCrossConnection.
ExpressRouteCrossConnectionPeering	Peering in una risorsa di connessione incrociata ExpressRoute.
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 sottoresource.

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 usati 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 caso di 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à di 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 express route.

Nome	Tipo	Descrizione
id	string	ID circuito Express Route 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	Posizione di peering del circuito ExpressRoute.
properties.peerings	ExpressRouteCrossConnectionPeering[]	Elenco dei peering.
properties.primaryAzurePort	string	Nome della porta primaria.
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa di connessione incrociata della route express.
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 di risorse.
type	string	Tipo di risorsa.

ExpressRouteCrossConnectionPeering

Peering in una risorsa di connessione incrociata ExpressRoute.

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	The Azure ASN.
properties.gatewayManagerEtag	string	The GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Configurazione del peering IPv6.
properties.lastModifiedBy	string	Chi è stato l'ultimo a modificare il 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 di peering tra connessioni express route.
properties.secondaryAzurePort	string	Porta secondaria.
properties.secondaryPeerAddressPrefix	string	Prefisso dell'indirizzo secondario.
properties.sharedKey	string	Chiave condivisa.
properties.state	ExpressRoutePeeringState	Stato di 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 sottoresource.

Nome	Tipo	Descrizione
id	string	ID risorsa.