settings

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

Overview

Name	settings
Type	Resource
Id	entra_id.groups.settings

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.
displayName	string	Display name of this group of settings, which comes from the associated template.
templateId	string	Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
values	array	Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
displayName	string	Display name of this group of settings, which comes from the associated template.
templateId	string	Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
values	array	Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_id, group_setting_id		Retrieve the properties of a specific group setting object. The setting can be a tenant-level or group-specific setting.
list	select	group_id		Retrieve a list of tenant-level or group-specific group settings objects.
insert	insert	group_id		Create a new group setting based on the templates available in groupSettingTemplates. These settings can be at the tenant-level or at the group level. Group settings apply to only Microsoft 365 groups. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings.
update	update	group_id, group_setting_id		Update the properties of a groupSetting object for tenant-wide group settings or a specific group setting.
delete	delete	group_id, group_setting_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
group_id	string	The unique identifier of group
group_setting_id	string	The unique identifier of groupSetting
If-Match	string	ETag

SELECT examples

get

Retrieve the properties of a specific group setting object. The setting can be a tenant-level or group-specific setting.

SELECT
id,
displayName,
templateId,
values
FROM entra_id.groups.settings
WHERE group_id = '{{ group_id }}' -- required
AND group_setting_id = '{{ group_setting_id }}' -- required
;

list

Retrieve a list of tenant-level or group-specific group settings objects.

SELECT
id,
displayName,
templateId,
values
FROM entra_id.groups.settings
WHERE group_id = '{{ group_id }}' -- required
;

INSERT examples

insert

Create a new group setting based on the templates available in groupSettingTemplates. These settings can be at the tenant-level or at the group level. Group settings apply to only Microsoft 365 groups. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings.

INSERT INTO entra_id.groups.settings (
id,
displayName,
templateId,
values,
group_id
)
SELECT 
'{{ id }}',
'{{ displayName }}',
'{{ templateId }}',
'{{ values }}',
'{{ group_id }}'
RETURNING
id,
displayName,
templateId,
values
;

Manifest

# Description fields are for documentation purposes
- name: settings
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the settings resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name of this group of settings, which comes from the associated template.
  - name: templateId
    value: "{{ templateId }}"
    description: |
      Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
  - name: values
    description: |
      Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
    value:
      - name: "{{ name }}"
        value: "{{ value }}"

UPDATE examples

update

Update the properties of a groupSetting object for tenant-wide group settings or a specific group setting.

UPDATE entra_id.groups.settings
SET 
id = '{{ id }}',
displayName = '{{ displayName }}',
templateId = '{{ templateId }}',
values = '{{ values }}'
WHERE 
group_id = '{{ group_id }}' --required
AND group_setting_id = '{{ group_setting_id }}' --required
RETURNING
id,
displayName,
templateId,
values;

DELETE examples

delete

No description available.

DELETE FROM entra_id.groups.settings
WHERE group_id = '{{ group_id }}' --required
AND group_setting_id = '{{ group_setting_id }}' --required
AND If-Match = '{{ If-Match }}'
;