Express Route Circuit Peerings - Get

リファレンス

サービス:: ExpressRoute

API バージョン:: 2024-05-01

高速ルート回線の指定されたピアリングを取得します。

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

URI パラメーター

名前	/	必須	型	説明
circuitName	path	True	string	Express Route 回線の名前。
peeringName	path	True	string	ピアリングの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	ExpressRouteCircuitPeering	要求が成功しました。この操作は、結果の ExpressRouteCircuitPeering リソースを返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get ExpressRouteCircuit Peering

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering?api-version=2024-05-01


/**
 * Samples for ExpressRouteCircuitPeerings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCircuitPeeringGet
     * .json
     */
    /**
     * Sample code: Get ExpressRouteCircuit Peering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getExpressRouteCircuitPeering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getExpressRouteCircuitPeerings().getWithResponse("rg1",
            "circuitName", "MicrosoftPeering", 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_circuit_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_circuit_peerings.get(
        resource_group_name="rg1",
        circuit_name="circuitName",
        peering_name="MicrosoftPeering",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCircuitPeeringGet.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/ExpressRouteCircuitPeeringGet.json
func ExampleExpressRouteCircuitPeeringsClient_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.NewExpressRouteCircuitPeeringsClient().Get(ctx, "rg1", "circuitName", "MicrosoftPeering", 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.ExpressRouteCircuitPeering = armnetwork.ExpressRouteCircuitPeering{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering"),
	// 	Name: to.Ptr("MicrosoftPeering"),
	// 	Type: to.Ptr("Microsoft.Network/expressRouteCircuits/peerings"),
	// 	Etag: to.Ptr("W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\""),
	// 	Properties: &armnetwork.ExpressRouteCircuitPeeringPropertiesFormat{
	// 		AzureASN: to.Ptr[int32](12076),
	// 		GatewayManagerEtag: to.Ptr("103"),
	// 		IPv6PeeringConfig: &armnetwork.IPv6ExpressRouteCircuitPeeringConfig{
	// 			MicrosoftPeeringConfig: &armnetwork.ExpressRouteCircuitPeeringConfig{
	// 				AdvertisedCommunities: []*string{
	// 				},
	// 				AdvertisedPublicPrefixes: []*string{
	// 					to.Ptr("3FFE:FFFF:0:CD31::/120")},
	// 					AdvertisedPublicPrefixesState: to.Ptr(armnetwork.ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded),
	// 					CustomerASN: to.Ptr[int32](23),
	// 					LegacyMode: to.Ptr[int32](0),
	// 					RoutingRegistryName: to.Ptr("ARIN"),
	// 				},
	// 				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"),
	// 			MicrosoftPeeringConfig: &armnetwork.ExpressRouteCircuitPeeringConfig{
	// 				AdvertisedCommunities: []*string{
	// 				},
	// 				AdvertisedPublicPrefixes: []*string{
	// 					to.Ptr("123.1.0.0/24")},
	// 					AdvertisedPublicPrefixesState: to.Ptr(armnetwork.ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded),
	// 					CustomerASN: to.Ptr[int32](23),
	// 					LegacyMode: to.Ptr[int32](0),
	// 					RoutingRegistryName: to.Ptr("ARIN"),
	// 				},
	// 				PeerASN: to.Ptr[int64](100),
	// 				PeeringType: to.Ptr(armnetwork.ExpressRoutePeeringTypeMicrosoftPeering),
	// 				PrimaryAzurePort: to.Ptr("A51-TEST-06GMR-CIS-1-PRI-A"),
	// 				PrimaryPeerAddressPrefix: to.Ptr("123.0.0.0/30"),
	// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 				RouteFilter: &armnetwork.SubResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName"),
	// 				},
	// 				SecondaryAzurePort: to.Ptr("A51-TEST-06GMR-CIS-2-SEC-A"),
	// 				SecondaryPeerAddressPrefix: to.Ptr("123.0.0.4/30"),
	// 				State: to.Ptr(armnetwork.ExpressRoutePeeringStateEnabled),
	// 				VlanID: to.Ptr[int32](300),
	// 			},
	// 		}
}

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 express route circuit.
 *
 * @summary Gets the specified peering for the express route circuit.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ExpressRouteCircuitPeeringGet.json
 */
async function getExpressRouteCircuitPeering() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const circuitName = "circuitName";
  const peeringName = "MicrosoftPeering";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.expressRouteCircuitPeerings.get(
    resourceGroupName,
    circuitName,
    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/ExpressRouteCircuitPeeringGet.json
// this example is just showing the usage of "ExpressRouteCircuitPeerings_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 ExpressRouteCircuitPeeringResource created on azure
// for more information of creating ExpressRouteCircuitPeeringResource, please refer to the document of ExpressRouteCircuitPeeringResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string circuitName = "circuitName";
string peeringName = "MicrosoftPeering";
ResourceIdentifier expressRouteCircuitPeeringResourceId = ExpressRouteCircuitPeeringResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, circuitName, peeringName);
ExpressRouteCircuitPeeringResource expressRouteCircuitPeering = client.GetExpressRouteCircuitPeeringResource(expressRouteCircuitPeeringResourceId);

