attribute_sets

Creates, updates, deletes, gets or lists an attribute_sets resource.

Overview

Name	attribute_sets
Type	Resource
Id	entra_id.directory.attribute_sets

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
description	string	Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later.
maxAttributesPerSet	number (int32)	Maximum number of custom security attributes that can be defined in this attribute set. Default value is null. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
description	string	Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later.
maxAttributesPerSet	number (int32)	Maximum number of custom security attributes that can be defined in this attribute set. Default value is null. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	attribute_set_id		Read the properties and relationships of an attributeSet object.
list	select			Get a list of the attributeSet objects and their properties.
insert	insert			Create a new attributeSet object.
update	update	attribute_set_id		Update the properties of an attributeSet object.
delete	delete	attribute_set_id	If-Match

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
attribute_set_id	string	The unique identifier of attributeSet
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an attributeSet object.

SELECT
id,
description,
maxAttributesPerSet
FROM entra_id.directory.attribute_sets
WHERE attribute_set_id = '{{ attribute_set_id }}' -- required
;

list

Get a list of the attributeSet objects and their properties.

SELECT
id,
description,
maxAttributesPerSet
FROM entra_id.directory.attribute_sets
;

INSERT examples

insert

Create a new attributeSet object.

INSERT INTO entra_id.directory.attribute_sets (
id,
description,
maxAttributesPerSet
)
SELECT 
'{{ id }}',
'{{ description }}',
{{ maxAttributesPerSet }}
RETURNING
id,
description,
maxAttributesPerSet
;

Manifest

# Description fields are for documentation purposes
- name: attribute_sets
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later.
  - name: maxAttributesPerSet
    value: {{ maxAttributesPerSet }}
    description: |
      Maximum number of custom security attributes that can be defined in this attribute set. Default value is null. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later.

UPDATE examples

update

Update the properties of an attributeSet object.

UPDATE entra_id.directory.attribute_sets
SET 
id = '{{ id }}',
description = '{{ description }}',
maxAttributesPerSet = {{ maxAttributesPerSet }}
WHERE 
attribute_set_id = '{{ attribute_set_id }}' --required
RETURNING
id,
description,
maxAttributesPerSet;

DELETE examples

delete

No description available.

DELETE FROM entra_id.directory.attribute_sets
WHERE attribute_set_id = '{{ attribute_set_id }}' --required
AND If-Match = '{{ If-Match }}'
;