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>]
Description
該 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
指定群組內容及成員名單的可見性。 此參數可取以下其中之一值：
- 「公開」：任何人都可以查看群組內容。
- 「私人」：只有成員能查看群組內容。
- 「隱藏成員」：只有成員能查看群組內容，且只有成員、擁有者、全球/公司管理員、使用者管理員及客服管理員能查看群組成員名單。
若未提供值，預設值為「公開」。
Notes:
- 此參數僅適用於 groupType 設定為「Unified」的群組。
- 如果群組設定此屬性為「隱藏成員」，之後就無法更改。
- 任何人都可以加入將此屬性設為「公開」的群組。若屬性設定為私人或隱藏成員，只有擁有者能新增成員，加入群組需經擁有者批准。
參數屬性
| 類型: | 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。