New-AdmGroup

Creates a new group.

Description

The New-AdmGroup cmdlet creates a new group object in your directory. You can set commonly used group property values by using the cmdlet parameters. Property values that are not associated with cmdlet parameters can be set by using the OtherAttributes parameter.

The Name and GroupScope parameters specify the name and scope of the group and are required to create a new group. You can specify the new group as a security or distribution by setting the GroupType parameter. The Path parameter specifies the container or Organizational Unit (OU) for the group.

The following methods explain different ways to create an object by using this cmdlet:

Method 1: Use the New-AdmGroup cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters.

Method 2: Use a template to create the new object. To do this, create a new group object or retrieve a copy of an existing group object and set the Instance parameter to this object. The object provided to the Instance parameter is used as a template for the new object. You can override property values from the template by setting cmdlet parameters.

Method 3: Use the Import-CSV cmdlet to create custom objects from a comma-separated value (CSV) file that contains a list of object properties. Then pass the objects through the pipeline to the New-AdmGroup cmdlet to create the group objects.

Examples

Example 1 – Create a group and set its properties

New-AdmGroup -Name "RODC Admins" -SamAccountName "RODCAdmins" -GroupCategory Security -GroupScope Global -DisplayName "RODC Administrators" -Path "CN=Users,DC=Fabrikam,DC=Com" -Description "Members of this group are RODC Administrators"

This command creates a new group named RODC Admins in container CN=Users,DC=Fabrikam,DC=Com and sets the GroupCategory, DisplayName, GroupScope, and Description properties of the group.

Example 2 – Create a group using existing property values

Get-AdmGroup FabrikamBranch1 -Properties Description | New-AdmGroup  -Name "Branch1Employees"  -SamAccountName "Branch1Employees" -GroupCategory Distribution -PassThru

GroupScope        : Universal  
Name              : Branch1Employees  
GroupCategory     : Distribution  
SamAccountName    : Branch1Employees  
ObjectClass       : group  
ObjectGUID        : 8eebce44-5df7-4bed-a98b-b987a702103e  
SID               : S-1-5-21-41432690-3719764436-1984117282-1117  
DistinguishedName : CN=Branch1Employees,CN=Users,DC=Fabrikam,DC=com  

This command creates a new group using property values of an existing group.

Example 3 – Create a Microsoft 365 group

New-AdmGroup -Name "My 365 Group" -GroupCategory Microsoft365 -Path "OU=Groups,DC=example,DC=onmicrosoft,DC=com" -Server example.onmicrosoft.com -AdaxesService localhost

This command creates a new Microsoft 365 group named My 365 Group" in the default OU for groups in the example.onmicrosoft.com Azure AD domain.

Parameters

-AdaxesService

Specifies the DNS name of an Adaxes service that will be used to execute this cmdlet. If this parameter is not specified, and the cmdlet is running from an Adaxes Active Directory provider drive, the value for this parameter can be determined from the current path. For example, if the current path is Adaxes:/example.com, the Adaxes service on example.com will be used. If the parameter is not specified and the service DNS name can't be determined from the current path, the cmdlet will access Active Directory directly. To perform an operation in an Azure AD managed domain, you must specify this parameter.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Confirm

Prompts you for confirmation before executing the command.

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • False

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Credential

Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.

To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.

If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.

  • Type:

  • PSCredential

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Description

Specifies a description of the object. This parameter sets the Description property of the object. The schema name of the property is description.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-DisplayName

Specifies the display name of the object. This parameter sets the DisplayName property of the object. The schema name of the property is displayName.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Email

Specifies the email address of the group. This parameter sets the Email property of the group. The schema name of the property is mail.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-GroupCategory

Specifies the category of the group.

Possible values of this parameter for on-premises AD groups are:

  • Distribution or 0
  • Security or 1

Possible values of this parameter for Azure AD groups are:

  • Distribution or 0
  • Security or 1
  • Microsoft365 or 2
  • MailEnabledSecurity or 3
  • Type:

  • ADGroupCategory

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-GroupScope

Specifies the group scope of the group.

Possible values of this parameter are:

  • DomainLocal or 0
  • Global or 1
  • Universal or 2

This parameter sets the GroupScope property of the group. The parameter value combined with other group property values sets the attribute with schema name groupType. This parameter is required for creating on-premises AD groups but not required for creating Azure AD groups.

  • Type:

  • ADGroupScope

  • Position:

  • 2

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-HomePage

Specifies the URL of the home page of the object. This parameter sets the homePage property of the object. The schema name of the property is wWWHomePage.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Instance

Specifies an instance of a group object to use as a template for a new group object.

You can use an instance of an existing group object as a template or you can construct a new group object by using the Windows PowerShell command line or by using a script. The following two methods describe how to create group object templates.

