Update-MgGroupSetting

Module:

Microsoft.Graph.Groups

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

Note

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

Syntax

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

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

Update-MgGroupSetting
      -GroupId <String>
      -GroupSettingId <String>
      -BodyParameter <IMicrosoftGraphGroupSetting>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgGroupSetting
      -GroupSettingId <String>
      -BodyParameter <IMicrosoftGraphGroupSetting>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

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

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

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

Description

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

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Groups

$params = @{
	values = @(
		@{
			name = "AllowToAddGuests"
			value = "true"
		}
	)
}

Update-MgGroupSetting -GroupId $groupId -GroupSettingId $groupSettingId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

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

Type:	IMicrosoftGraphGroupSetting
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupId

The unique identifier of group

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupSettingId

The unique identifier of groupSetting

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

The unique identifier for an entity. Read-only.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	IGroupsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TemplateId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	IMicrosoftGraphSettingValue[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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
• [BaseSitePageId <String>]: The unique identifier of baseSitePage
• [ContentTypeId <String>]: The unique identifier of contentType
• [ConversationId <String>]: The unique identifier of conversation
• [ConversationThreadId <String>]: The unique identifier of conversationThread
• [DirectoryObjectId <String>]: The unique identifier of directoryObject
• [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
• [DriveId <String>]: The unique identifier of drive
• [DriveItemId <String>]: The unique identifier of driveItem
• [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
• [EndDateTime <String>]: Usage: endDateTime='{endDateTime}'
• [EventId <String>]: The unique identifier of event
• [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
• [HorizontalSectionColumnId <String>]: The unique identifier of horizontalSectionColumn
• [HorizontalSectionId <String>]: The unique identifier of horizontalSection
• [IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks}
• [Interval <String>]: Usage: interval='{interval}'
• [ListId <String>]: The unique identifier of list
• [ListItemId <String>]: The unique identifier of listItem
• [ListItemVersionId <String>]: The unique identifier of listItemVersion
• [NotebookId <String>]: The unique identifier of notebook
• [OnenotePageId <String>]: The unique identifier of onenotePage
• [OnenoteSectionId <String>]: The unique identifier of onenoteSection
• [Path <String>]: Usage: path='{path}'
• [PermissionId <String>]: The unique identifier of permission
• [PostId <String>]: The unique identifier of post
• [ProfilePhotoId <String>]: The unique identifier of profilePhoto
• [Q <String>]: Usage: q='{q}'
• [ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant
• [SiteId <String>]: The unique identifier of site
• [StartDateTime <String>]: Usage: startDateTime='{startDateTime}'
• [SubscriptionId <String>]: The unique identifier of subscription
• [Token <String>]: Usage: token='{token}'
• [UniqueName <String>]: Alternate key of group
• [User <String>]: Usage: User='{User}'
• [WebPartId <String>]: The unique identifier of webPart

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/update-mggroupsetting
• https://learn.microsoft.com/graph/api/groupsetting-update?view=graph-rest-1.0