Get-EntraAdministrativeUnit
Gets an administrative unit.
Syntax
GetQuery (Default)
Get-EntraAdministrativeUnit
[-Top <Int32>]
[-All]
[-Filter <String>]
[-Property <String[]>]
[<CommonParameters>]
GetById
Get-EntraAdministrativeUnit
-AdministrativeUnitId <String>
[-All]
[-Property <String[]>]
[<CommonParameters>]
Description
The Get-EntraAdministrativeUnit cmdlet gets a Microsoft Entra ID administrative unit. Specify AdministrativeUnitId parameter to get a specific administrative unit.
Examples
Example 1: Get all administrative units
Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraAdministrativeUnit
DeletedDateTime Id Description DisplayName Visibility
--------------- -- ----------- ----------- ----------
dddddddd-3333-4444-5555-eeeeeeeeeeee Updated Description Updated DisplayName
cccccccc-2222-3333-4444-dddddddddddd testdemo test1
bbbbbbbb-1111-2222-3333-cccccccccccc TestAU
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb test_130624_09
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb demotest test111
This command gets all the administrative units.
Example 2: Get all administrative units using '-All' parameter
Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraAdministrativeUnit -All
DeletedDateTime Id Description DisplayName Visibility
--------------- -- ----------- ----------- ----------
dddddddd-3333-4444-5555-eeeeeeeeeeee Updated Description Updated DisplayName
cccccccc-2222-3333-4444-dddddddddddd testdemo test1
bbbbbbbb-1111-2222-3333-cccccccccccc TestAU
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb test_130624_09
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb demotest test111
This command gets all the administrative units.
Example 3: Get a specific administrative unit
Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraAdministrativeUnit -AdministrativeUnitId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'
DeletedDateTime Id Description DisplayName Visibility
--------------- -- ----------- ----------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName
This example returns the details of the specified administrative unit.
-AdministrativeUnitIdparameter specifies the ID of an administrative unit.
Example 4: Get administrative units filter by display name
Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraAdministrativeUnit -Filter "DisplayName eq 'DAU-Test'"
DeletedDateTime Id Description DisplayName Visibility
--------------- -- ----------- ----------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Dynamic AU testing in CORP tenant DAU-Test
This example list of administrative units containing display name with the specified name.
Example 5: Get top one administrative unit
Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraAdministrativeUnit -Top 1
DeletedDateTime Id Description DisplayName Visibility
--------------- -- ----------- ----------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Dynamic AU testing in CORP tenant DAU-Test
This example returns the specified top administrative units. You can use -Limit as an alias for -Top.
Parameters
-AdministrativeUnitId
Specifies the ID of an administrative unit in Microsoft Entra ID.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ObjectId |
Parameter sets
GetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-All
List all pages.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Filter
Specifies an OData v4.0 filter statement. This parameter filters which objects are returned.
Parameter properties
| Type: | System.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 |
-Property
Specifies properties to be returned.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Top
Specifies the maximum number of records to return.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Limit |
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.