Express Route Cross Connection Peerings - Get

Referencia

Szolgáltatás:: ExpressRoute

API-verzió:: 2024-05-01

Lekéri az ExpressRouteCrossConnectionhoz megadott társviszony-létesítést.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
crossConnectionName	path	True	string	Az ExpressRouteCrossConnection neve.
peeringName	path	True	string	A társviszony-létesítés 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	ExpressRouteCrossConnectionPeering	A kérés sikeres. A művelet az eredményül kapott ExpressRouteCrossConnectionPeering erőforrást 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

GetExpressRouteCrossConnectionBgpPeering

Mintakérelem

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


/**
 * Samples for ExpressRouteCrossConnectionPeerings Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * ExpressRouteCrossConnectionBgpPeeringGet.json
     */
    /**
     * Sample code: GetExpressRouteCrossConnectionBgpPeering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCrossConnectionBgpPeering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCrossConnectionPeerings().getWithResponse(
            "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering",
            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_bgp_peering_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_connection_peerings.get(
        resource_group_name="CrossConnection-SiliconValley",
        cross_connection_name="<circuitServiceKey>",
        peering_name="AzurePrivatePeering",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.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/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/ExpressRouteCrossConnectionBgpPeeringGet.json
func ExampleExpressRouteCrossConnectionPeeringsClient_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.NewExpressRouteCrossConnectionPeeringsClient().Get(ctx, "CrossConnection-SiliconValley", "<circuitServiceKey>", "AzurePrivatePeering", 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.ExpressRouteCrossConnectionPeering = armnetwork.ExpressRouteCrossConnectionPeering{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings/AzurePrivatePeering"),
	// 	Name: to.Ptr("AzurePrivatePeering"),
	// 	Etag: to.Ptr("W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\""),
	// 	Properties: &armnetwork.ExpressRouteCrossConnectionPeeringProperties{
	// 		AzureASN: to.Ptr[int32](12076),
	// 		GatewayManagerEtag: to.Ptr(""),
	// 		IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
	// 			PrimaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::/126"),
	// 			SecondaryPeerAddressPrefix: to.Ptr("3FFE:FFFF:0:CD30::4/126"),
	// 			State: to.Ptr(armnetwork.ExpressRouteCircuitPeeringStateEnabled),
	// 		},
	// 		LastModifiedBy: to.Ptr("Customer"),
	// 		PeerASN: to.Ptr[int64](200),
	// 		PeeringType: to.Ptr(armnetwork.ExpressRoutePeeringTypeAzurePrivatePeering),
	// 		PrimaryAzurePort: to.Ptr(""),
	// 		PrimaryPeerAddressPrefix: to.Ptr("192.168.16.252/30"),
	// 		ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 		SecondaryAzurePort: to.Ptr(""),
	// 		SecondaryPeerAddressPrefix: to.Ptr("192.168.18.252/30"),
	// 		State: to.Ptr(armnetwork.ExpressRoutePeeringStateEnabled),
	// 		VlanID: to.Ptr[int32](200),
	// 	},
	// }
}

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 the specified peering for the ExpressRouteCrossConnection.
 *
 * @summary Gets the specified peering for the ExpressRouteCrossConnection.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json
 */
async function getExpressRouteCrossConnectionBgpPeering() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["NETWORK_RESOURCE_GROUP"] || "CrossConnection-SiliconValley";
  const crossConnectionName = "<circuitServiceKey>";
  const peeringName = "AzurePrivatePeering";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCrossConnectionPeerings.get(
    resourceGroupName,
    crossConnectionName,
    peeringName,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json
// this example is just showing the usage of "ExpressRouteCrossConnectionPeerings_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 ExpressRouteCrossConnectionPeeringResource created on azure
// for more information of creating ExpressRouteCrossConnectionPeeringResource, please refer to the document of ExpressRouteCrossConnectionPeeringResource
string subscriptionId = "subid";
string resourceGroupName = "CrossConnection-SiliconValley";
string crossConnectionName = "<circuitServiceKey>";
string peeringName = "AzurePrivatePeering";
ResourceIdentifier expressRouteCrossConnectionPeeringResourceId = ExpressRouteCrossConnectionPeeringResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, crossConnectionName, peeringName);
ExpressRouteCrossConnectionPeeringResource expressRouteCrossConnectionPeering = client.GetExpressRouteCrossConnectionPeeringResource(expressRouteCrossConnectionPeeringResourceId);

