New-EntraGroup

创建Microsoft Entra ID组。

语法

Default (默认值)

New-EntraGroup

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

说明

New-EntraGroup cmdlet 创建Microsoft Entra ID组。 指定用于创建Microsoft Entra ID组的参数DisplayNameMailNicknameMailEnabledSecurityEnabled参数。

有关创建动态组的信息,请参阅: 使用属性创建高级规则

有关权限的说明:

  • 若要创建包含用户作为所有者或成员的组,应用必须至少 User.Read.All 具有权限。
  • 若要创建与其他服务主体作为所有者或成员的组,应用必须至少 Application.Read.All 具有权限。
  • 若要使用用户或服务主体作为所有者或成员创建组,应用必须至少 Directory.Read.All 具有权限。

示例

示例 1:创建组

Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
    DisplayName = 'HelpDesk admin group2'
    MailEnabled = $False
    MailNickname = 'helpDeskAdminGroup'
    SecurityEnabled = $True
}

New-EntraGroup @params
DisplayName           Id                                   MailNickname       Description GroupTypes
-----------           --                                   ------------       ----------- ----------
HelpDesk admin group2 bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq helpDeskAdminGroup             {}

此示例演示如何创建新组。

示例 2:使用 Description 参数创建组

Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
    DisplayName = 'HelpDesk admin group'
    MailEnabled = $false
    MailNickname = 'helpDeskAdminGroup'
    SecurityEnabled = $true
    Description = 'Group assignable to role'
}

New-EntraGroup @params

DisplayName          Id                                   MailNickname       Description              GroupTypes
-----------          --                                   ------------       -----------              ----------
HelpDesk admin group zzzzzzzz-6666-8888-9999-pppppppppppp helpDeskAdminGroup Group assignable to role {}

此示例演示如何使用说明参数创建新组。

示例 3:使用 IsAssignableToRole 参数创建组

Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
    DisplayName = 'HelpDesk admin group2'
    Description = 'Group assignable to role'
    MailEnabled = $False
    MailNickname = 'helpDeskAdminGroup'
    SecurityEnabled = $True
    IsAssignableToRole = $True
}

New-EntraGroup @params
DisplayName           Id                                   MailNickname       Description              GroupTypes
-----------           --                                   ------------       -----------              ----------
HelpDesk admin group2 vvvvvvvv-8888-9999-0000-jjjjjjjjjjjj helpDeskAdminGroup Group assignable to role {}

此示例演示如何使用 IsAssignableToRole 参数创建新组。

示例 4:使用 Visibility 参数创建组

Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
    DisplayName = 'HelpDesk admin group2'
    Description = 'Group assignable to role'
    MailEnabled = $False
    MailNickname = 'helpDeskAdminGroup'
    SecurityEnabled = $True
    Visibility = 'Private'
}

New-EntraGroup @params
DisplayName           Id                                   MailNickname       Description              GroupTypes
-----------           --                                   ------------       -----------              ----------
HelpDesk admin group2 gggggggg-0000-4444-3333-llllllllllll helpDeskAdminGroup Group assignable to role {}

此示例演示如何使用 Visibility 参数创建新组。

示例 5:使用 GroupTypes 参数创建组

Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
    DisplayName = 'HelpDesk admin group3'
    Description = 'group des'
    MailEnabled = $False
    MailNickname = 'helpDeskAdminGroup1'
    SecurityEnabled = $True
    GroupTypes = 'Unified'
}

New-EntraGroup @params
DisplayName           Id                                   MailNickname        Description GroupTypes
-----------           --                                   ------------        ----------- ----------
HelpDesk admin group3 xxxxxxxx-8888-5555-9999-bbbbbbbbbbbb helpDeskAdminGroup1 group des   {Unified}

此示例演示如何使用 GroupTypes 参数创建新组。

参数

-Description

指定组的说明。

参数属性

类型:System.String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisplayName

指定组的显示名称。

参数属性

类型:System.String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-GroupTypes

指定组是统一组或动态组。

Notes:

  • 此参数当前不能用于创建动态组。 若要在 PowerShell 中创建动态组,必须使用 Entra 模块。

参数属性

类型:

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

指定此组是否已启用邮件。

目前,无法在Microsoft Entra ID中创建已启用邮件的组。

参数属性

类型:System.Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MailNickname

指定组的邮件昵称。 如果 MailEnabled $False,则仍必须指定邮件昵称。

参数属性

类型:System.String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SecurityEnabled

指定组是否已启用安全性。 对于安全组,此值必须$True。

参数属性

类型:System.Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Visibility

此参数确定组的内容和成员列表的可见性。

此参数可以采用以下值之一:

  • “公共”- 任何人都可以查看组的内容
  • “专用”- 只有成员才能查看组的内容
  • “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

输入

None

输出

System.Object