Skip to content

Commit

Permalink
Updated Resources and Cmdlet documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
NikCharleboisPFE committed Nov 30, 2023
1 parent 8abd8c9 commit ba92563
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/docs/resources/azure-ad/AADGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@

This resource configures an Azure Active Directory group. IMPORTANT: It does not support mail enabled security groups or mail enabled groups that are not unified or dynamic groups.

If using with AADUser, be aware that if AADUser->MemberOf is being specified and the referenced group is configured with AADGroup->Member then a conflict may arise if the two don't match. It is usually best to choose only one of them. See AADUser

## Permissions

### Microsoft Graph
Expand Down
44 changes: 41 additions & 3 deletions docs/docs/resources/azure-ad/AADUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
| **Country** | Write | String | The Country name of the user | |
| **Department** | Write | String | The Department name of the user | |
| **Fax** | Write | String | The Fax Number of the user | |
| **MemberOf** | Write | StringArray[] | The Groups that the user is a direct member of | |
| **MobilePhone** | Write | String | The Mobile Phone Number of the user | |
| **Office** | Write | String | The Office Name of the user | |
| **PasswordNeverExpires** | Write | Boolean | Specifies whether the user password expires periodically. Default value is false | |
Expand All @@ -37,7 +38,9 @@

## Description

This resource allows users to create Azure AD Users and assign them licenses.
This resource allows users to create Azure AD Users and assign them licenses, roles and/or groups.

If using with AADGroup, be aware that if AADUser->MemberOf is being specified and the referenced group is configured with AADGroup->Member then a conflict may arise if the two don't match. It is usually best to choose only one of them. See AADGroup

## Permissions

Expand All @@ -49,11 +52,11 @@ To authenticate with the Microsoft Graph API, this resource required the followi

- **Read**

- RoleManagement.Read.Directory, User.Read.All
- RoleManagement.Read.Directory, User.Read.All, Group.Read.All, GroupMember.Read.All

- **Update**

- Organization.Read.All, RoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory, User.Read.All, User.ReadWrite.All
- Organization.Read.All, RoleManagement.Read.Directory, RoleManagement.ReadWrite.Directory, User.Read.All, Group.Read.All, GroupMember.Read.All, User.ReadWrite.All, Group.ReadWrite.All, GroupMember.ReadWrite.All

#### Application permissions

Expand Down Expand Up @@ -102,3 +105,38 @@ Configuration Example
}
```

### Example 2

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.

```powershell
Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$credsGlobalAdmin
)
Import-DscResource -ModuleName Microsoft365DSC
node localhost
{
AADUser 'ConfigureJohnSMith'
{
UserPrincipalName = "[email protected]"
FirstName = "John"
LastName = "Smith"
DisplayName = "John J. Smith"
City = "Gatineau"
Country = "Canada"
Office = "Ottawa - Queen"
MemberOf = @('Group-M365-Standard-License', 'Group-PowerBI-Pro-License')
UsageLocation = "US"
Ensure = "Present"
Credential = $credsGlobalAdmin
}
}
}
```

0 comments on commit ba92563

Please sign in to comment.