AADGroupsSettings¶
Parameters¶
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
IsSingleInstance | Key | String | Only valid value is 'Yes'. | Yes |
EnableGroupCreation | Write | Boolean | The flag indicating whether Office 365 group creation is allowed in the directory by non-admin users. This setting does not require an Azure Active Directory Premium P1 license. | |
AllowGuestsToBeGroupOwner | Write | Boolean | Boolean indicating whether or not a guest user can be an owner of groups. | |
AllowGuestsToAccessGroups | Write | Boolean | Boolean indicating whether or not a guest user can have access to Office 365 groups content. This setting does not require an Azure Active Directory Premium P1 license. | |
GuestUsageGuidelinesUrl | Write | String | The url of a link to the guest usage guidelines. | |
GroupCreationAllowedGroupName | Write | String | Name of the security group for which the members are allowed to create Office 365 groups even when EnableGroupCreation == false. | |
AllowToAddGuests | Write | Boolean | A boolean indicating whether or not is allowed to add guests to this directory. | |
UsageGuidelinesUrl | Write | String | A link to the Group Usage Guidelines. | |
Ensure | Write | String | Specify if the Azure AD Groups Naming Policy 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. |
AADGroupsNamingPolicy¶
Description¶
This resource configures an Azure Active Directory Groups Settings.
Azure AD Permissions¶
To authenticate via Azure Active Directory, this resource required the following Application permissions:
- Automate
- None
- Export
- None
NOTE: All permisions listed above require admin consent.
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
{
AADGroupsSettings 'GeneralGroupsSettings'
{
IsSingleInstance = "Yes"
AllowGuestsToAccessGroups = $True
AllowGuestsToBeGroupOwner = $True
AllowToAddGuests = $True
EnableGroupCreation = $True
GroupCreationAllowedGroupName = "All Company"
GuestUsageGuidelinesUrl = "https://contoso.com/guestusage"
UsageGuidelinesUrl = "https://contoso.com/usage"
Ensure = "Present"
Credential = $credsGlobalAdmin
}
}
}