Get-AzureADGroup
Gets a group (via Microsoft Graph).
Syntax
GetQuery (Default)
Get-AzureADGroup
[-All <Boolean>]
[-Top <Int32>]
[-Filter <String>]
[<CommonParameters>]
GetVague
Get-AzureADGroup
[-SearchString <String>]
[-All <Boolean>]
[<CommonParameters>]
GetById
Get-AzureADGroup
-ObjectId <String>
[-All <Boolean>]
[<CommonParameters>]
Description
The Get-AzureADGroup cmdlet gets a group in the Microsoft Entra ID using the Microsoft Graph.
Examples
Example 1: Get all groups
PS C:\>Get-AzureADGroup -All:$true
ObjectId DisplayName Description
-------- ----------- -----------
00628948-b509-4362-aa73-380c4dbd2a44 ADSyncBrowse
02d91535-6c02-42bc-8ede-c57189320cc0 NewGroup2
093fc0e2-1d6e-4a1b-9bf8-effa0196f1f7 All Users
0dc8d2b2-d907-42e8-8558-0add236a8408 ADSyncOperators
0e6cf869-82ca-4647-b330-420b9a6f8ef7 Temporary users team (Dynamic group)
10d81ac5-1993-434b-b74c-1dcc4fd534ea HappyThanksgiving
1e94a453-2727-47f6-b59e-d86df3494312 European teams
23af9bad-83c5-4f03-a4e4-363bd892fc56 South-West Sales team
269f90d5-93dc-4c0a-8f22-bf23da4e0c3a All FTE employees
2b559810-b5de-41a8-913f-c45a55adfc25 Exchange Trusted Subsystem This group contains Exchange servers that run Exchange cmdlets on behalf of users via the management service.
Its members ...
31f1ff6c-d48c-4f8a-b2e1-abca7fd399df Intune Administrators Intune Device Administrators
364e009b-fbe4-4aef-b230-2e9e8f2fe636 ADSyncPasswordSet
3d3f7196-3ec8-4076-a232-1ca30b655d1a WinRMRemoteWMIUsers__ Members of this group can access WMI resources over management protocols (such as WS-Management via the Windows Remote Man...
3df5d8b7-8af4-4536-90d6-cde4c878e252 ADSyncOperators
4370f0a6-78e9-44cb-b722-29cb5307fdba Exchange Servers This group contains all the Exchange servers. This group shouldn't be deleted.
47a1bff5-f449-4bfc-8772-b1515c57fec5 ExchangeLegacyInterop This group is for interoperability with Exchange 2003 servers within the same forest.
This group should not be deleted.
Example 2: Get groups that contain a search string
PS C:\>Get-AzureADGroup -SearchString "All"
ObjectId DisplayName Description
-------- ----------- -----------
093fc0e2-1d6e-4a1b-9bf8-effa0196f1f7 All Users
This command gets the groups that include the text All in their display names.
Parameters
-All
If true, return all groups. If false, return the number of objects specified by the Top parameter
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Filter
Specifies an oData v3.0 filter statement. This parameter controls which objects are returned.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetQuery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ObjectId
The unique identifier of a group in the Microsoft Entra ID (ObjectId)
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SearchString
Specifies a search string.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetVague
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Top
Specifies the maximum number of records to return.
Parameter properties
| Type: | Int32 |
| Default value: | 100 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetQuery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Notes
See the migration guide for Get-AzureADGroup to the Microsoft Graph PowerShell.
This cmdlet uses the AzureAD Graph instead of the MSGraph. Commands that use the MSGraph are in the format of *-ADMS*. For more information on the naming convention see New enhancements to the #AzureAD PowerShell 2.0 preview. Manage dynamic groups and more!