Method 1: Use an existing group object as a template for a new object. Use the Get-AdmGroup cmdlet to retrieve a group object then pass this object to the Instance parameter of the `New-AdmGroupPSCredential cmdlet to create a new group object. You can override property values of the new object by setting the appropriate parameters.

Method 2: Create a new ADGroup object and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-AdmGroup cmdlet to create the new group object.

Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.

  • Type:

  • ADGroup

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-ManagedBy

Specifies the user or group that manages the group object. This parameter sets the ManagedBy (Primary) property of the group. The schema name of the property is managedby. This parameter is set by providing one of the following property values. The identifier in parentheses is the schema name of the property.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)
  • Security identifier (objectSid)
  • SAM Account Name (sAMAccountName)

This parameter sets the primary group owner and is only available for on-premises Active Directory groups.

  • Type:

  • Object

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-ManagedByList

Specifies an array of users or groups that manage the group object. This parameter sets the Managed By property of the group. The schema name of the property is adm-ManagedBylist. This parameter is set by providing any of the following property values. The identifier in parentheses is the schema name of the property.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)
  • Security identifier (objectSid)
  • SAM Account Name (sAMAccountName)

You can use any combination of the above identifiers in an array to specify multiple owners. For example:

$owners = @(
    "CN=John Smith,CN=Users,DC=example,DC=com",
    "{75444639-7DAF-460F-AFAF-04CE891A4AF0}",
    "S-1-5-21-318736562-1752376529-4243903518-874036"
)
New-AdmGroup -Name "My group" -ManagedByList $owners `
    -Path "OU=Groups,DC=example,DC=com" -AdaxesService localhost

For more details on how object ownership works in Adaxes, see Object owners. If you specify this parameter, the AdaxesService parameter becomes required.

  • Type:

  • Object Array

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-MailNickName

Specifies the exchange alias of the group. This parameter sets the Exchange Alias property of the group. The schema name of the property is mailNickName.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Name

Specifies the name of the object. This parameter sets the Name property of the object. The schema name of the property is name.

The parameter becomes required in the following cases:

  • If there are no property patterns affecting the new group, that generate the value for their name property.
  • If you don't specify the properties required by the effective property pattern to generate name.
  • If the cmdlet is executed without the AdaxesService parameter.
  • Type:

  • string

  • Position:

  • 1

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-OtherAttributes

Specifies values for attributes that are not represented by cmdlet parameters. You can set one or more values at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify its name exactly as it is defined in the directory schema.

To specify a single value for an attribute:

-OtherAttributes @{'AttributeName'=value}

To specify multiple values for an attribute:

-OtherAttributes @{'AttributeName'=value1,value2,...}

To specify values for multiple attributes:

-OtherAttributes @{'Attribute1Name'=value; 'Attribute2Name'=value1,value2;...}

  • Type:

  • Hashtable

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Path

Specifies the path of the Organizational Unit (OU) or container where the new object is created.

In many cases, a default value will be used for the Path parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.

A default value for Path is set in the following cases:

  • If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive.
  • If the cmdlet has a default path, this will be used. For example: in New-AdmUser, the Path parameter would default to the Users container.
  • If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain.

The Adaxes Active Directory provider cmdlets, such as New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty, also contain a Path property. However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-ProtectedFromAccidentalDeletion

Specifies whether to prevent the object from being deleted. When this property is set to $true, you cannot delete the corresponding object without changing the value of the property.

Possible values for this parameter are:

  • $false or 0
  • $true or 1
  • Type:

  • bool

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-RequireSenderAuthenticationEnabled

Specifies whether users from outside the organization can send emails to the group. This corresponds to the Let people outside the organization email this group Exchange property of the group. The schema name of the property is allowExternalSenders.

Possible values for this parameter are:

  • $false or 0
  • $true or 1
  • Type:

  • bool

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-SamAccountName

Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. The maximum length is 256 characters. To be compatible with older operating systems, create a SAM account name that is 20 characters long or less. This parameter sets the SAMAccountName property of an account. The schema name of the property is sAMAccountName.

If the string value provided is not terminated with the $ character, the system adds one if needed.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Visibility

Specifies the privacy settings for the group. This parameter can only be used when creating Azure AD groups.

Possible values of this parameter are:

  • Private or 1
  • Public or 2
  • HiddenMembership or 3
  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Server

Specifies the directory to connect to by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance or the Azure AD domain name in one of the following ways:

Domain name values:

  • Fully qualified domain name
  • NetBIOS name

Directory server values:

  • Fully qualified directory server name
  • NetBIOS name
  • Fully qualified directory server name and port

The default value for the Server parameter is determined by one of the following methods in the order that they are listed:

  • By using Server value from objects passed through the pipeline.
  • By using the server information associated with the Adaxes Active Directory PowerShell provider drive, when running under that drive.
  • By using the domain of the computer running PowerShell.
  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-WhatIf

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

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

Inputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADGroup

A group object that is a template for the new group object is received by the Instance parameter.

Outputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADGroup

Returns the new group object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

See also