Get-EntraGroup

模块:
Microsoft.Entra.Groups Module v1.3

获取组。

语法

GetQuery (默认值) 

Get-EntraGroup

    [-Top <Int32>]
    [-All]
    [-Filter <String>]
    [-Property <String[]>]
    [-HasErrorsOnly]
    [-HasLicenseErrorsOnly]
    [<CommonParameters>]

GetVague 

Get-EntraGroup

    [-SearchString <String>]
    [-All]
    [-Property <String[]>]
    [-HasErrorsOnly]
    [-HasLicenseErrorsOnly]
    [<CommonParameters>]

GetById 

Get-EntraGroup

    -GroupId <String>
    [-All]
    [-Property <String[]>]
    [<CommonParameters>]

Append 

Get-EntraGroup

    -Property <String[]>
    -AppendSelected
    [-GroupId <String>]
    [-Top <Int32>]
    [-All]
    [-Filter <String>]
    [-SearchString <String>]
    [-HasErrorsOnly]
    [-HasLicenseErrorsOnly]
    [<CommonParameters>]

说明

该 Get-EntraGroup cmdlet 获取Microsoft Entra ID中的组。 指定 ObjectId 用于获取特定组的参数。

可以通过使用 HasErrorsOnly 参数查找包含服务预配错误的组或 HasLicenseErrorsOnly 用于查找许可证分配错误的组来筛选结果，以便仅显示有问题的组。 这些筛选选项可帮助管理员识别需要注意的组。

示例

示例 1：获取所有组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup

DisplayName                                       Id                                   MailNickname                                   Description
-----------                                       --                                   ------------                                   -----------
SimpleTestGrp                                     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb NickName
SimpleGroup                                       bbbbbbbb-1111-2222-3333-cccccccccccc NickName
testGroupInAU10                                   cccccccc-2222-3333-4444-dddddddddddd testGroupInAU10                                testGroupInAU10
My new group                                      dddddddd-3333-4444-5555-eeeeeeeeeeee NotSet                                         New created group
SimpleGroup                                       eeeeeeee-4444-5555-6666-ffffffffffff NickName

此示例演示如何从Microsoft Entra ID获取所有组。

示例 2：使用 GroupId 获取特定组

Connect-Entra -Scopes 'GroupMember.Read.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'Azure Panda'"
Get-EntraGroup -GroupId $group.Id

DisplayName    Id                                   MailNickname        Description         GroupTypes
-----------    --                                   ------------        -----------         ----------
Crimson Eagle  pppppppp-4444-0000-8888-yyyyyyyyyyyy crimsoneaglegroup   Crimson Eagle Group {Unified}

此示例演示如何通过提供 ID 来检索特定组。

示例 3：检索Microsoft 365（统一）组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Filter "groupTypes/any(g:g eq 'Unified')" -Top 4

DisplayName        Id                                     MailNickname     GroupTypes
-----------        --                                     ------------     ----------
Contoso Group      hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq   contosogroup     {Unified}
Crimson Eagle     pppppppp-4444-0000-8888-yyyyyyyyyyyy   crimsoneagle     {Unified}
Bold Falcon      tttttttt-0000-3333-9999-mmmmmmmmmmmm   boldfalcon       {Unified}
Misty Fox        qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh   mistyfox         {Unified}

此示例检索Microsoft 365（统一）组。 您可以将 -Limit 用作 -Top 的别名。

示例 4：按 DisplayName 获取组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Filter "DisplayName eq 'Azure Panda'"

DisplayName        Id                                   MailNickname     Description        GroupTypes
-----------        --                                   ------------     -----------        ----------
Azure Panda        qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh azurepanda       Azure Panda        {Unified}

在此示例中，我们使用显示名称检索组。

示例 5：获取 DisplayName 以搜索字符串开头的组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -SearchString 'New'

DisplayName             Id                                   MailNickname          Description             GroupTypes
-----------             --                                   ------------          -----------             ----------
New Sparkling Deer      bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq newsparklingdeer New Sparkling Deer Group {Unified}
New Golden Fox          xxxxxxxx-8888-5555-9999-bbbbbbbbbbbb newgoldenfox                  New Golden Fox            {DynamicMembership}

此示例演示如何从Microsoft Entra ID检索在显示名称中包含新文本的组。

示例 6：列出无所有者组

Connect-Entra -Scopes 'GroupMember.Read.All'
$allGroups = Get-EntraGroup -All
$groupsWithoutOwners = foreach ($group in $allGroups) {
    $owners = Get-EntraGroupOwner -ObjectId $group.Id
    if ($owners.Count -eq 0) {
        $group
    }
}
$groupsWithoutOwners | Format-Table DisplayName, Id, GroupTypes

DisplayName           Id                                   GroupTypes
-----------           --                                   ----------
My new group          aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb {}
HelpDesk admin group  eeeeeeee-4444-5555-6666-ffffffffffff {}

此示例演示如何检索没有所有者的组。 通过识别无所有者组，IT 管理员可以提高整体治理和运营效率。

