New-MgDirectoryAdministrativeUnit

Module:

Microsoft.Graph.Identity.DirectoryManagement

Use this API to create a new administrativeUnit.

Note

To view the beta release of this cmdlet, view New-MgBetaDirectoryAdministrativeUnit

Syntax

New-MgDirectoryAdministrativeUnit
   [-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>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-MgDirectoryAdministrativeUnit
   -BodyParameter <IMicrosoftGraphAdministrativeUnit>
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this API to create a new administrativeUnit.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	AdministrativeUnit.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	AdministrativeUnit.ReadWrite.All	Not available.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	displayName = "Seattle District Technical Schools"
	description = "Seattle district technical schools administration"
	visibility = "HiddenMembership"
}

New-MgDirectoryAdministrativeUnit -BodyParameter $params

This example shows how to use the New-MgDirectoryAdministrativeUnit Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

administrativeUnit To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IMicrosoftGraphAdministrativeUnit
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.

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

-DisplayName

Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.

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

-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.

Type:	IMicrosoftGraphExtension[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

The unique identifier for an entity. Read-only.

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

-IsMemberManagementRestricted

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	IMicrosoftGraphDirectoryObject[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MembershipRule

.

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

-MembershipRuleProcessingState

.

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

-MembershipType

.

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScopedRoleMembers

Scoped-role members of this administrative unit. To construct, see NOTES section for SCOPEDROLEMEMBERS properties and create a hash table.

Type:	IMicrosoftGraphScopedRoleMembership[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Visibility

Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAdministrativeUnit

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. 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?>]:
• [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>]:
• [MembershipRuleProcessingState <String>]:
• [MembershipType <String>]:
• [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 (value is null), 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.

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.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/new-mgdirectoryadministrativeunit
• https://learn.microsoft.com/graph/api/directory-post-administrativeunits?view=graph-rest-1.0