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>]

説明

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}

このコマンドレットは、グループ 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

このコマンドレットは、特定のユーザーが属するグループの一覧で特定のプロパティを返します。

例 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 パラメーターを使用して 1 つのプロパティのみを選択しましたが、パラメーターが選択したプロパティに既定のプロパティAppendSelected追加されたため、応答にはさらに多くのプロパティがあります。

パラメーター

-All

すべてのページを一覧表示します。

パラメーターのプロパティ

型:System.Management.Automation.SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AppendSelected

選択したプロパティを追加するかどうかを指定します。

パラメーターのプロパティ

型:System.Management.Automation.SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Append
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Filter

OData v4.0 フィルター ステートメントを指定します。 このパラメーターは、返されるオブジェクトを制御します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetQuery
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-GroupId

グループの一意の ID。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:DirectoryObjectId

パラメーター セット

GetById
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Property

返されるプロパティを指定します。

パラメーターのプロパティ

型:

System.String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Select

パラメーター セット

GetQuery
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
Append
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Top

ユーザーが属するグループの最大数。

パラメーターのプロパティ

型:System.Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:極限

パラメーター セット

GetQuery
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-UserId

Microsoft Entra IDのユーザーの UserPrincipalName または UserId の ID を指定します。

パラメーターのプロパティ

型:System.String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:オブジェクト識別子, UPN, アイデンティティ, ユーザープリンシパルネーム

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

出力

System.Object