Service Tags - List

Service:

Virtual Networks

API Version:

2023-09-01

서비스 태그 정보 리소스 목록을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
location	path	True	string	버전에 대한 참조로 사용할 위치입니다(위치에 기반한 필터가 아니라 모든 지역에서 접두사 세부 정보가 있는 서비스 태그 목록을 가져올 수 있지만 구독이 속한 클라우드로 제한됨).
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	ServiceTagsListResult	요청이 성공했습니다. 서비스 태그 정보 리소스 목록을 반환합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

Get list of service tags

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/locations/westcentralus/serviceTags?api-version=2023-09-01

Java

/**
 * Samples for ServiceTags List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceTagsList.json
     */
    /**
     * Sample code: Get list of service tags.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getListOfServiceTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getServiceTags().listWithResponse("westcentralus",
            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_tags_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.service_tags.list(
        location="westcentralus",
    )
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceTagsList.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/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/ServiceTagsList.json
func ExampleServiceTagsClient_List() {
	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.NewServiceTagsClient().List(ctx, "westcentralus", 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.ServiceTagsListResult = armnetwork.ServiceTagsListResult{
	// 	Name: to.Ptr("public"),
	// 	Type: to.Ptr("Microsoft.Network/serviceTags"),
	// 	ChangeNumber: to.Ptr("63"),
	// 	Cloud: to.Ptr("Public"),
	// 	ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Network/serviceTags/public"),
	// 	Values: []*armnetwork.ServiceTagInformation{
	// 		{
	// 			Name: to.Ptr("ApiManagement"),
	// 			ID: to.Ptr("ApiManagement"),
	// 			Properties: &armnetwork.ServiceTagInformationPropertiesFormat{
	// 				AddressPrefixes: []*string{
	// 					to.Ptr("13.64.39.16/32"),
	// 					to.Ptr("40.74.146.80/31"),
	// 					to.Ptr("40.74.147.32/28")},
	// 					ChangeNumber: to.Ptr("7"),
	// 					Region: to.Ptr(""),
	// 					SystemService: to.Ptr("AzureApiManagement"),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("ApiManagement.AustraliaCentral"),
	// 				ID: to.Ptr("ApiManagement.AustraliaCentral"),
	// 				Properties: &armnetwork.ServiceTagInformationPropertiesFormat{
	// 					AddressPrefixes: []*string{
	// 						to.Ptr("20.36.106.68/31"),
	// 						to.Ptr("20.36.107.176/28")},
	// 						ChangeNumber: to.Ptr("2"),
	// 						Region: to.Ptr("australiacentral"),
	// 						SystemService: to.Ptr("AzureApiManagement"),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("AppService"),
	// 					ID: to.Ptr("AppService"),
	// 					Properties: &armnetwork.ServiceTagInformationPropertiesFormat{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("13.64.73.110/32"),
	// 							to.Ptr("191.235.208.12/32"),
	// 							to.Ptr("191.235.215.184/32")},
	// 							ChangeNumber: to.Ptr("13"),
	// 							Region: to.Ptr(""),
	// 							SystemService: to.Ptr("AzureAppService"),
	// 						},
	// 					},
	// 					{
	// 						Name: to.Ptr("ServiceBus"),
	// 						ID: to.Ptr("ServiceBus"),
	// 						Properties: &armnetwork.ServiceTagInformationPropertiesFormat{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("23.98.82.96/29"),
	// 								to.Ptr("40.68.127.68/32"),
	// 								to.Ptr("40.70.146.64/29")},
	// 								ChangeNumber: to.Ptr("10"),
	// 								Region: to.Ptr(""),
	// 								SystemService: to.Ptr("AzureServiceBus"),
	// 							},
	// 						},
	// 						{
	// 							Name: to.Ptr("ServiceBus.EastUS2"),
	// 							ID: to.Ptr("ServiceBus.EastUS2"),
	// 							Properties: &armnetwork.ServiceTagInformationPropertiesFormat{
	// 								AddressPrefixes: []*string{
	// 									to.Ptr("13.68.110.36/32"),
	// 									to.Ptr("40.70.146.64/29")},
	// 									ChangeNumber: to.Ptr("1"),
	// 									Region: to.Ptr("eastus2"),
	// 									SystemService: to.Ptr("AzureServiceBus"),
	// 								},
	// 						}},
	// 					}
}

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 a list of service tag information resources.
 *
 * @summary Gets a list of service tag information resources.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceTagsList.json
 */
