tags_at_scopes

Creates, updates, deletes, gets or lists a tags_at_scopes resource.

Overview

Name	tags_at_scopes
Type	Resource
Id	azure.resources.tags_at_scopes

Fields

The following fields are returned by SELECT queries:

get

Returns tags from the specified object.

Name	Datatype	Description
id	string	The ID of the tags wrapper resource.
name	string	The name of the tags wrapper resource.
properties	object	The set of tags.
type	string	The type of the tags wrapper resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope
create_or_update	insert	scope, data__properties		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.
update	update	scope		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.
delete	delete	scope

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
scope	string	The scope at which the operation is performed.

SELECT examples

get

Returns tags from the specified object.

SELECT
id,
name,
properties,
type
FROM azure.resources.tags_at_scopes
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

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.

INSERT INTO azure.resources.tags_at_scopes (
data__properties,
scope
)
SELECT 
'{{ properties }}' /* required */,
'{{ scope }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: tags_at_scopes
  props:
    - name: scope
      value: string
      description: Required parameter for the tags_at_scopes resource.
    - name: properties
      value: object
      description: |
        The set of tags.

UPDATE examples

update

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.

UPDATE azure.resources.tags_at_scopes
SET 
data__operation = '{{ operation }}',
data__properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.resources.tags_at_scopes
WHERE scope = '{{ scope }}' --required
;