Express Route Cross Connection Peerings - Get

Reference

Service:: ExpressRoute

API Version:: 2023-09-01

Získá zadaný partnerský vztah pro ExpressRouteCrossConnection.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
crossConnectionName	path	True	string	Název ExpressRouteCrossConnection.
peeringName	path	True	string	Název partnerského vztahu.
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze klientského rozhraní API

Odpovědi

Name	Typ	Description
200 OK	ExpressRouteCrossConnectionPeering	Žádost byla úspěšná. Operace vrátí výsledný prostředek ExpressRouteCrossConnectionPeering.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetExpressRouteCrossConnectionBgpPeering

Sample Request

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


/**
 * Samples for ExpressRouteCrossConnectionPeerings Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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/2023-09-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/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/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/2023-09-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 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;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-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

Sample Response

Status code:: 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"
    }
  }
}

Definice

Name	Description
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Inzerovaný stav veřejné předpony prostředku peeringu.
ExpressRouteCircuitPeeringConfig	Určuje konfiguraci partnerského vztahu.
ExpressRouteCircuitPeeringState	Stav partnerského vztahu.
ExpressRouteCrossConnectionPeering	Partnerský vztah v prostředku ExpressRoute křížového připojení
ExpressRoutePeeringState	Stav partnerského vztahu.
ExpressRoutePeeringType	Typ partnerského vztahu.
Ipv6ExpressRouteCircuitPeeringConfig	Obsahuje konfiguraci partnerského vztahu IPv6.
ProvisioningState	Aktuální stav zřizování.
SubResource	Odkaz na jiný dílčí zdroj.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

Inzerovaný stav veřejné předpony prostředku peeringu.

Name	Typ	Description
Configured	string
Configuring	string
NotConfigured	string
ValidationNeeded	string

ExpressRouteCircuitPeeringConfig

Určuje konfiguraci partnerského vztahu.

Name	Typ	Description
advertisedCommunities	string[]	Komunity bgp peeringu. Určuje se pro partnerský vztah Microsoftu.
advertisedPublicPrefixes	string[]	Odkaz na AdvertisedPublicPrefixes.
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	Inzerovaný stav veřejné předpony prostředku peeringu.
customerASN	integer	CustomerASN partnerského vztahu.
legacyMode	integer	Starší režim partnerského vztahu.
routingRegistryName	string	RoutingRegistryName konfigurace.

ExpressRouteCircuitPeeringState

Stav partnerského vztahu.

Name	Typ	Description
Disabled	string
Enabled	string

ExpressRouteCrossConnectionPeering

Partnerský vztah v prostředku ExpressRoute křížového připojení

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se mění při každé aktualizaci prostředku.
id	string	ID prostředku.
name	string	Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název se dá použít pro přístup k prostředku.
properties.azureASN	integer	The Azure ASN.
properties.gatewayManagerEtag	string	Značka GatewayManager Etag.
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	Konfigurace partnerského vztahu IPv6.
properties.lastModifiedBy	string	Kdo byl poslední, kdo změnil partnerský vztah?
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Konfigurace partnerského vztahu Microsoftu
properties.peerASN	integer	Partnerské asn.
properties.peeringType	ExpressRoutePeeringType	Typ partnerského vztahu.
properties.primaryAzurePort	string	Primární port.
properties.primaryPeerAddressPrefix	string	Předpona primární adresy.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku peeringu mezi připojeními Express Route.
properties.secondaryAzurePort	string	Sekundární port.
properties.secondaryPeerAddressPrefix	string	Předpona sekundární adresy.
properties.sharedKey	string	Sdílený klíč.
properties.state	ExpressRoutePeeringState	Stav partnerského vztahu.
properties.vlanId	integer	ID sítě VLAN.

ExpressRoutePeeringState

Stav partnerského vztahu.

Name	Typ	Description
Disabled	string
Enabled	string

ExpressRoutePeeringType

Typ partnerského vztahu.

Name	Typ	Description
AzurePrivatePeering	string
AzurePublicPeering	string
MicrosoftPeering	string

Ipv6ExpressRouteCircuitPeeringConfig

Obsahuje konfiguraci partnerského vztahu IPv6.

Name	Typ	Description
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Konfigurace partnerského vztahu Microsoftu
primaryPeerAddressPrefix	string	Předpona primární adresy.
routeFilter	SubResource	Odkaz na prostředek RouteFilter.
secondaryPeerAddressPrefix	string	Předpona sekundární adresy.
state	ExpressRouteCircuitPeeringState	Stav partnerského vztahu.

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

SubResource

Odkaz na jiný dílčí zdroj.

Name	Typ	Description
id	string	ID prostředku.