Get-MgGroupSettingTemplateGroupSettingTemplate
A group setting template represents a template of settings from which settings may be created within a tenant. This operation allows retrieval of the properties of the groupSettingTemplate object, including the available settings and their defaults.
Syntax
Get-MgGroupSettingTemplateGroupSettingTemplate
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-Filter <String>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgGroupSettingTemplateGroupSettingTemplate
-GroupSettingTemplateId <String>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgGroupSettingTemplateGroupSettingTemplate
-InputObject <IGroupsIdentity>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
A group setting template represents a template of settings from which settings may be created within a tenant. This operation allows retrieval of the properties of the groupSettingTemplate object, including the available settings and their defaults.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Directory.Read.All | Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Directory.Read.All | Directory.ReadWrite.All |
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Directory.Read.All | Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Directory.Read.All | Directory.ReadWrite.All |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Groups
Get-MgGroupSettingTemplateGroupSettingTemplateThis example shows how to use the Get-MgGroupSettingTemplateGroupSettingTemplate Cmdlet.
Parameters
-All
List all pages.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
| Type: | String |
| Aliases: | CV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
| Type: | String[] |
| Aliases: | Expand |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Filter items by property values
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GroupSettingTemplateId
The unique identifier of groupSettingTemplate
| 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 |
-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 |
-PageSize
Sets the page size of results.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-Property
Select properties to be returned
| Type: | String[] |
| Aliases: | Select |
| 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 |
-Search
Search items by search phrases
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skip the first n items
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sort
Order items by property values
| Type: | String[] |
| Aliases: | OrderBy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
Show only the first n items
| Type: | Int32 |
| Aliases: | Limit |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IGroupsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphGroupSettingTemplate
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.
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