Edit

Share via


Set-EntraBetaAdministrativeUnit

Updates the properties of an administrative unit.

Syntax

Default (Default)

Set-EntraBetaAdministrativeUnit

    -AdministrativeUnitId <String>
    [-Description <String>]
    [-DisplayName <String>]
    [-MembershipType <String>]
    [-MembershipRule <String>]
    [-MembershipRuleProcessingState <String>]
    [-Visibility <String>]
    [<CommonParameters>]

Description

The Set-EntraBetaAdministrativeUnit cmdlet updates the properties of 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 following least-privileged roles are supported for this operation:

  • Privileged Role Administrator

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

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Description

Specifies a description for the administrative unit.

Parameter properties

Type:System.String
Default value:None
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

-DisplayName

Specifies a display name for the administrative unit.

Parameter properties

Type:System.String
Default value:None
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

-MembershipRule

Specifies the dynamic membership rule applied to the administrative unit. The possible values are: dynamic, assigned. If not set, the default value is null and the default behavior is assigned. This parameter is optional.

Parameter properties

Type:System.String
Default value:None
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

-MembershipRuleProcessingState

Controls if the dynamic membership rule is active. Set to On to enable it or Paused to stop updates. This parameter is optional.

Parameter properties

Type:System.String
Default value:None
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

-MembershipType

Specifies the membership type of the administrative unit. Possible values are: dynamic and assigned. If not set, the default value is null, and the membership type defaults to assigned. This parameter is optional.

Parameter properties

Type:System.String
Default value:None
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

-Visibility

Specifies the visibility of the administrative unit. Defaults to public if not set. Set to HiddenMembership to hide membership from nonmembers. This parameter is optional.

Parameter properties

Type:System.String
Default value:None
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

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.