azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations
name: TagsOperations
fullName: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations
module: azure.mgmt.resource.resources.v2020_10_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.resource.resources.v2020_10_01.ResourceManagementClient>'s\n\
  >\n> <xref:tags> attribute.\n>"
constructor:
  syntax: TagsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.create_or_update
  name: create_or_update
  summary: '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''.'
  signature: 'create_or_update(tag_name: str, **kwargs: Any) -> TagDetails'
  parameters:
  - name: tag_name
    description: The name of the tag to create. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: TagDetails or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagDetails>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.create_or_update_at_scope
  name: create_or_update_at_scope
  summary: '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.'
  signature: 'create_or_update_at_scope(scope: str, parameters: _models.TagsResource,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.TagsResource'
  parameters:
  - name: scope
    description: The resource scope. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: Is either a TagsResource type or a IO[bytes] type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagsResource>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: TagsResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagsResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.create_or_update_value
  name: create_or_update_value
  summary: 'Creates a predefined value for a predefined tag name.


    This operation allows adding a value to the list of predefined values for an existing

    predefined tag name. A tag value can have a maximum of 256 characters.'
  signature: 'create_or_update_value(tag_name: str, tag_value: str, **kwargs: Any)
    -> TagValue'
  parameters:
  - name: tag_name
    description: The name of the tag. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: tag_value
    description: The value of the tag to create. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: TagValue or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagValue>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.delete
  name: delete
  summary: 'Deletes a predefined tag name.


    This operation allows deleting a name from the list of predefined tag names for
    the given

    subscription. The name being deleted must not be in use as a tag name for any
    resource. All

    predefined values for the given name must have already been deleted.'
  signature: 'delete(tag_name: str, **kwargs: Any) -> None'
  parameters:
  - name: tag_name
    description: The name of the tag. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.delete_at_scope
  name: delete_at_scope
  summary: 'Deletes the entire set of tags on a resource or subscription.


    Deletes the entire set of tags on a resource or subscription.'
  signature: 'delete_at_scope(scope: str, **kwargs: Any) -> None'
  parameters:
  - name: scope
    description: The resource scope. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.delete_value
  name: delete_value
  summary: 'Deletes a predefined tag value for a predefined tag name.


    This operation allows deleting a value from the list of predefined values for
    an existing

    predefined tag name. The value being deleted must not be in use as a tag value
    for the given

    tag name for any resource.'
  signature: 'delete_value(tag_name: str, tag_value: str, **kwargs: Any) -> None'
  parameters:
  - name: tag_name
    description: The name of the tag. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: tag_value
    description: The value of the tag to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.get_at_scope
  name: get_at_scope
  summary: 'Gets the entire set of tags on a resource or subscription.


    Gets the entire set of tags on a resource or subscription.'
  signature: 'get_at_scope(scope: str, **kwargs: Any) -> TagsResource'
  parameters:
  - name: scope
    description: The resource scope. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: TagsResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagsResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.list
  name: list
  summary: '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.'
  signature: 'list(**kwargs: Any) -> Iterable[TagDetails]'
  return:
    description: An iterator like instance of either TagDetails or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.resources.v2020_10_01.models.TagDetails>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.update_at_scope
  name: update_at_scope
  summary: '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.'
  signature: 'update_at_scope(scope: str, parameters: _models.TagsPatchResource, *,
    content_type: str = ''application/json'', **kwargs: Any) -> _models.TagsResource'
  parameters:
  - name: scope
    description: The resource scope. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: Is either a TagsPatchResource type or a IO[bytes] type. Required.
    isRequired: true
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagsPatchResource>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: TagsResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.resource.resources.v2020_10_01.models.TagsResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.resources.v2020_10_01.operations.TagsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.resource.resources.v2020_10_01.models' from
    'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2020_10_01\\models\\__init__.py'>