// invoke the operation
ExpressRouteCrossConnectionPeeringResource result = await expressRouteCrossConnectionPeering.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
ExpressRouteCrossConnectionPeeringData 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": "AzurePrivatePeering",
  "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections/<circuitServiceKey>/peerings/AzurePrivatePeering",
  "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peeringType": "AzurePrivatePeering",
    "azureASN": 12076,
    "peerASN": 200,
    "primaryPeerAddressPrefix": "192.168.16.252/30",
    "secondaryPeerAddressPrefix": "192.168.18.252/30",
    "primaryAzurePort": "",
    "secondaryAzurePort": "",
    "state": "Enabled",
    "vlanId": 200,
    "gatewayManagerEtag": "",
    "lastModifiedBy": "Customer",
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
      "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
      "state": "Enabled"
    }
  }
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	A társviszony-létesítési erőforrás meghirdetett nyilvános előtag-állapota.
ExpressRouteCircuitPeeringConfig	Megadja a társviszony-létesítési konfigurációt.
ExpressRouteCircuitPeeringState	A társviszony állapota.
ExpressRouteCrossConnectionPeering	Társviszony létesítése ExpressRoute kapcsolatközi erőforrásban.
ExpressRoutePeeringState	A társviszony állapota.
ExpressRoutePeeringType	A társviszony típusa.
Ipv6ExpressRouteCircuitPeeringConfig	IPv6 társviszony-létesítési konfigurációt tartalmaz.
ProvisioningState	Az aktuális kiépítési állapot.
SubResource	Hivatkozás egy másik alforrásra.

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.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Enumerálás

A társviszony-létesítési erőforrás meghirdetett nyilvános előtag-állapota.

Érték	Description
Configured
Configuring
NotConfigured
ValidationNeeded

ExpressRouteCircuitPeeringConfig

Objektum

Megadja a társviszony-létesítési konfigurációt.

Name	Típus	Description
advertisedCommunities	string[]	A bgp-társviszony-létesítés közösségei. Microsoft-társviszony-létesítéshez van megadva.
advertisedPublicPrefixes	string[]	A AdvertisedPublicPrefixesre mutató hivatkozás.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	A társviszony-létesítési erőforrás meghirdetett nyilvános előtag-állapota.
customerASN	integer (int32)	A társviszony-létesítés customerASN-je.
legacyMode	integer (int32)	A társviszony-létesítés örökölt módja.
routingRegistryName	string	A konfiguráció RoutingRegistryName tulajdonsága.

ExpressRouteCircuitPeeringState

Enumerálás

A társviszony állapota.

Érték	Description
Disabled
Enabled

ExpressRouteCrossConnectionPeering

Objektum

Társviszony létesítése ExpressRoute kapcsolatközi erőforrásban.

Name	Típus	Description
etag	string	Egyedi írásvédett sztring, amely az erőforrás frissítésekor változik.
id	string	Erőforrás-azonosító.
name	string	Az erőforráscsoporton belül egyedi erőforrás neve. Ez a név használható az erőforrás eléréséhez.
properties.azureASN	integer (int32)	Az Azure ASN.
properties.gatewayManagerEtag	string	A GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Az IPv6 társviszony-létesítési konfigurációja.
properties.lastModifiedBy	string	Ki módosította utoljára a társviszony-létesítést.
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A Microsoft társviszony-létesítési konfigurációja.
properties.peerASN	integer (int64) minimum: 1 maximum: 4294967295	A társ ASN-jének.
properties.peeringType	ExpressRoutePeeringType	A társviszony típusa.
properties.primaryAzurePort	string	Az elsődleges port.
properties.primaryPeerAddressPrefix	string	Az elsődleges címelőtag.
properties.provisioningState	ProvisioningState	Az expressz útvonal kapcsolatközi társviszony-létesítési erőforrásának kiépítési állapota.
properties.secondaryAzurePort	string	A másodlagos port.
properties.secondaryPeerAddressPrefix	string	A másodlagos címelőtag.
properties.sharedKey	string	A megosztott kulcs.
properties.state	ExpressRoutePeeringState	A társviszony állapota.
properties.vlanId	integer (int32)	A VLAN-azonosító.

ExpressRoutePeeringState

Enumerálás

A társviszony állapota.

Érték	Description
Disabled
Enabled

ExpressRoutePeeringType

Enumerálás

A társviszony típusa.

Érték	Description
AzurePrivatePeering
AzurePublicPeering
MicrosoftPeering

Ipv6ExpressRouteCircuitPeeringConfig

Objektum

IPv6 társviszony-létesítési konfigurációt tartalmaz.

Name	Típus	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	A Microsoft társviszony-létesítési konfigurációja.
primaryPeerAddressPrefix	string	Az elsődleges címelőtag.
routeFilter	SubResource	A RouteFilter erőforrásra mutató hivatkozás.
secondaryPeerAddressPrefix	string	A másodlagos címelőtag.
state	ExpressRouteCircuitPeeringState	A társviszony állapota.

ProvisioningState

Enumerálás

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

Érték	Description
Deleting
Failed
Succeeded
Updating

SubResource

Objektum

Hivatkozás egy másik alforrásra.

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