Edit

Share via

Set-EntraAdministrativeUnit

  • Reference
Module:
Microsoft.Graph.Entra

Updates an administrative unit.

Syntax

Set-EntraAdministrativeUnit
   -AdministrativeUnitId <String>
   [-Description <String>]
   [-DisplayName <String>]
   [<CommonParameters>]

Description

The Set-EntraAdministrativeUnit cmdlet updates an administrative unit in Microsoft Entra ID. Specify AdministrativeUnitId parameter to update a specific administrative unit.

In delegated scenarios, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the microsoft.directory/administrativeUnits/allProperties/allTasks permission.

The Privileged Role Administrator is the least privileged role required for this operation.

Examples

Example 1: Update DisplayName and description

Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All'
$administrativeUnit = Get-EntraAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'"
Set-EntraAdministrativeUnit -AdministrativeUnitId $administrativeUnit.Id -DisplayName 'Pacific Admin Unit' -Description 'Pacific Admin Unit Description'

This Command update DisplayName of specific administrative unit.

  • -AdministrativeUnitId parameter specifies the Id of an administrative unit.
  • -DisplayName parameter specifies the display name for the administrative unit.
  • -Description parameter specifies the description for the administrative unit.

Parameters

-AdministrativeUnitId

Specifies the Id of an administrative unit in Microsoft Entra ID.

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

-Description

Specifies a description.

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

-DisplayName

Specifies a display name.

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