API Reference
Command
New-ADXGroup
Creates a new Active Directory group account.
Examples
Example 1: Preview a new role-based access group in the groups OU
New-ADXGroup -SamAccountName 'GG_SQL_Backup_Operators' -OrganizationalUnit 'OU=Groups,OU=Tier1,DC=contoso,DC=com' -DisplayName 'SQL Backup Operators' -Description 'Members can operate SQL backup jobs' -Scope Global -SecurityEnabled $true -WhatIf
Example 2: Create a mail-enabled distribution group for the branch office
New-ADXGroup -SamAccountName 'DL_Krakow_Office' -OrganizationalUnit 'OU=Distribution Lists,DC=contoso,DC=com' -DisplayName 'Krakow Office' -Mail 'krakow.office@contoso.com' -Scope Universal -SecurityEnabled $false
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
New-ADXGroup -SamAccountName <string> -OrganizationalUnit <string> [-Attribute <Hashtable>] [-CommonName <string>] [-Description <string>] [-DisplayName <string>] [-Mail <string>] [-ManagedBy <string>] [-Notes <string>] [-Scope <DomainLocal|Global|Universal>] [-SecurityEnabled <bool>] [<CommonParameters>]#Parameters
- SamAccountName string
- Gets or sets the group sAMAccountName.
- OrganizationalUnit string
- Gets or sets the destination organizational unit distinguished name.
- Attribute Hashtable
- Gets or sets optional custom attributes to apply after creation.
- CommonName string
- Gets or sets optional common name (CN). Defaults to SamAccountName.
- Description string
- Gets or sets optional description.
- DisplayName string
- Gets or sets optional display name.
- Mail string
- Gets or sets optional mail address.
- ManagedBy string
- Gets or sets optional managedBy distinguished name.
- Notes string
- Gets or sets optional notes/info value.
- Scope GroupScope
- Gets or sets the group scope. Possible values: DomainLocal, Global, Universal
- Possible values:
DomainLocal,Global,Universal - SecurityEnabled bool
- Gets or sets whether the group is security-enabled.
Outputs
ADPlayground.DirectoryMutationResult