Get-EntraUserGroup

模組:
Microsoft.Entra.Users Module v1.3

取得使用者所屬群組清單。

語法

GetQuery (預設值) 

Get-EntraUserGroup

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

GetById 

Get-EntraUserGroup

    -UserId <String>
    -GroupId <String>
    [<CommonParameters>]

Append 

Get-EntraUserGroup

    -UserId <String>
    -Property <String[]>
    -AppendSelected
    [-All]
    [-Filter <String>]
    [-Top <Int32>]
    [<CommonParameters>]

Description

指令 Get-EntraUserGroup 檔會擷取使用者所屬群組的清單。

範例

範例 1：取得特定使用者所屬群組的清單

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com'

DisplayName                Id                                   MailNickname        Description               GroupTypes
-----------                --                                   ------------        -----------               ----------
Contoso Marketing          hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing    Contoso Marketing         {Unified}
Mark 8 Project Team        pppppppp-4444-0000-8888-yyyyyyyyyyyy  Mark8ProjectTeam    Mark 8 Project Team       {Unified}
Leadership                 tttttttt-0000-3333-9999-mmmmmmmmmmmm  Leadership          Leadership                {Unified}
Sales and Marketing        qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh  SalesAndMarketing   Sales and Marketing       {Unified}
Retail                     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb  Retail              Retail                    {Unified}

此指令子會取得特定使用者所屬群組的清單。

範例 2：利用 All 參數取得特定使用者所屬群組的清單

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -All

DisplayName                Id                                   MailNickname        Description               GroupTypes
-----------                --                                   ------------        -----------               ----------
Contoso Marketing          hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing    Contoso Marketing         {Unified}
Mark 8 Project Team        pppppppp-4444-0000-8888-yyyyyyyyyyyy  Mark8ProjectTeam    Mark 8 Project Team       {Unified}
Leadership                 tttttttt-0000-3333-9999-mmmmmmmmmmmm  Leadership          Leadership                {Unified}
Sales and Marketing        qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh  SalesAndMarketing   Sales and Marketing       {Unified}
Retail                     aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb  Retail              Retail                    {Unified}

此指令小程式會透過 All 參數取得特定使用者所屬群組的清單。

範例 3：取得一個特定使用者所屬的群組

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Top 1

DisplayName                Id                                   MailNickname        Description               GroupTypes
-----------                --                                   ------------        -----------               ----------
Contoso Marketing          hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing    Contoso Marketing         {Unified}

此指令檔會擷取特定使用者所屬的群組。 您可以使用 -Limit 作為 -Top的別名。

範例 4：利用群組 ID 參數取得特定使用者所屬群組的清單

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'Contoso Marketing'"
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -GroupId $group.Id

DisplayName                Id                                   MailNickname        Description               GroupTypes
-----------                --                                   ------------        -----------               ----------
Contoso Marketing          hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing    Contoso Marketing         {Unified}

此 cmdlet 會利用群組 ID 參數檢索特定使用者所屬群組的清單。

  • -GroupId 參數指定群組 ID。

範例 5：取得特定使用者所屬群組的清單，並選擇特定屬性。

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property id,displayName,mailNickName -Debug | Select-Object displayName,id,mailNickName

DisplayName                Id                                   MailNickname
-----------                --                                   ------------
Contoso Marketing          hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing
Contoso Sales              qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh ContosoSales
Contoso Digital            aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb ContosoDigital

此 cmdlet 會回傳特定使用者所屬群組列表中的特定屬性。

範例 6：取得特定使用者所屬群組的清單，並附加所選屬性

Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property AssignedLabels -AppendSelected | Select-Object id,displayName,createdDateTime,deletedDateTime,groupTypes,mailEnabled,mailNickname,securityEnabled,visibility,description,AssignedLabels

Id              : hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq
DisplayName     : Contoso Marketing
CreatedDateTime : 22/08/2024 03:02:41
DeletedDateTime :
GroupTypes      : {Unified}
MailEnabled     : True
MailNickname    : ContosoMarketing
SecurityEnabled : False
Visibility      : Public
Description     :
AssignedLabels  : {TagA,TagB}

Id              : qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh
DisplayName     : Contoso Sales
CreatedDateTime : 22/08/2024 06:18:23
DeletedDateTime :
GroupTypes      : {Unified}
MailEnabled     : True
MailNickname    : ContosoSales
SecurityEnabled : False
Visibility      : Public
Description     : Description of Contoso Sales
AssignedLabels  : {TagA,TagB}

Id              : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
DisplayName     : Contoso Digital
CreatedDateTime : 22/08/2024 06:20:00
DeletedDateTime :
GroupTypes      : {Unified}
MailEnabled     : True
MailNickname    : ContosoDigital
SecurityEnabled : False
Visibility      : Public
Description     : Description of Contoso Digital
AssignedLabels  : {TagA,TagB}

我們只用參數選取了一個屬性 Property ，但因為 AppendSelected 參數在選取的屬性上附加了預設屬性，回應中包含了更多屬性。

參數

-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

-GroupId

群組的唯一識別碼。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False
別名:目錄物件標識符

參數集

GetById
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Property

指定要回傳的屬性

參數屬性

類型:

System.String[]

預設值:None
支援萬用字元:False
不要顯示:False
別名:選取

參數集

GetQuery
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False
Append
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Top

使用者所屬的最大群組數。

參數屬性

類型:System.Int32
預設值:None
支援萬用字元:False
不要顯示:False
別名:極限

參數集

GetQuery
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-UserId

指定使用者在 Microsoft Entra ID 中 UserPrincipalName 或 UserID 的 ID。

參數屬性

類型:System.String
預設值:None
支援萬用字元:False
不要顯示:False
別名:ObjectId (物件識別碼), UPN, Identity, 使用者主要名稱 (UserPrincipalName)

參數集

(All)
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸出

System.Object