Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-MgDirectoryAdministrativeUnit
Update the properties of an administrativeUnit object.
Note
To view the beta release of this cmdlet, view Update-MgBetaDirectoryAdministrativeUnit
Syntax
UpdateExpanded (Default)
Update-MgDirectoryAdministrativeUnit
-AdministrativeUnitId <string>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-DeletedDateTime <datetime>]
[-Description <string>]
[-DisplayName <string>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Id <string>]
[-IsMemberManagementRestricted]
[-Members <IMicrosoftGraphDirectoryObject[]>]
[-MembershipRule <string>]
[-MembershipRuleProcessingState <string>]
[-MembershipType <string>]
[-ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership[]>]
[-Visibility <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update
Update-MgDirectoryAdministrativeUnit
-AdministrativeUnitId <string>
-BodyParameter <IMicrosoftGraphAdministrativeUnit>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-MgDirectoryAdministrativeUnit
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-DeletedDateTime <datetime>]
[-Description <string>]
[-DisplayName <string>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-Id <string>]
[-IsMemberManagementRestricted]
[-Members <IMicrosoftGraphDirectoryObject[]>]
[-MembershipRule <string>]
[-MembershipRuleProcessingState <string>]
[-MembershipType <string>]
[-ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership[]>]
[-Visibility <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentity
Update-MgDirectoryAdministrativeUnit
-InputObject <IIdentityDirectoryManagementIdentity>
-BodyParameter <IMicrosoftGraphAdministrativeUnit>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of an administrativeUnit object.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | AdministrativeUnit.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | AdministrativeUnit.ReadWrite.All, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Identity.DirectoryManagement
$params = @{
displayName = "Executive Division"
membershipType = "Dynamic"
membershipRule = "(user.country -eq "United States")"
membershipRuleProcessingState = "On"
}
Update-MgDirectoryAdministrativeUnit -AdministrativeUnitId $administrativeUnitId -BodyParameter $params
This example shows how to use the Update-MgDirectoryAdministrativeUnit Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AdministrativeUnitId
The unique identifier of administrativeUnit
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
administrativeUnit To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
Parameter properties
| Type: | System.DateTime |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Description
An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisplayName
Display name for the administrative unit. Maximum length is 256 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Extensions
The collection of open extensions defined for this administrative unit. Nullable. To construct, see NOTES section for EXTENSIONS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphExtension[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsMemberManagementRestricted
true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. If not set, the default value is null and the default behavior is false. Use this property to define administrative units with roles that don't inherit from tenant-level administrators, and where the management of individual member objects is limited to administrators scoped to a restricted management administrative unit. This property is immutable and can't be changed later. For more information on how to work with restricted management administrative units, see Restricted management administrative units in Microsoft Entra ID.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Members
Users and groups that are members of this administrative unit. Supports $expand. To construct, see NOTES section for MEMBERS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryObject[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MembershipRule
The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MembershipRuleProcessingState
Controls whether the dynamic membership rule is actively processed. Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MembershipType
Indicates the membership type for the administrative unit. The possible values are: dynamic, assigned. If not set, the default value is null and the default behavior is assigned.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-ScopedRoleMembers
Scoped-role members of this administrative unit. To construct, see NOTES section for SCOPEDROLEMEMBERS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphScopedRoleMembership[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Visibility
Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set, the default value is null and the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
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
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
{{ Fill in the Description }}
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit
{{ Fill in the Description }}
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IMicrosoftGraphAdministrativeUnit>: administrativeUnit
[(Any) <Object>]: This indicates any property can be added to this object.
[DeletedDateTime <DateTime?>]: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Description <String>]: An optional description for the administrative unit.
Supports $filter (eq, ne, in, startsWith), $search.
[DisplayName <String>]: Display name for the administrative unit.
Maximum length is 256 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
[Extensions <IMicrosoftGraphExtension[]>]: The collection of open extensions defined for this administrative unit.
Nullable.
[Id <String>]: The unique identifier for an entity.
Read-only.
[IsMemberManagementRestricted <Boolean?>]: true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage.
If not set, the default value is null and the default behavior is false.
Use this property to define administrative units with roles that don't inherit from tenant-level administrators, and where the management of individual member objects is limited to administrators scoped to a restricted management administrative unit.
This property is immutable and can't be changed later.
For more information on how to work with restricted management administrative units, see Restricted management administrative units in Microsoft Entra ID.
[Members <IMicrosoftGraphDirectoryObject[]>]: Users and groups that are members of this administrative unit.
Supports $expand.
[Id <String>]: The unique identifier for an entity.
Read-only.
[DeletedDateTime <DateTime?>]: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
[MembershipRule <String>]: The dynamic membership rule for the administrative unit.
For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID.
[MembershipRuleProcessingState <String>]: Controls whether the dynamic membership rule is actively processed.
Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically.
[MembershipType <String>]: Indicates the membership type for the administrative unit.
The possible values are: dynamic, assigned.
If not set, the default value is null and the default behavior is assigned.
[ScopedRoleMembers <IMicrosoftGraphScopedRoleMembership[]>]: Scoped-role members of this administrative unit.
[Id <String>]: The unique identifier for an entity.
Read-only.
[AdministrativeUnitId <String>]: Unique identifier for the administrative unit that the directory role is scoped to
[RoleId <String>]: Unique identifier for the directory role that the member is in.
[RoleMemberInfo <IMicrosoftGraphIdentity>]: identity
[(Any) <Object>]: This indicates any property can be added to this object.
[DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date.
For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
[Id <String>]: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Visibility <String>]: Controls whether the administrative unit and its members are hidden or public.
Can be set to HiddenMembership.
If not set, the default value is null and the default behavior is public.
When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.
EXTENSIONS <IMicrosoftGraphExtension[]>: The collection of open extensions defined for this administrative unit. Nullable. [Id <String>]: The unique identifier for an entity. Read-only.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter
[AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
[AllowedValueId <String>]: The unique identifier of allowedValue
[AttributeSetId <String>]: The unique identifier of attributeSet
[CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail
[CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki
[CommerceSubscriptionId <String>]: Alternate key of companySubscription
[CompanySubscriptionId <String>]: The unique identifier of companySubscription
[ContractId <String>]: The unique identifier of contract
[CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
[DeviceId <String>]: The unique identifier of device
[DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
[DirectoryObjectId <String>]: The unique identifier of directoryObject
[DirectoryRoleId <String>]: The unique identifier of directoryRole
[DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
[DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
[DomainId <String>]: The unique identifier of domain
[DomainName <String>]: Usage: domainName='{domainName}'
[ExtensionId <String>]: The unique identifier of extension
[IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
[InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
[OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
[OrgContactId <String>]: The unique identifier of orgContact
[OrganizationId <String>]: The unique identifier of organization
[OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
[ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
[RoleTemplateId <String>]: Alternate key of directoryRole
[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
[SubscribedSkuId <String>]: The unique identifier of subscribedSku
[TenantId <String>]: Usage: tenantId='{tenantId}'
[UserId <String>]: The unique identifier of user
MEMBERS <IMicrosoftGraphDirectoryObject[]>: Users and groups that are members of this administrative unit. Supports $expand. [Id <String>]: The unique identifier for an entity. Read-only. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.
SCOPEDROLEMEMBERS <IMicrosoftGraphScopedRoleMembership[]>: Scoped-role members of this administrative unit. [Id <String>]: The unique identifier for an entity. Read-only. [AdministrativeUnitId <String>]: Unique identifier for the administrative unit that the directory role is scoped to [RoleId <String>]: Unique identifier for the directory role that the member is in. [RoleMemberInfo <IMicrosoftGraphIdentity>]: identity [(Any) <Object>]: This indicates any property can be added to this object. [DisplayName <String>]: The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
