Service Tags - List

Reference

Service:: Virtual Networks

API Version:: 2024-05-01

Gets a list of service tag information resources.

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

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to).
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ServiceTagsListResult	Request successful. Returns a list of service tag information resources.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

Get list of service tags

Sample request

HTTP

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

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

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ServiceTagInformation	The service tag information.
ServiceTagInformationPropertiesFormat	Properties of the service tag information.
ServiceTagsListResult	Response for the ListServiceTags API service call.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ServiceTagInformation

The service tag information.

Name	Type	Description
id	string	The ID of service tag.
name	string	The name of service tag.
properties	ServiceTagInformationPropertiesFormat	Properties of the service tag information.
serviceTagChangeNumber	string	The iteration number of service tag object for region.

ServiceTagInformationPropertiesFormat

Properties of the service tag information.

Name	Type	Description
addressPrefixes	string[]	The list of IP address prefixes.
changeNumber	string	The iteration number of service tag.
region	string	The region of service tag.
state	string	The state of the service tag.
systemService	string	The name of system service.

ServiceTagsListResult

Response for the ListServiceTags API service call.

Name	Type	Description
changeNumber	string	The iteration number.
cloud	string	The name of the cloud.
id	string	The ID of the cloud.
name	string	The name of the cloud.
nextLink	string	The URL to get next page of service tag information resources.
type	string	The azure resource type.
values	ServiceTagInformation[]	The list of service tag information resources.

Share via