Tags - Update At Scope
Selectively updates the set of tags on a resource or subscription.
This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
PATCH 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 | Type | Description |
---|---|---|
operation |
The operation type for the patch API. |
|
properties |
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 |
Definitions
Name | Description |
---|---|
Cloud |
An error response for a resource management request. |
Error |
The resource management error additional info. |
Error |
Error Response |
Tags |
A dictionary of name and value pairs. |
tags |
The operation type for the patch API. |
Tags |
Wrapper resource for tags patch API request only. |
Tags |
Wrapper resource for tags API requests and responses. |
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. |
Tags
A dictionary of name and value pairs.
Name | Type | Description |
---|---|---|
tags |
object |
tagsPatchOperation
The operation type for the patch API.
Name | Type | Description |
---|---|---|
Delete |
string |
The 'delete' option allows selectively deleting tags based on given names or name/value pairs. |
Merge |
string |
The 'merge' option allows adding tags with new names and updating the values of tags with existing names. |
Replace |
string |
The 'replace' option replaces the entire set of existing tags with a new set. |
TagsPatchResource
Wrapper resource for tags patch API request only.
Name | Type | Description |
---|---|---|
operation |
The operation type for the patch API. |
|
properties |
The set of tags. |
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. |