Set-EntraGroup
Sets the properties for an existing Microsoft Entra ID group.
Syntax
Set-EntraGroup
-GroupId <String>
[-DisplayName <String>]
[-GroupTypes <System.Collections.Generic.List`1[System.String]>]
[-SecurityEnabled <Boolean>]
[-Description <String>]
[-MailEnabled <Boolean>]
[-MailNickname <String>]
[-Visibility <String>]
[-IsAssignableToRole <Boolean>]
[<CommonParameters>] Description
The Set-EntraGroup cmdlet sets the properties for an existing Microsoft Entra ID group. Specify the GroupId parameter to set the properties for an existing Microsoft Entra ID group.
Examples
Example 1: Update a group display name
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "displayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -DisplayName 'Global HelpDesk Team Leaders'This command updates the display name of a specified group in Microsoft Entra ID.
Example 2: Update a group description
Connect-Entra -Scopes 'Group.ReadWrite.All'
Get-EntraGroup -Filter "displayName eq 'HelpDesk Team Leaders'" | Set-EntraGroup -Description 'HelpDesk Team Leaders Global'This example demonstrates how to update a group description.
Example 3: Update a group mail nickname
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailNickName 'newnickname'This command updates the mail nickname of a specified group in Microsoft Entra ID.
Example 4: Update a group security enabled
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -SecurityEnabled $TrueThis command updates the security enabled of a specified group in Microsoft Entra ID.
Example 5: Update a group mail enabled
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailEnabled $FalseThis example demonstrates how to update a group main enabled.
Example 6: Update a property for a group
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -Visibility 'Private' -GroupTypes 'DynamicMembership' -IsAssignableToRole $TrueThis example demonstrates how to update a property for an existing Microsoft Entra ID group.
Parameters
-Description
Specifies a description for the group.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies a display name for the group.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GroupId
Specifies the object ID of a group.
| Type: | System.String |
| Aliases: | Id |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GroupTypes
Specifies that the group is a dynamic group. To create a dynamic group, specify a value of DynamicMembership.
| Type: | System.Collections.Generic.List`1[System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IsAssignableToRole
This property can only be set at the time of group creation and can't be modified on an existing group.
| Type: | System.Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MailEnabled
Indicates whether this group is mail enabled.
| Type: | System.Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MailNickname
Specifies a mail nickname for the group.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecurityEnabled
Indicates whether the group is security enabled.
| Type: | System.Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Visibility
Specifies the visibility of the group's content and members list. This parameter can take one of the following values:
- "Public": Anyone can view the contents of the group.
- "Private": Only members can view the content of the group.
- "HiddenMembership": Only members can view the content of the group and only members, owners, Global/Company Administrator, User Administrator, and Helpdesk Administrators can view the members list of the group.
If no value is provided, the default value is "Public."
Notes:
- This parameter is only valid for groups that have the groupType set to "Unified."
- If a group has this attribute set to "HiddenMembership," it can't be changed later.
- Anyone can join a group that has this attribute set to "Public." If the attribute is set to Private or HiddenMembership, only owner can add new members to the group and requests to join the group need approval of the owner.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
System.String
Outputs
System.Object