Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DevClate/365AutomatedLab
This module will create a Microsoft 365 Test Environment
https://github.com/DevClate/365AutomatedLab
Last synced: 4 days ago
JSON representation
This module will create a Microsoft 365 Test Environment
- Host: GitHub
- URL: https://github.com/DevClate/365AutomatedLab
- Owner: DevClate
- Created: 2023-05-26T09:55:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-19T10:38:41.000Z (7 months ago)
- Last Synced: 2024-04-20T11:07:23.755Z (7 months ago)
- Language: PowerShell
- Size: 1.45 MB
- Stars: 76
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-entra - 365AutomatedLab - Create a Microsoft 365 Test Environment using a test data from an Excel workbook. [](https://badgen.net/github/stars/DevClate/365AutomatedLab) (Tools / CLI)
README
# 365AutomatedLab
This module will create a Microsoft 365 Test Environment using an excel workbook
## Table of Contents
- [Project Summary](#project-summary)
- [Requirements](#requirements)
- [Installer](#installer)
- [Current Functions](#current-functions)
- [Data](#data)
- [Getting Started](#getting-started)
- [Changelog](https://github.com/DevClate/365AutomatedLab/blob/main/CHANGELOG.md)
## Project Summary
I started this module to create a test environment for 365 as there wasn't one for groups, only users which Microsoft provides in there [365 Developer Program Environment](https://developer.microsoft.com/en-us/microsoft-365/dev-program). *As of April 23, 2024, the 365 Developer Program is still not allowing new accounts. I was hoping by now they would have changed their mind, but that isn't the case.* I was tired of having to come up with test user names, their information, and groups each time, or remembering which ones I had already created every time I wanted to do some testing. Let's be honest. we aren't in our test environment every day and all day. This started out as a quick function, then another function, then another....you can see how I quickly determined that this needed to be a module to keep everything organized and easily shareable to others. With that said, I'd love feedback(Create issues) and community help on this to really expand this.
Due to the 365 Developer Program being on hold, I know it's not easy to get a test environment, but depending on the size of your company reach out to your consultant or who you purchase your licensing from. They may be able help you out. If you can't please test with a small data set just to ensure it works as you expected.
### Requirements
- PowerShell Version:
- 7.1+ Windows and Mac (Untested on Linux)
- Modules
- ImportExcel v7.8.2+
- ExchangeOnlineManagement v2.0.6+
- Microsoft.Graph.Users v1.17.0+
- Microsoft.Graph.Groups v1.17.0+
- Microsoft.Graph.Identity.DirectoryManagement v1.17.0+
- Microsoft.Graph.Users.Actions v1.17.0+
- PSFramework v1.8.289+
- PnP.PowerShell v2.2.0+
- Please read https://pnp.github.io/powershell/ if having issues with connecting
- Microsoft.Identity.Client v4.50.0.0
### Installer
365AutomatedLab works on Windows and MacOS (M1+ and Intel)
Run the below command to install 365AutomatedLab from the PowerShell Gallery. If you are running it on a server remove the -Scope parameter and run in an elevated session.
```PowerShell
# Run first if you need to set Execution Policy
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
# Install 365AutomatedLab
Install-Module -Name 365AutomatedLab -Scope CurrentUser
```
### Current Functions
- Create Users and assign license
- New-CT365User
- Remove Users
- Remove-CT365User
- Create the 4 types of Office 365 Groups/Distribution Lists
- New-CT365Group
- Remove the 4 types of Office 365 Groups/Distribution Lists
- Remove-CT365Group
- Assign User to any of their 4 Office 365 Groups/Distribution Lists by Job Title and Location
- New-CT365GroupByUserRole
- Remove User from any of their 4 Office 365 Groups/Distribution Lists by Job Title and Location
- Remove-CT365GroupByUserRole
- Copy worksheets name to a csv file so you can copy those location-titles into your ValidateSet
- Copy-WorkSheetName
- Create your own 365DataEnvironment workbook with the job roles for your organization
- New-CT365DataEnvironment
- Create a new SharePoint Site
- New-CT365SharePointSite
- Remove a SharePoint Site
- Remove-CT365SharePointSite
- Create Teams and channels
- New-CT365Teams
- Remove Teams and channels
- Remove-CT365Teams
- Export Users from production to import template
- Export-CT365ProdUserToExcel
- Replace distinct number for sharepoint site names
- Set-CT365SPDistinctNumber
- Delete all deleted Modern Microsoft 365 Groups
- Remove-CT365AllDeletedM365Groups
- Export Groups from production to import template
- Export-CT365ProdGroupToExcel
- Remove all SharePoint sites from the recycle bin
- Remove-CT365AllSitesFromRecycleBin
### Data
In LabSources you will find an excel file named 365DataEnvironment.xlsx that has 5 main tabs. Any additional tabs will be for different location-jobtitle tabs. You can use this workbook as is in your test environment, or use it as a template for your own data.
- Users: This will have all of the user's information you are creating including licensing information
- If you do not have a UsageLocation set, the licenses will not be added
- Groups: This will have all the groups you want created
- I do not have it assigning manager as of yet, but will in the future
- Location-JobTitle: This will have all the groups that location and job title are suppose to have(Corresponds with JobRole Parameter).
- Originally I had these in a validateset, but opted out. Let me know in the issues if they should be brought back
- Teams: This will have all the Teams and Channels to be created
- I only have it for 2 additional channels, but please let me know if you need more
- Sites: This will have all of the SharePoint sites you want created
- You can create the 4 different types of SharePoint sites as well has select the template you want
In the future, I will have it so you can create random users using Doug Finke's PowerShellAI module and his ImportExcel module. Eventually, it will create the whole workbook! For now you can use ChatGPT with the prompt below to create your users. Feel free to customize the prompt for locations and departments that more match your environment if needed.
```
I need to create a Microsoft 365 test environment with 20 users. There must be a mixture of locations but they can only be in NY, FL, and CA. There must be a mixture of departments, but they can only be IT, HR, Accounting, and Marketing. The fields to create values for are FirstName, LastName, UserName, Title, Department, StreetAddress, City, State, PostalCode, Country, PhoneNumber, MobilePhone. The phone number and mobile number area codes should match the city and state they are in. This should be able to be pasted into an excel document.
```
### Getting Started
Once you have created your 365 Developer Program Environment, you can start adding users and groups.
1. Install the module by downloading the repository and copy into your PowerShell modules folder
2. Save the 365DataEnvironment.xlsx (located in LabSources) file on to your system
3. Run the below command to add users to your environment with their licensing
1. ```powershell
New-CT365User -FilePath "C:\Path\to\365DataEnvironment.xlsx" -Domain "yourdomain.onmicrosoft.com"
```
4. Run the below command to add groups to your environment
1. ```powershell
New-CT365Group -FilePath "C:\Path\to\365DataEnvironment.xlsx" -UserPrincialName "[email protected]" -Domain "yourdomain.onmicrosoft.com"
```
5. Run the below command to add a user to their groups per their location and title
1. ```powershell
New-CT365GroupByUserRole -FilePath "C:\Path\to\365DataEnvironment.xlsx" -UserEmail "[email protected]" -Domain "yourdomain.onmicrosoft.com" -UserRole "NY-IT"
```
6. Run the below command to add Microsoft Teams and Channels to your environment
1. ```powershell
New-CT365Teams -FilePath "C:\path\to\365DataEnvironment.xlsx" -AdminUrl "https://yourdomain.sharepoint.com"
```
Also definitely check out my [blog](https://www.clatent.com/) for more info on 365AutomatedLab and other projects I'm working on.