Set-EntraGroup
设置现有Microsoft Entra ID组的属性。
语法
Default (默认值)
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>]
说明
该 Set-EntraGroup cmdlet 设置现有Microsoft Entra ID组的属性。 指定GroupId参数以设置现有Microsoft Entra ID组的属性。
示例
示例 1：更新组显示名称
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'
此命令更新Microsoft Entra ID中指定组的显示名称。
示例 2：更新组说明
Connect-Entra -Scopes 'Group.ReadWrite.All'
Get-EntraGroup -Filter "displayName eq 'HelpDesk Team Leaders'" | Set-EntraGroup -Description 'HelpDesk Team Leaders Global'
此示例演示如何更新组说明。
示例 3：更新组邮件昵称
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailNickName 'newnickname'
此命令更新Microsoft Entra ID中指定组的邮件昵称。
示例 4：更新已启用组安全性
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -SecurityEnabled $True
此命令更新Microsoft Entra ID中指定组启用的安全性。
示例 5：更新已启用组邮件
Connect-Entra -Scopes 'Group.ReadWrite.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'HelpDesk Team Leaders'"
Set-EntraGroup -GroupId $group.Id -MailEnabled $False
此示例演示如何更新已启用组主。
示例 6：更新组的属性
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 $True
此示例演示如何更新现有Microsoft Entra ID组的属性。
参数
-Description
指定组的说明。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-DisplayName
指定组的显示名称。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-GroupId
指定组的对象 ID。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | Id |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-GroupTypes
指定组是动态组。 若要创建动态组，请指定 DynamicMembership 的值。
参数属性
| 类型: | System.Collections.Generic.List`1[System.String] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-IsAssignableToRole
此属性只能在创建组时设置，不能在现有组上修改。
参数属性
| 类型: | System.Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-MailEnabled
指示此组是否已启用邮件。
参数属性
| 类型: | System.Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-MailNickname
指定组的邮件昵称。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-SecurityEnabled
指示组是否已启用安全性。
参数属性
| 类型: | System.Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Visibility
指定组的内容和成员列表的可见性。 此参数可以采用以下值之一：
- “Public”：任何人都可以查看组的内容。
- “Private”：只有成员才能查看组的内容。
- “HiddenMembership”：只有成员才能查看组的内容，只有成员、所有者、全局/公司管理员、用户管理员和支持人员管理员可以查看组的成员列表。
如果未提供任何值，则默认值为“Public”。
Notes:
- 此参数仅适用于将 groupType 设置为“Unified”的组。
- 如果组已将此属性设置为“HiddenMembership”，则以后无法更改此属性。
- 任何人都可以加入此属性设置为“Public”的组。如果该属性设置为 Private 或 HiddenMembership，则只有所有者才能向组添加新成员，并请求加入组需要所有者批准。
参数属性
| 类型: | System.String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。