async function getListOfServiceTags() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
  const location = "westcentralus";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.serviceTags.list(location);
  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

dotnet

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/ServiceTagsList.json
// this example is just showing the usage of "ServiceTags_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
AzureLocation location = new AzureLocation("westcentralus");
ServiceTagsListResult result = await subscriptionResource.GetServiceTagAsync(location);

Console.WriteLine($"Succeeded: {result}");

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": "public",
  "id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public",
  "type": "Microsoft.Network/serviceTags",
  "changeNumber": "63",
  "cloud": "Public",
  "values": [
    {
      "name": "ApiManagement",
      "id": "ApiManagement",
      "properties": {
        "changeNumber": "7",
        "region": "",
        "systemService": "AzureApiManagement",
        "addressPrefixes": [
          "13.64.39.16/32",
          "40.74.146.80/31",
          "40.74.147.32/28"
        ]
      }
    },
    {
      "name": "ApiManagement.AustraliaCentral",
      "id": "ApiManagement.AustraliaCentral",
      "properties": {
        "changeNumber": "2",
        "region": "australiacentral",
        "systemService": "AzureApiManagement",
        "addressPrefixes": [
          "20.36.106.68/31",
          "20.36.107.176/28"
        ]
      }
    },
    {
      "name": "AppService",
      "id": "AppService",
      "properties": {
        "changeNumber": "13",
        "region": "",
        "systemService": "AzureAppService",
        "addressPrefixes": [
          "13.64.73.110/32",
          "191.235.208.12/32",
          "191.235.215.184/32"
        ]
      }
    },
    {
      "name": "ServiceBus",
      "id": "ServiceBus",
      "properties": {
        "changeNumber": "10",
        "region": "",
        "systemService": "AzureServiceBus",
        "addressPrefixes": [
          "23.98.82.96/29",
          "40.68.127.68/32",
          "40.70.146.64/29"
        ]
      }
    },
    {
      "name": "ServiceBus.EastUS2",
      "id": "ServiceBus.EastUS2",
      "properties": {
        "changeNumber": "1",
        "region": "eastus2",
        "systemService": "AzureServiceBus",
        "addressPrefixes": [
          "13.68.110.36/32",
          "40.70.146.64/29"
        ]
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/serviceTags?api-version=2020-06-01&changenumber=changenumber&$skipToken={skipToken}"
}

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
ServiceTagInformation	서비스 태그 정보입니다.
ServiceTagInformationPropertiesFormat	서비스 태그 정보의 속성입니다.
ServiceTagsListResult	ListServiceTags API 서비스 호출에 대한 응답입니다.

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	클라우드 오류 본문.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
details	CloudErrorBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
target	string	특정 오류의 대상입니다. 예를 들어 오류에 있는 속성의 이름입니다.

ServiceTagInformation

서비스 태그 정보입니다.

Name	형식	Description
id	string	서비스 태그의 ID입니다.
name	string	서비스 태그의 이름입니다.
properties	ServiceTagInformationPropertiesFormat	서비스 태그 정보의 속성입니다.
serviceTagChangeNumber	string	지역에 대한 서비스 태그 개체의 반복 수입니다.

ServiceTagInformationPropertiesFormat

서비스 태그 정보의 속성입니다.

Name	형식	Description
addressPrefixes	string[]	IP 주소 접두사 목록입니다.
changeNumber	string	서비스 태그의 반복 번호입니다.
region	string	서비스 태그의 영역입니다.
state	string	서비스 태그의 상태입니다.
systemService	string	시스템 서비스의 이름입니다.

ServiceTagsListResult

ListServiceTags API 서비스 호출에 대한 응답입니다.

Name	형식	Description
changeNumber	string	반복 번호입니다.
cloud	string	클라우드의 이름입니다.
id	string	클라우드의 ID입니다.
name	string	클라우드의 이름입니다.
nextLink	string	서비스 태그 정보 리소스의 다음 페이지를 가져올 URL입니다.
type	string	Azure 리소스 종류입니다.
values	ServiceTagInformation[]	서비스 태그 정보 리소스 목록입니다.