Get-AzADGroupMember

Reference

Module:: Az.Resources

Lists members of an AD group in the current tenant.

Warning

There are upcoming breaking changes in this cmdlet. These changes are currently in preview with Az.Resources version 5.0.0-preview. They will become generally available with our next major release of the Az PowerShell module, version 7.x in December of 2021. For more information, see Azure AD to Microsoft Graph migration changes in Azure PowerShell.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzADGroupMember
   [-GroupObjectId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-IncludeTotalCount]
   [-Skip <UInt64>]
   [-First <UInt64>]
   [<CommonParameters>]

Get-AzADGroupMember
   -GroupDisplayName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-IncludeTotalCount]
   [-Skip <UInt64>]
   [-First <UInt64>]
   [<CommonParameters>]

Get-AzADGroupMember
   -GroupObject <PSADGroup>
   [-DefaultProfile <IAzureContextContainer>]
   [-IncludeTotalCount]
   [-Skip <UInt64>]
   [-First <UInt64>]
   [<CommonParameters>]

Description

Lists members of an AD group in the current tenant.

Examples

Example 1: List members by AD group object id

PS C:\> Get-AzADGroupMember -GroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE

Lists members of the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'.

Example 2: List members by AD group object id using paging

PS C:\> Get-AzADGroupMember -GroupObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE -First 100

Lists the first 100 members of the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE'.

Example 3: List members by piping

PS C:\> Get-AzADGroup -ObjectId 85F89C90-780E-4AA6-9F4F-6F268D322EEE | Get-AzADGroupMember

Gets the AD group with object id '85F89C90-780E-4AA6-9F4F-6F268D322EEE' and pipes it to the Get-AzADGroupMember cmdlet to list all members in that group.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-First

The maximum number of objects to return.

Type:	UInt64
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupDisplayName

The display name of the group.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupObject

The group object that you are listing members from.

Type:	PSADGroup
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-GroupObjectId

Object Id of the group.

Type:	String
Aliases:	Id, ObjectId
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-IncludeTotalCount

Reports the number of objects in the data set. Currently, this parameter does nothing.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

Ignores the first N objects and then gets the remaining objects.

Type:	UInt64
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSADGroup

Outputs

PSADObject