Express Route Connections - Get

Szolgáltatás:

Virtual WAN

API-verzió:

2024-05-01

Lekéri a megadott ExpressRouteConnectiont.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
connectionName	path	True	string	Az ExpressRoute-kapcsolat neve.
expressRouteGatewayName	path	True	string	Az ExpressRoute-átjáró neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	ExpressRouteConnection	A kérés sikeres. A művelet az ExpressRouteConnectiont adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ExpressRouteConnectionGet

Mintakérelem

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

Mintaválasz

Állapotkód:

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"
      }
    }
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpressRouteCircuitPeeringId	ExpressRoute-kapcsolatcsoport társviszony-létesítési azonosítója.
ExpressRouteConnection	ExpressRouteConnection-erőforrás.
PropagatedRouteTable	A RouteTables listája, a kívánt útvonalak meghirdetéséhez.
ProvisioningState	Az aktuális kiépítési állapot.
RoutingConfiguration	Útválasztási konfiguráció, amely a kapcsolathoz társított és propagált útvonaltáblákat jelzi.
StaticRoute	Az összes statikus útvonal listája.
StaticRoutesConfig	A HubVnetConnectionConfiguration statikus útvonalainak konfigurálása ezen a HubVnetConnectionon.
SubResource	Hivatkozás egy másik alforrásra.
VnetLocalRouteOverrideCriteria	A küllős virtuális hálózat NVA-jának megkerülését meghatározó paraméter a küllős virtuális hálózaton lévő célként szolgáló forgalom esetében.
VnetRoute	A VirtualHubról a virtuális hálózati kapcsolatba való útválasztást vezérlő útvonalak listája.

CloudError

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

ExpressRouteCircuitPeeringId

Objektum

ExpressRoute-kapcsolatcsoport társviszony-létesítési azonosítója.

Name	Típus	Description
id	string	Az ExpressRoute-kapcsolatcsoport-társviszony azonosítója.

ExpressRouteConnection

Objektum

ExpressRouteConnection-erőforrás.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Az erőforrás neve.
properties.authorizationKey	string	A kapcsolat létrehozásához szükséges engedélyezési kulcs.
properties.enableInternetSecurity	boolean	Internetes biztonság engedélyezése.
properties.enablePrivateLinkFastPath	boolean	Megkerülheti az ExpressRoute-átjárót a privát kapcsolatok elérésekor. Engedélyezni kell az ExpressRoute FastPath (expressRouteGatewayBypass) használatát.
properties.expressRouteCircuitPeering	ExpressRouteCircuitPeeringId	Az ExpressRoute-kapcsolatcsoport társviszony-létesítése.
properties.expressRouteGatewayBypass	boolean	Engedélyezze a FastPath-t a vWan firewall hubhoz.
properties.provisioningState	ProvisioningState	Az express route kapcsolati erőforrás kiépítési állapota.
properties.routingConfiguration	RoutingConfiguration	A kapcsolat társított és propagált útvonaltábláinak útválasztási konfigurációja.
properties.routingWeight	integer	A kapcsolathoz társított útválasztási súly.

PropagatedRouteTable

Objektum

A RouteTables listája, a kívánt útvonalak meghirdetéséhez.

Name	Típus	Description
ids	SubResource[]	Az összes RouteTable erőforrás-azonosítójának listája.
labels	string[]	A címkék listája.

ProvisioningState

Enumerálás

Az aktuális kiépítési állapot.

Érték	Description
Deleting
Failed
Succeeded
Updating

RoutingConfiguration

Objektum

Útválasztási konfiguráció, amely a kapcsolathoz társított és propagált útvonaltáblákat jelzi.

Name	Típus	Description
associatedRouteTable	SubResource	Az útválasztás-konfigurációhoz társított RouteTable erőforrás-azonosító.
inboundRouteMap	SubResource	Az útválasztás-konfigurációhoz társított útvonaltérkép erőforrás-azonosítója a bejövő tanult útvonalakhoz.
outboundRouteMap	SubResource	Az útválasztás-konfigurációhoz társítottRouteMap erőforrás-azonosítója kimenő meghirdetett útvonalakhoz.
propagatedRouteTables	PropagatedRouteTable	A RouteTables listája, a kívánt útvonalak meghirdetéséhez.
vnetRoutes	VnetRoute	A VirtualHubról a virtuális hálózati kapcsolatba való útválasztást vezérlő útvonalak listája.

StaticRoute

Objektum

Az összes statikus útvonal listája.

Name	Típus	Description
addressPrefixes	string[]	Az összes címelőtag listája.
name	string	A VnetRoute-on belül egyedi StaticRoute neve.
nextHopIpAddress	string	A következő ugrás IP-címe.

StaticRoutesConfig

Objektum

A HubVnetConnectionConfiguration statikus útvonalainak konfigurálása ezen a HubVnetConnectionon.

Name	Típus	Description
propagateStaticRoutes	boolean	Logikai érték, amely azt jelzi, hogy a kapcsolat statikus útvonalai automatikusan propagálásra kerülnek-e az útvonaltáblákra, amelyekre a kapcsolat propagálja a kapcsolatot.
vnetLocalRouteOverrideCriteria	VnetLocalRouteOverrideCriteria	A küllős virtuális hálózat NVA-jának megkerülését meghatározó paraméter küllős forgalom esetén.

SubResource

Objektum

Hivatkozás egy másik alforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.

VnetLocalRouteOverrideCriteria

Enumerálás

A küllős virtuális hálózat NVA-jának megkerülését meghatározó paraméter a küllős virtuális hálózaton lévő célként szolgáló forgalom esetében.

Érték	Description
Contains
Equal

VnetRoute

Objektum

A VirtualHubról a virtuális hálózati kapcsolatba való útválasztást vezérlő útvonalak listája.

Name	Típus	Description
bgpConnections	SubResource[]	A HubBgpConnection objektumokra mutató hivatkozások listája.
staticRoutes	StaticRoute[]	Az összes statikus útvonal listája.
staticRoutesConfig	StaticRoutesConfig	Statikus útvonalak konfigurálása ezen a HubVnetConnectionon.