// invoke the operation
ExpressRouteCircuitPeeringResource result = await expressRouteCircuitPeering.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
ExpressRouteCircuitPeeringData 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

応答のサンプル

状態コード:: 200

{
  "name": "MicrosoftPeering",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering",
  "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"",
  "properties": {
    "provisioningState": "Succeeded",
    "peeringType": "MicrosoftPeering",
    "azureASN": 12076,
    "peerASN": 100,
    "primaryPeerAddressPrefix": "123.0.0.0/30",
    "secondaryPeerAddressPrefix": "123.0.0.4/30",
    "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A",
    "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A",
    "state": "Enabled",
    "vlanId": 300,
    "gatewayManagerEtag": "103",
    "lastModifiedBy": "Customer",
    "microsoftPeeringConfig": {
      "advertisedPublicPrefixes": [
        "123.1.0.0/24"
      ],
      "advertisedCommunities": [],
      "advertisedPublicPrefixesState": "ValidationNeeded",
      "customerASN": 23,
      "legacyMode": 0,
      "routingRegistryName": "ARIN"
    },
    "ipv6PeeringConfig": {
      "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126",
      "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126",
      "state": "Enabled",
      "microsoftPeeringConfig": {
        "advertisedPublicPrefixes": [
          "3FFE:FFFF:0:CD31::/120"
        ],
        "advertisedCommunities": [],
        "advertisedPublicPrefixesState": "ValidationNeeded",
        "customerASN": 23,
        "legacyMode": 0,
        "routingRegistryName": "ARIN"
      }
    },
    "routeFilter": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName"
    }
  },
  "type": "Microsoft.Network/expressRouteCircuits/peerings"
}

定義

名前	説明
CircuitConnectionStatus	Express Route 回線の接続状態。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
ExpressRouteCircuitConnection	ExpressRouteCircuitPeering リソースの ExpressRoute 回線接続。
ExpressRouteCircuitPeering	ExpressRouteCircuit リソース内のピアリング。
ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	ピアリングリソースのアドバタイズされたパブリックプレフィックスの状態。
ExpressRouteCircuitPeeringConfig	ピアリング構成を指定します。
ExpressRouteCircuitPeeringState	ピアリングの状態。
ExpressRouteCircuitStats	ピアリングに関連付けられている統計が含まれています。
ExpressRouteConnectionId	ExpressRouteConnection の ID。
ExpressRoutePeeringState	ピアリングの状態。
ExpressRoutePeeringType	ピアリングの種類。
Ipv6CircuitConnectionConfig	グローバルリーチの IPv6 回線接続プロパティ。
Ipv6ExpressRouteCircuitPeeringConfig	IPv6 ピアリング構成が含まれています。
PeerExpressRouteCircuitConnection	ExpressRouteCircuitPeering リソースのピア Express Route 回線接続。
ProvisioningState	現在のプロビジョニング状態。
SubResource	別のサブリソースへの参照。

CircuitConnectionStatus

列挙

Express Route 回線の接続状態。

値	説明
Connected
Connecting
Disconnected

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

Object

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

ExpressRouteCircuitConnection

Object

ExpressRouteCircuitPeering リソースの ExpressRoute 回線接続。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.addressPrefix	string	/29 IP アドレス空間を使用して、トンネルの顧客アドレスを切り開きます。
properties.authorizationKey	string	承認キー。
properties.circuitConnectionStatus	CircuitConnectionStatus	Express Route 回線の接続状態。
properties.expressRouteCircuitPeering	SubResource	回線開始接続の Express Route 回線プライベートピアリングリソースへの参照。
properties.ipv6CircuitConnectionConfig	Ipv6CircuitConnectionConfig	高速ルート回線接続の IPv6 アドレス PrefixProperties。
properties.peerExpressRouteCircuitPeering	SubResource	ピアリングされた回線の Express Route 回線プライベートピアリングリソースへの参照。
properties.provisioningState	ProvisioningState	Express Route 回線接続リソースのプロビジョニング状態。
type	string	リソースの種類。

ExpressRouteCircuitPeering

Object

