Bgp Service Communities - List

Başvuru

Service:: ExpressRoute

API Version:: 2023-09-01

Tüm kullanılabilir BGP hizmet topluluklarını alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	BgpServiceCommunityListResult	İstek başarılı oldu. İşlem, BgpServiceCommunity kaynaklarının listesini döndürür.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ServiceCommunityList

Sample Request

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


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

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/2023-09-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

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/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

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/2023-09-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

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

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

Sample Response

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

Tanımlar

Name	Description
BGPCommunity	Hizmet Topluluğu kaynaklarında sunulan bgp topluluk bilgilerini içerir.
BgpServiceCommunity	Hizmet Topluluğu Özellikleri.
BgpServiceCommunityListResult	ListServiceCommunity API hizmet çağrısı için yanıt.
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.

BGPCommunity

Hizmet Topluluğu kaynaklarında sunulan bgp topluluk bilgilerini içerir.

Name	Tür	Description
communityName	string	bgp topluluğunun adı. Örneğin, Skype.
communityPrefixes	string[]	bgp topluluğunun içerdiği ön ekler.
communityValue	string	bgp topluluğunun değeri. Daha fazla bilgi için: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing.
isAuthorizedToUse	boolean	Müşteri bgp topluluğu kullanma yetkisine sahip veya değil.
serviceGroup	string	bgp topluluğunun hizmet grubu içerir.
serviceSupportedRegion	string	Hizmetin desteklediği bölge. Örneğin, O365 için bölge Genel'dir.

BgpServiceCommunity

Hizmet Topluluğu Özellikleri.

Name	Tür	Description
id	string	Kaynak Kimliği.
location	string	Kaynak konumu.
name	string	Kaynak adı.
properties.bgpCommunities	BGPCommunity[]	BGP topluluklarının listesi.
properties.serviceName	string	bgp topluluğunun adı. Örneğin, Skype.
tags	object	Kaynak etiketleri.
type	string	Kaynak türü.

BgpServiceCommunityListResult

ListServiceCommunity API hizmet çağrısı için yanıt.

Name	Tür	Description
nextLink	string	Sonraki sonuç kümesini almak için URL.
value	BgpServiceCommunity[]	Hizmet topluluğu kaynaklarının listesi.

CloudError

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Bulut hata gövdesi.

CloudErrorBody

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.