Bgp Service Communities - List

サービス:

ExpressRoute

API バージョン:

2024-05-01

使用可能なすべての bgp サービス コミュニティを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities?api-version=2024-05-01

URI パラメーター

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

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ServiceCommunityList

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities?api-version=2024-05-01

Java

/**
 * Samples for BgpServiceCommunities List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ServiceCommunityList.json
     */
    /**
     * Sample code: ServiceCommunityList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void serviceCommunityList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getBgpServiceCommunities().list(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 service_community_list.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.bgp_service_communities.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ServiceCommunityList.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/ServiceCommunityList.json
func ExampleBgpServiceCommunitiesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewBgpServiceCommunitiesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BgpServiceCommunityListResult = armnetwork.BgpServiceCommunityListResult{
		// 	Value: []*armnetwork.BgpServiceCommunity{
		// 		{
		// 			Name: to.Ptr("skype"),
		// 			Type: to.Ptr("Microsoft.Network/bgpServiceCommunities"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/skype"),
		// 			Properties: &armnetwork.BgpServiceCommunityPropertiesFormat{
		// 				BgpCommunities: []*armnetwork.BGPCommunity{
		// 					{
		// 						CommunityName: to.Ptr("Skype For Business Online"),
		// 						CommunityPrefixes: []*string{
		// 							to.Ptr("13.67.56.225/32"),
		// 							to.Ptr("13.67.186.105/32")},
		// 							CommunityValue: to.Ptr("12076:5030"),
		// 							IsAuthorizedToUse: to.Ptr(true),
		// 							ServiceGroup: to.Ptr("O365"),
		// 							ServiceSupportedRegion: to.Ptr("Global"),
		// 					}},
		// 					ServiceName: to.Ptr("skype"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("exchange"),
		// 				Type: to.Ptr("Microsoft.Network/bgpServiceCommunities"),
		// 				ID: to.Ptr("/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/exchange"),
		// 				Properties: &armnetwork.BgpServiceCommunityPropertiesFormat{
		// 					BgpCommunities: []*armnetwork.BGPCommunity{
		// 						{
		// 							CommunityName: to.Ptr("Exchange Online"),
		// 							CommunityPrefixes: []*string{
		// 								to.Ptr("13.67.56.225/32"),
		// 								to.Ptr("13.67.186.105/32")},
		// 								CommunityValue: to.Ptr("12076:5040"),
		// 								IsAuthorizedToUse: to.Ptr(true),
		// 								ServiceGroup: to.Ptr("O365"),
		// 								ServiceSupportedRegion: to.Ptr("Global"),
		// 						}},
		// 						ServiceName: to.Ptr("exchange"),
		// 					},
		// 			}},
		// 		}
	}
}

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 all the available bgp service communities.
 *
 * @summary Gets all the available bgp service communities.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ServiceCommunityList.json
 */
async function serviceCommunityList() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.bgpServiceCommunities.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ServiceCommunityList.json
// this example is just showing the usage of "BgpServiceCommunities_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (BgpServiceCommunity item in subscriptionResource.GetBgpServiceCommunitiesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/skype",
      "name": "skype",
      "type": "Microsoft.Network/bgpServiceCommunities",
      "properties": {
        "serviceName": "skype",
        "bgpCommunities": [
          {
            "serviceSupportedRegion": "Global",
            "communityName": "Skype For Business Online",
            "communityValue": "12076:5030",
            "communityPrefixes": [
              "13.67.56.225/32",
              "13.67.186.105/32"
            ],
            "isAuthorizedToUse": true,
            "serviceGroup": "O365"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/exchange",
      "name": "exchange",
      "type": "Microsoft.Network/bgpServiceCommunities",
      "properties": {
        "serviceName": "exchange",
        "bgpCommunities": [
          {
            "serviceSupportedRegion": "Global",
            "communityName": "Exchange Online",
            "communityValue": "12076:5040",
            "communityPrefixes": [
              "13.67.56.225/32",
              "13.67.186.105/32"
            ],
            "isAuthorizedToUse": true,
            "serviceGroup": "O365"
          }
        ]
      }
    }
  ]
}

定義

名前	説明
BGPCommunity	Service Community リソースで提供される bgp コミュニティ情報が含まれています。
BgpServiceCommunity	サービス コミュニティのプロパティ。
BgpServiceCommunityListResult	ListServiceCommunity API サービス呼び出しの応答。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。

BGPCommunity

Object

Service Community リソースで提供される bgp コミュニティ情報が含まれています。

名前	型	説明
communityName	string	bgp コミュニティの名前。 Skype など。
communityPrefixes	string[]	bgp コミュニティに含まれるプレフィックス。
communityValue	string	bgp コミュニティの値。 詳細については、https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routingを参照してください。
isAuthorizedToUse	boolean	お客様は bgp コミュニティを使用する権限を持っています。
serviceGroup	string	bgp コミュニティのサービス グループに含まれています。
serviceSupportedRegion	string	サービスがサポートするリージョン。 たとえば、O365 の場合、リージョンはグローバルです。

BgpServiceCommunity

Object

サービス コミュニティのプロパティ。

名前	型	説明
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.bgpCommunities	BGPCommunity[]	bgp コミュニティの一覧。
properties.serviceName	string	bgp コミュニティの名前。 Skype など。
tags	object	リソース タグ。
type	string	リソースの種類。

BgpServiceCommunityListResult

Object

ListServiceCommunity API サービス呼び出しの応答。

名前	型	説明
nextLink	string	次の結果セットを取得する URL。
value	BgpServiceCommunity[]	サービス コミュニティ リソースの一覧。

CloudError

Object

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

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

CloudErrorBody

Object

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

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