New-MgBetaDirectorySetting

Module:

Microsoft.Graph.Beta.Identity.DirectoryManagement Module

Create a new setting based on the templates available in directorySettingTemplates. 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.

Syntax

CreateExpanded (Default)

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

Create

New-MgBetaDirectorySetting
    -BodyParameter <IMicrosoftGraphDirectorySetting>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Create a new setting based on the templates available in directorySettingTemplates. 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: Create a directory or tenant-level setting

Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	templateId = "62375ab9-6b52-47ed-826b-58e47e0e304b"
	values = @(
		@{
			name = "GuestUsageGuidelinesUrl"
			value = "https://privacy.contoso.com/privacystatement"
		}
		@{
			name = "EnableMSStandardBlockedWords"
			value = "true"
		}
		@{
			name = "EnableMIPLabels"
			value = "true"
		}
		@{
			name = "PrefixSuffixNamingRequirement"
			value = "[Contoso-][GroupName]"
		}
	)
}

New-MgBetaDirectorySetting -BodyParameter $params

This example will create a directory or tenant-level setting

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

CreateExpanded

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

-BodyParameter

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

Parameter properties

Type:	IMicrosoftGraphDirectorySetting
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

-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. Read-only.

Parameter properties

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

Parameter sets

CreateExpanded

Position:	Named
Mandatory:	False
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

CreateExpanded

Position:	Named
Mandatory:	False
Value from pipeline:	False
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 template used to create this group of settings. Read-only.

Parameter properties

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

Parameter sets

CreateExpanded

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 directorySettingTemplates 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

CreateExpanded

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.Beta.PowerShell.Models.IMicrosoftGraphDirectorySetting

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphDirectorySetting

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 <IMicrosoftGraphDirectorySetting>: directorySetting

• [(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. Read-only.
• [TemplateId <String>]: Unique identifier for the template used to create this group of settings. Read-only.
• [Values <IMicrosoftGraphSettingValue- []>]: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.
  • [Name <String>]: Name of the setting (as defined by the directorySettingTemplate).
  • [Value <String>]: Value of the setting.

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

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

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.directorymanagement/new-mgbetadirectorysetting
• https://learn.microsoft.com/graph/api/group-post-settings?view=graph-rest-beta