ExpressRouteCircuit リソース内のピアリング。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.azureASN	integer (int32)	Azure ASN。
properties.connections	ExpressRouteCircuitConnection[]	この回線の Azure プライベートピアリングに関連付けられている回線接続の一覧。
properties.expressRouteConnection	ExpressRouteConnectionId	ExpressRoute 接続。
properties.gatewayManagerEtag	string	GatewayManager Etag。
properties.ipv6PeeringConfig	Ipv6ExpressRouteCircuitPeeringConfig	IPv6 ピアリング構成。
properties.lastModifiedBy	string	ピアリングを最後に変更したユーザー。
properties.microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Microsoft ピアリングの構成。
properties.peerASN	integer (int64) minimum: 1 maximum: 4294967295	ピア ASN。
properties.peeredConnections	PeerExpressRouteCircuitConnection[]	この回線の Azure プライベートピアリングに関連付けられているピアリング回線接続の一覧。
properties.peeringType	ExpressRoutePeeringType	ピアリングの種類。
properties.primaryAzurePort	string	プライマリポート。
properties.primaryPeerAddressPrefix	string	プライマリアドレスプレフィックス。
properties.provisioningState	ProvisioningState	Express Route 回線ピアリングリソースのプロビジョニング状態。
properties.routeFilter	SubResource	RouteFilter リソースへの参照。
properties.secondaryAzurePort	string	セカンダリポート。
properties.secondaryPeerAddressPrefix	string	セカンダリアドレスプレフィックス。
properties.sharedKey	string	共有キー。
properties.state	ExpressRoutePeeringState	ピアリングの状態。
properties.stats	ExpressRouteCircuitStats	Express Route 回線のピアリング統計。
properties.vlanId	integer (int32)	VLAN ID。
type	string	リソースの種類。

ExpressRouteCircuitPeeringAdvertisedPublicPrefixState

列挙

ピアリングリソースのアドバタイズされたパブリックプレフィックスの状態。

値	説明
Configured
Configuring
NotConfigured
ValidationNeeded

ExpressRouteCircuitPeeringConfig

Object

ピアリング構成を指定します。

名前	型	説明
advertisedCommunities	string[]	bgp ピアリングのコミュニティ。 Microsoft ピアリングに指定します。
advertisedPublicPrefixes	string[]	AdvertisedPublicPrefixes への参照。
advertisedPublicPrefixesState	ExpressRouteCircuitPeeringAdvertisedPublicPrefixState	ピアリングリソースのアドバタイズされたパブリックプレフィックスの状態。
customerASN	integer (int32)	ピアリングの CustomerASN。
legacyMode	integer (int32)	ピアリングのレガシモード。
routingRegistryName	string	構成の RoutingRegistryName。

ExpressRouteCircuitPeeringState

列挙

ピアリングの状態。

値	説明
Disabled
Enabled

ExpressRouteCircuitStats

Object

ピアリングに関連付けられている統計が含まれています。

名前	型	説明
primarybytesIn	integer (int64)	ピアリングのプライマリ BytesIn。
primarybytesOut	integer (int64)	ピアリングのプライマリ BytesOut。
secondarybytesIn	integer (int64)	ピアリングのセカンダリ BytesIn。
secondarybytesOut	integer (int64)	ピアリングのセカンダリ BytesOut。

ExpressRouteConnectionId

Object

ExpressRouteConnection の ID。

名前	型	説明
id	string	ExpressRouteConnection の ID。

ExpressRoutePeeringState

列挙

ピアリングの状態。

値	説明
Disabled
Enabled

ExpressRoutePeeringType

列挙

ピアリングの種類。

値	説明
AzurePrivatePeering
AzurePublicPeering
MicrosoftPeering

Ipv6CircuitConnectionConfig

Object

グローバルリーチの IPv6 回線接続プロパティ。

名前	型	説明
addressPrefix	string	/125 IP アドレス空間を使用して、グローバルにアクセスできるように顧客のアドレスを切り開きます。
circuitConnectionStatus	CircuitConnectionStatus	Express Route 回線の接続状態。

Ipv6ExpressRouteCircuitPeeringConfig

Object

IPv6 ピアリング構成が含まれています。

名前	型	説明
microsoftPeeringConfig	ExpressRouteCircuitPeeringConfig	Microsoft ピアリングの構成。
primaryPeerAddressPrefix	string	プライマリアドレスプレフィックス。
routeFilter	SubResource	RouteFilter リソースへの参照。
secondaryPeerAddressPrefix	string	セカンダリアドレスプレフィックス。
state	ExpressRouteCircuitPeeringState	ピアリングの状態。

PeerExpressRouteCircuitConnection

Object

ExpressRouteCircuitPeering リソースのピア Express Route 回線接続。

名前	型	説明
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソース ID。
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.addressPrefix	string	/29 IP アドレス空間を使用して、トンネルの顧客アドレスを切り開きます。
properties.authResourceGuid	string	Express Route 回線接続に使用される承認のリソース GUID。
properties.circuitConnectionStatus	CircuitConnectionStatus	Express Route 回線の接続状態。
properties.connectionName	string	Express Route 回線接続リソースの名前。
properties.expressRouteCircuitPeering	SubResource	回線の Express Route 回線プライベートピアリングリソースへの参照。
properties.peerExpressRouteCircuitPeering	SubResource	ピアリングされた回線の Express Route 回線プライベートピアリングリソースへの参照。
properties.provisioningState	ProvisioningState	ピア Express ルート回線接続リソースのプロビジョニング状態。
type	string	リソースの種類。

ProvisioningState

列挙

現在のプロビジョニング状態。

値	説明
Deleting
Failed
Succeeded
Updating

SubResource

Object

別のサブリソースへの参照。

名前	型	説明
id	string	リソース ID。