Tags - List
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 |
---|---|---|---|---|
subscription
|
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 |
OK - Returns an array of tag names and values. |
|
Other Status Codes |
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 |
---|---|
Cloud |
An error response for a resource management request. |
Error |
The resource management error additional info. |
Error |
Error Response |
Tag |
Tag count. |
Tag |
Tag details. |
Tags |
List of subscription tags. |
Tag |
Tag information. |
CloudError
An error response for a resource management request.
Name | Type | Description |
---|---|---|
error |
Error Response |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
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 |
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 |
Tag |
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 |
An array of tags. |
TagValue
Tag information.
Name | Type | Description |
---|---|---|
count |
The tag value count. |
|
id |
string |
The tag value ID. |
tagValue |
string |
The tag value. |