Edit

Share via


Get-EntraDeletedAdministrativeUnit

Retrieves the list of previously deleted administrative units.

Syntax

GetQuery (Default)

Get-EntraDeletedAdministrativeUnit

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

GetById

Get-EntraDeletedAdministrativeUnit

    -AdministrativeUnitId <String>
    [-Property <String[]>]
    [<CommonParameters>]

GetVague

Get-EntraDeletedAdministrativeUnit

    [-SearchString <String>]
    [-All]
    [-Property <String[]>]
    [<CommonParameters>]

Description

The Get-EntraDeletedAdministrativeUnit cmdlet Retrieves the list of previously deleted administrative units.

Examples

Example 1: Get list of deleted administrative units

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves the list of deleted administrative units.

Example 2: Get list of deleted administrative units using All parameter

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit -All | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves the list of deleted administrative units using All parameter.

Example 3: Get top two deleted administrative units

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit -Top 2 | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves top two deleted administrative units. You can use -Limit as an alias for -Top.

Example 4: Get deleted administrative units using SearchString parameter

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit -SearchString 'Americas Administrative Unit' | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves deleted administrative units using SearchString parameter.

Example 5: Get deleted administrative units filter by display name

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit -Filter "DisplayName eq 'Americas Administrative Unit'" | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves deleted administrative units having specified display name.

Example 6: Get deleted administrative unit by AdministrativeUnitId

Connect-Entra -Scopes 'AdministrativeUnit.Read.All'
Get-EntraDeletedAdministrativeUnit -AdministrativeUnitId 'gggggggg-8888-9999-aaaa-hhhhhhhhhhhh' | Select-Object Id, DisplayName, MembershipType, Visibility, DeletedDateTime, DeletionAgeInDays | Format-Table -AutoSize
Id                                   DisplayName                   MembershipType     Visibility         DeletedDateTime           DeletionAgeInDays
--                                   -----------                   --------------     ----------         ---------------           -----------------
gggggggg-8888-9999-aaaa-hhhhhhhhhhhh Americas Administrative Unit   Dynamic           HiddenMembership   2/12/2025 12:40:52 PM     10

This cmdlet retrieves deleted administrative unit by AdministrativeUnitId.

Parameters

-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

Retrieve only those deleted administrative units that satisfy the filter.

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

-SearchString

Retrieve only those administrative units that satisfy the -SearchString value.

Parameter properties

Type:System.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

The maximum number of administrative units.

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.

Inputs

System.String

System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

System.Object