Tags - List

Service:

Resource Management

API Version:

2021-04-01

Gets a summary of tag usage under the subscription.
This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.

GET https://management.azure.com/subscriptions/{subscriptionId}/tagNames?api-version=2021-04-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	TagsListResult	OK - Returns an array of tag names and values.
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

Definitions

Name	Description
CloudError	An error response for a resource management request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	Error Response
TagCount	Tag count.
TagDetails	Tag details.
TagsListResult	List of subscription tags.
TagValue	Tag information.

CloudError

An error response for a resource management request.

Name	Type	Description
error	ErrorResponse	Error Response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorResponse

Error Response

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

TagCount

Tag count.

Name	Type	Description
type	string	Type of count.
value	integer	Value of count.

TagDetails

Tag details.

Name	Type	Description
count	TagCount	The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0.
id	string	The tag name ID.
tagName	string	The tag name.
values	TagValue[]	The list of tag values.

TagsListResult

List of subscription tags.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	TagDetails[]	An array of tags.

TagValue

Tag information.

Name	Type	Description
count	TagCount	The tag value count.
id	string	The tag value ID.
tagValue	string	The tag value.