AADGroup

Parameters

Parameter Attribute DataType Description Allowed Values
DisabledPlans Write StringArray[] A collection of the unique identifiers for plans that have been disabled.
SkuId Write String The unique identifier for the SKU.
DisplayName Key String DisplayName of the Azure Active Directory Group
MailNickname Key String Specifies a mail nickname for the group.
Description Write String Specifies a description for the group.
Id Write String Specifies an ID for the group.
Owners Write StringArray[] User Service Principal values for the group's owners.
Members Write StringArray[] User Service Principal values for the group's members.
GroupTypes Write StringArray[] Specifies that the group is a dynamic group. To create a dynamic group, specify a value of DynamicMembership.
MembershipRule Write String Specifies the membership rule for a dynamic group.
MembershipRuleProcessingState Write String Specifies the rule processing state. The acceptable values for this parameter are: On. Process the group rule or Paused. Stop processing the group rule. On, Paused
SecurityEnabled Write Boolean Specifies whether the group is security enabled. For security groups, this value must be $True.
MailEnabled Write Boolean Specifies whether this group is mail enabled. Currently, you cannot create mail enabled groups in Azure AD.
IsAssignableToRole Write Boolean Specifies whether this group can be assigned a role. Only available when creating a group and can't be modified after group is created.
Visibility Write String This parameter determines the visibility of the group's content and members list. Public, Private, HiddenMembership
AssignedLicenses Write InstanceArray[] List of Licenses assigned to the group.
Ensure Write String Specify if the Azure AD Group should exist or not. Present, Absent
Credential Write PSCredential Credentials for the Microsoft Graph delegated permissions.
ApplicationId Write String Id of the Azure Active Directory application to authenticate with.
TenantId Write String Id of the Azure Active Directory tenant used for authentication.
ApplicationSecret Write String Secret of the Azure Active Directory application to authenticate with.
CertificateThumbprint Write String Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
ManagedIdentity Write Boolean Managed ID being used for authentication.

AADGroup

Description

This resource configures an Azure Active Directory group.

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $credsGlobalAdmin
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        AADGroup 'MyGroups'
        {
            DisplayName     = "DSCGroup"
            Description     = "Microsoft DSC Group"
            SecurityEnabled = $True
            MailEnabled     = $True
            GroupTypes      = @("Unified")
            MailNickname    = "M365DSC"
            Visibility      = "Private"
            Ensure          = "Present"
            Credential      = $credsGlobalAdmin
        }
    }
}