New-MgGroupSetting

Module:

Microsoft.Graph.Groups Module

Create a new 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.

Note

To view the beta release of this cmdlet, view New-MgBetaGroupSetting

Syntax

CreateExpanded1 (Default)

New-MgGroupSetting
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-DisplayName <String>]
    [-Id <String>]
    [-TemplateId <String>]
    [-Values <IMicrosoftGraphSettingValue[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateExpanded

New-MgGroupSetting
    -GroupId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-DisplayName <String>]
    [-Id <String>]
    [-TemplateId <String>]
    [-Values <IMicrosoftGraphSettingValue[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgGroupSetting
    -GroupId <String>
    -BodyParameter <IMicrosoftGraphGroupSetting>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentityExpanded

New-MgGroupSetting
    -InputObject <IGroupsIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-DisplayName <String>]
    [-Id <String>]
    [-TemplateId <String>]
    [-Values <IMicrosoftGraphSettingValue[]>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CreateViaIdentity

New-MgGroupSetting
    -InputObject <IGroupsIdentity>
    -BodyParameter <IMicrosoftGraphGroupSetting>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create1

New-MgGroupSetting
    -BodyParameter <IMicrosoftGraphGroupSetting>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new 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.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	Directory.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	Directory.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Groups

$params = @{
	templateId = "08d542b9-071f-4e16-94b0-74abb372e3d9"
	values = @(
		@{
			name = "AllowToAddGuests"
			value = "false"
		}
	)
}

New-MgGroupSetting -GroupId $groupId -BodyParameter $params

This example shows how to use the New-MgGroupSetting Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:	Hashtable
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-BodyParameter

groupSetting To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphGroupSetting
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Create

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

Create1

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DisplayName

Display name of this group of settings, which comes from the associated template.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-GroupId

The unique identifier of group

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Create

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	IDictionary
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	IGroupsIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateViaIdentityExpanded

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TemplateId

Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Values

Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object. To construct, see NOTES section for VALUES properties and create a hash table.

Parameter properties

Type:	IMicrosoftGraphSettingValue[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

CreateExpanded1

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CreateViaIdentityExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IGroupsIdentity

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupSetting

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupSetting

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphGroupSetting>: groupSetting

• [(Any) <Object>]: This indicates any property can be added to this object.
• [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 <IMicrosoftGraphSettingValue- []>]: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.
  • [Name <String>]: Name of the setting (as defined by the groupSettingTemplate).
  • [Value <String>]: Value of the setting.

INPUTOBJECT <IGroupsIdentity>: Identity Parameter

• [AttachmentId <String>]: The unique identifier of attachment
• [ConversationId <String>]: The unique identifier of conversation
• [ConversationThreadId <String>]: The unique identifier of conversationThread
• [DirectoryObjectId <String>]: The unique identifier of directoryObject
• [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
• [ExtensionId <String>]: The unique identifier of extension
• [GroupId <String>]: The unique identifier of group
• [GroupLifecyclePolicyId <String>]: The unique identifier of groupLifecyclePolicy
• [GroupSettingId <String>]: The unique identifier of groupSetting
• [GroupSettingTemplateId <String>]: The unique identifier of groupSettingTemplate
• [Interval <String>]: Usage: interval='{interval}'
• [ListId <String>]: Usage: listId='{listId}'
• [Path <String>]: Usage: path='{path}'
• [PostId <String>]: The unique identifier of post
• [ProfilePhotoId <String>]: The unique identifier of profilePhoto
• [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
• [SiteId <String>]: The unique identifier of site
• [StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
• [UniqueName <String>]: Alternate key of group

VALUES <IMicrosoftGraphSettingValue- []>: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced groupSettingTemplates object.

• [Name <String>]: Name of the setting (as defined by the groupSettingTemplate).
• [Value <String>]: Value of the setting.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.groups/new-mggroupsetting
• https://learn.microsoft.com/graph/api/group-post-settings?view=graph-rest-1.0