Tags - Create Or Update At Scope

Creates or updates the entire set of tags on a resource or subscription.
This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.

PUT https://management.azure.com/{scope}/providers/Microsoft.Resources/tags/default?api-version=2021-04-01

URI Parameters

Name In Required Type Description
scope
path True
  • string

The resource scope.

api-version
query True
  • string

The API version to use for this operation.

Request Body

Name Required Type Description
properties True

The set of tags.

Responses

Name Type Description
200 OK

Tags updated successfully. Returns tags from the specified object.

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

Examples

Update tags on a resource
Update tags on a subscription

Update tags on a resource

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm/providers/Microsoft.Resources/tags/default?api-version=2021-04-01
{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Sample Response

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Update tags on a subscription

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/tags/default?api-version=2021-04-01
{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Sample Response

{
  "properties": {
    "tags": {
      "tagKey1": "tag-value-1",
      "tagKey2": "tag-value-2"
    }
  }
}

Definitions

CloudError

An error response for a resource management request.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

Error Response

Tags

A dictionary of name and value pairs.

TagsResource

Wrapper resource for tags API requests and responses.

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.

Tags

A dictionary of name and value pairs.

Name Type Description
tags
  • object

TagsResource

Wrapper resource for tags API requests and responses.

Name Type Description
id
  • string

The ID of the tags wrapper resource.

name
  • string

The name of the tags wrapper resource.

properties

The set of tags.

type
  • string

The type of the tags wrapper resource.