Service Tags - List

Service:

Virtual Networks

API Version:

2023-09-01

Ruft eine Liste der Diensttag-Informationsressourcen ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Der Speicherort, der als Referenz für die Version verwendet wird (nicht als Filter basierend auf dem Standort, Sie erhalten die Liste der Diensttags mit Präfixdetails in allen Regionen, aber beschränkt auf die Cloud, zu der Ihr Abonnement gehört).
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ServiceTagsListResult	Anforderung erfolgreich. Gibt eine Liste von Diensttag-Informationsressourcen zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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}"
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
ServiceTagInformation	Die Diensttaginformationen.
ServiceTagInformationPropertiesFormat	Eigenschaften der Diensttaginformationen.
ServiceTagsListResult	Antwort auf den Api-Dienstaufruf ListServiceTags.

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

ServiceTagInformation

Die Diensttaginformationen.

Name	Typ	Beschreibung
id	string	Die ID des Diensttags.
name	string	Der Name des Diensttags.
properties	ServiceTagInformationPropertiesFormat	Eigenschaften der Diensttaginformationen.
serviceTagChangeNumber	string	Die Iterationsnummer des Diensttagobjekts für region.

ServiceTagInformationPropertiesFormat

Eigenschaften der Diensttaginformationen.

Name	Typ	Beschreibung
addressPrefixes	string[]	Die Liste der IP-Adresspräfixe.
changeNumber	string	Die Iterationsnummer des Diensttags.
region	string	Die Region des Diensttags.
state	string	Der Status des Diensttags.
systemService	string	Der Name des Systemdiensts.

ServiceTagsListResult

Antwort auf den Api-Dienstaufruf ListServiceTags.

Name	Typ	Beschreibung
changeNumber	string	Die Iterationsnummer.
cloud	string	Der Name der Cloud.
id	string	Die ID der Cloud.
name	string	Der Name der Cloud.
nextLink	string	Die URL zum Abrufen der nächsten Seite der Ressourcen für Diensttaginformationen.
type	string	Der Azure-Ressourcentyp.
values	ServiceTagInformation[]	Die Liste der Diensttag-Informationsressourcen.