Set-AzureADMSGroup

Reference

Module:: AzureAD

Sets the properties for an existing Azure AD group.

Syntax

Set-AzureADMSGroup
   -Id <String>
   [-Description <String>]
   [-DisplayName <String>]
   [-IsAssignableToRole <Boolean>]
   [-MailEnabled <Boolean>]
   [-MailNickname <String>]
   [-SecurityEnabled <Boolean>]
   [-GroupTypes <System.Collections.Generic.List`1[System.String]>]
   [-Visibility <String>]
   [<CommonParameters>]

Description

The Set-AzureADMSGroup cmdlet sets the properties for an existing Azure Active Directory (Azure AD) group.

Examples

Example 1: Update a group's display name

PS C:\> Set-AzureADMSGroup -Id '0260d811-6674-4e65-9674-f511abcb4f7b' -DisplayName 'Tailspin Toys Ltd'

This command updates the display name of the specified group.

Parameters

-Description

Specifies a description for the group.

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

-GroupTypes

Specifies that the group is a dynamic group. To create a dynamic group, specify a value of DynamicMembership.

Type:	List<T>[String]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the object ID of a group.

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

-IsAssignableToRole

This property can only be set at the time of group creation and cannot be modified on an existing group.

Type:	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:	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:	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:	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 will be "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 cannot 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(s) can add new members to the group and requests to join the group need approval of the owner(s).

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

Inputs

String

Outputs

Object