New-AzADGroup

Syntax

Default (Default)

New-AzADGroup
 -DisplayName <String>
 -MailNickname <String>
 [-AcceptedSender <IMicrosoftGraphDirectoryObject[]>]
 [-AdditionalProperties <Hashtable>]
 [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]
 [-Classification <String>]
 [-CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
 [-DeletedDateTime <DateTime>]
 [-Description <String>]
 [-GroupType <String[]>]
 [-HasMembersWithLicenseError]
 [-IsArchived]
 [-IsAssignableToRole]
 [-MailEnabled]
 [-MembershipRule <String>]
 [-MembershipRuleProcessingState <String>]
 [-PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]
 [-PreferredDataLocation <String>]
 [-PreferredLanguage <String>]
 [-SecurityEnabled]
 [-SecurityIdentifier <String>]
 [-Theme <String>]
 [-TransitiveMember <IMicrosoftGraphDirectoryObject[]>]
 [-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
 [-Visibility <String>]
 [-DefaultProfile <PSObject>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1: Create group

New-AzADGroup -DisplayName $gname -MailNickname $nickname

Parameters

-AcceptedSender

The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post. To construct, see NOTES section for ACCEPTEDSENDER properties and create a hash table.

Parameter properties

Parameter sets

-AdditionalProperties

Additional Parameters

Parameter properties

Parameter sets

-AppRoleAssignment

Represents the app roles a group has been granted for an application. Supports $expand. To construct, see NOTES section for APPROLEASSIGNMENT properties and create a hash table.

Parameter properties

Parameter sets

-Classification

Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith).

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-CreatedOnBehalfOf

Represents an Azure Active Directory object. The directoryObject type is the base type for many other directory entity types. To construct, see NOTES section for CREATEDONBEHALFOF properties and create a hash table.

Parameter properties

Parameter sets

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Parameter sets

-DeletedDateTime

.

Parameter properties

Parameter sets

-Description

An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search.

Parameter properties

Parameter sets

-DisplayName

The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy.

Parameter properties

Parameter sets

-GroupType

Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, NOT).

Parameter properties

Parameter sets

-HasMembersWithLicenseError

Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq).

Parameter properties

Parameter sets

-IsArchived

.

Parameter properties

Parameter sets

-IsAssignableToRole

Indicates whether this group can be assigned to an Azure Active Directory role.This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global administrator and Privileged role administrator roles can set this property. The caller must also be assigned the Directory.AccessAsUser.All permission to set this property. For more, see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT).

Parameter properties

Parameter sets

-MailEnabled

Specifies whether the group is mail-enabled. Returned by default. Supports $filter (eq, ne, NOT).

Parameter properties

Parameter sets

-MailNickname

The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).

Parameter properties

Parameter sets

-MembershipRule

The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith).

Parameter properties

Parameter sets

-MembershipRuleProcessingState

Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, NOT, in).

Parameter properties

Parameter sets

-PermissionGrant

The permissions that have been granted for a group to a specific application. Supports $expand. To construct, see NOTES section for PERMISSIONGRANT properties and create a hash table.

Parameter properties

Parameter sets

-PreferredDataLocation

The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.

Parameter properties

Parameter sets

-PreferredLanguage

The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).

Parameter properties

Parameter sets

-SecurityEnabled

Specifies whether the group is a security group. Returned by default. Supports $filter (eq, ne, NOT, in).

Parameter properties

Parameter sets

-SecurityIdentifier

Security identifier of the group, used in Windows scenarios. Returned by default.

Parameter properties

Parameter sets

-Theme

Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.

Parameter properties

Parameter sets

-TransitiveMember

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

Parameter properties

Parameter sets

-TransitiveMemberOf

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

Parameter properties

Parameter sets

-Visibility

Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or Hiddenmembership. Hiddenmembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default.

Parameter properties

Parameter sets

-WhatIf

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

Parameter properties

Parameter sets

CommonParameters

Outputs

IMicrosoftGraphGroup