Tags - Create Or Update

Creates a predefined tag name.
This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The Microsoft Azure subscription ID.

tagName
path True
  • string

The name of the tag to create.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Predefined tag name already exists. Returns information about the predefined tag name.

201 Created

Predefined tag name successfully created. Returns information about the predefined tag name.

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

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.

TagValue

Tag information.

CloudError

An error response for a resource management request.

Name Type Description
error

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

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

The list of tag values.

TagValue

Tag information.

Name Type Description
count

The tag value count.

id
  • string

The tag value ID.

tagValue
  • string

The tag value.