示例 7：列出空组

Connect-Entra -Scopes 'GroupMember.Read.All'
$allGroups = Get-EntraGroup -All
$groupsWithoutMembers = foreach ($group in $allGroups) {
    $members = Get-EntraGroupMember -ObjectId $group.Id
    if ($members.Count -eq 0) {
        $group
    }
}
$groupsWithoutMembers | Format-Table DisplayName, Id, GroupTypes

DisplayName           Id                                   GroupTypes
-----------           --                                   ----------
My new group          aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb {}
HelpDesk admin group  eeeeeeee-4444-5555-6666-ffffffffffff {}

此示例演示如何检索不包含成员的组。 通过标识无成员组，IT 管理员可以识别和清理不再用作用途的未使用或过时的组。

示例 8：获取具有特定属性的组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Property Id,DisplayName, SecurityEnabled,Visibility,GroupTypes | Select-Object Id,DisplayName, SecurityEnabled,Visibility,GroupTypes | Format-Table -AutoSize

Id                                   DisplayName                SecurityEnabled Visibility GroupTypes
--                                   -----------                --------------- ---------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb SimpleGroup               False           Public     {Unified}
eeeeeeee-4444-5555-6666-ffffffffffff My new group              False           Private    {Unified}
bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq HelpDesk admin group      True            {}

此示例演示如何仅返回组的特定属性。 可以使用 -Select 别名或 -Property。

示例 9：获取具有特定属性的组并追加所选属性

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -GroupId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Property IsSubscribedByMail -AppendSelected | Select-Object Id, DisplayName, MailEnabled, Visibility, IsSubscribedByMail | Format-Table -AutoSize

Id                                   DisplayName                MailEnabled Visibility IsSubscribedByMail
--                                   -----------                --------------- ---------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb SimpleGroup               False           Public     False

此示例演示如何将所选属性追加到默认属性。

示例 10：获取有错误的组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -HasErrorsOnly

DisplayName           Id                                   MailNickname          Description             GroupTypes ServiceProvisioningErrors
-----------           --                                   ------------          -----------             ---------- -------------------------
Problem Group         aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb problemgroup          Group with errors       {Unified}  {@{ErrorDetail=...}}
Error Test Group      bbbbbbbb-1111-2222-3333-cccccccccccc errortestgroup        Another problem group   {}         {@{ErrorDetail=...}}

此示例演示如何仅检索具有服务预配错误的组。 该 HasErrorsOnly 参数筛选结果，仅显示需要注意问题的组。

示例 11：获取许可证错误的组

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -HasLicenseErrorsOnly

DisplayName             Id                                   MailNickname            Description               GroupTypes
-----------             --                                   ------------            -----------               ----------
License Issue Group     cccccccc-2222-3333-4444-dddddddddddd licenseissuegroup       Group with license errors {Unified}
Failed License Group    dddddddd-3333-4444-5555-eeeeeeeeeeee failedlicensegroup      License assignment failed {}

此示例演示如何仅检索具有许可证错误的组。 这对于识别许可证分配失败且需要管理关注的组非常有用。

示例 12：将错误筛选与搜索相结合

Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -SearchString 'Test' -HasErrorsOnly

DisplayName           Id                                   MailNickname          Description             GroupTypes ServiceProvisioningErrors
-----------           --                                   ------------          -----------             ---------- -------------------------
Test Error Group      bbbbbbbb-1111-2222-3333-cccccccccccc testerrorgroup        Test group with errors  {}         {@{ErrorDetail=...}}

此示例演示如何将搜索功能与错误筛选相结合，以查找具有特定名称模式和服务预配错误的特定组。

参数

-All

列出所有页面。

参数属性

类型:System.Management.Automation.SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

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

-AppendSelected

指定是否追加所选属性。

参数属性

类型:System.Management.Automation.SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

Append
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Filter

指定 OData v4.0 筛选器语句。 此参数控制返回的对象。

参数属性

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

参数集

GetQuery
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False
Append
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-GroupId

Microsoft Entra ID中组的唯一标识符（GroupId）

参数属性

类型:System.String
默认值:None
支持通配符:False
不显示:False
别名:对象标识符 (ObjectId)

参数集

GetById
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False
Append
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-HasErrorsOnly

仅返回具有服务预配错误的组。

参数属性

类型:System.Management.Automation.SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

GetQuery
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
GetVague
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
Append
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-HasLicenseErrorsOnly

仅返回具有许可证错误的成员的组。

参数属性

类型:System.Management.Automation.SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

GetQuery
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
GetVague
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False
Append
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Property

指定要返回的属性

参数属性

类型:

System.String[]

默认值:None
支持通配符:False
不显示:False
别名:Select

参数集

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

-SearchString

指定搜索字符串。

参数属性

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

参数集

GetValue
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False
Append
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

-Top

指定要返回的最大记录数。

参数属性

类型:System.Int32
默认值:None
支持通配符:False
不显示:False
别名:Limit

参数集

GetQuery
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False
Append
Position:Named
必需:False
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。