Edit

Share via

Get-EntraBetaAdministrativeUnit

  • Reference
Module:
Microsoft.Entra.Beta

Gets an administrative unit.

Syntax

Get-EntraBetaAdministrativeUnit
   [-Filter <String>]
   [-All]
   [-Top <Int32>]
   [-Property <String[]>]
   [<CommonParameters>]
Get-EntraBetaAdministrativeUnit
   -AdministrativeUnitId <String>
   [-All]
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraBetaAdministrativeUnit 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-EntraBetaAdministrativeUnit

DeletedDateTime Id                                   Description          DisplayName         IsMemberManagementRestricted Visibility
--------------- --                                   -----------          -----------         ---------------------------- ----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description  Updated DisplayName
                bbbbbbbb-1111-2222-3333-cccccccccccc test111              test111
                cccccccc-2222-3333-4444-dddddddddddd                      TestAU
                dddddddd-3333-4444-5555-eeeeeeeeeeee                      test_130624_09
                eeeeeeee-4444-5555-6666-ffffffffffff test111              test111
                ffffffff-5555-6666-7777-aaaaaaaaaaaa                      test66
                aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb test111              test111             True

This command gets all the administrative units.

Example 2: Get all administrative units using '-All' parameter

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraBetaAdministrativeUnit -All

DeletedDateTime Id                                   Description          DisplayName         IsMemberManagementRestricted Visibility
--------------- --                                   -----------          -----------         ---------------------------- ----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description  Updated DisplayName
                bbbbbbbb-1111-2222-3333-cccccccccccc test111              test111
                cccccccc-2222-3333-4444-dddddddddddd                      TestAU
                dddddddd-3333-4444-5555-eeeeeeeeeeee                      test_130624_09
                eeeeeeee-4444-5555-6666-ffffffffffff test111              test111
                ffffffff-5555-6666-7777-aaaaaaaaaaaa                      test66
                aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb test111              test111             True

This command gets all the administrative units.

Example 3: Get a specific administrative unit

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraBetaAdministrativeUnit -AdministrativeUnitId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'

DeletedDateTime Id                                   Description          DisplayName         IsMemberManagementRestricted Visibility
--------------- --                                   -----------          -----------         ---------------------------- ----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description  Updated DisplayName

This example returns the details of the specified administrative unit.

  • -AdministrativeUnitId parameter specifies the ID of an administrative unit.

Example 4: Get administrative units filter by display name

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Updated DisplayName'"

DeletedDateTime Id                                   Description          DisplayName         IsMemberManagementRestricted Visibility
--------------- --                                   -----------          -----------         ---------------------------- ----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description  Updated DisplayName

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-EntraBetaAdministrativeUnit -Top 1

DeletedDateTime Id                                   Description          DisplayName         IsMemberManagementRestricted Visibility
--------------- --                                   -----------          -----------         ---------------------------- ----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description  Updated DisplayName

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.

Type:System.String
Aliases:Id
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-All

List all pages.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Specifies an OData v4.0 filter statement. This parameter filters which objects are returned.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Specifies properties to be returned.

Type:System.String[]
Aliases:Select
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

Specifies the maximum number of records to return.

Type:System.Int32
Aliases:Limit
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False