Monitor your Microsoft 365 tenant's security configuration using Maester!
Maester is an open source PowerShell-based test automation framework designed to help you monitor and maintain the security configuration of your Microsoft 365 environment.
To learn more about Maester and to get started, visit Maester.dev.
- Automated Testing: Maester provides a comprehensive set of automated tests to ensure the security of your Microsoft 365 setup.
- Customizable: Tailor Maester to your specific needs by adding custom Pester tests.
- More to come...
Install-Module -Name Maester -Scope CurrentUserTo install the Maester tests run the following PowerShell commands. Pester will be installed if needed.
md maester-tests
cd maester-tests
Install-MaesterTestsTo run the tests in this folder run the following PowerShell commands. To learn more see maester.dev.
Connect-Maester
Invoke-MaesterAn optional parameter, -Environment, can be utilized on Connect-Maester to specify the name of the national cloud environment to connect to. By default global cloud is used.
Allowed values include:
- Global (default, if parameter is not specified)
- China
- Germany
- USGov
- USGovDOD
Connect-Maester -Environment USGovThe Maester team will add new tests over time. To get the latest updates, use the commands below to update this folder with the latest tests.
- Update the
MaesterPowerShell module to the latest version and load it. - Navigate to the folder where you have your Maester tests.
- Run
Update-MaesterTests.
Update-Module Maester -Force
Import-Module Maester
Update-MaesterTestsMaester is also published to the GitHub marketplace and can be used directly in any GitHub workflow.
Just provide the required client and tenant id. For more details please refer to the docs.
name: Maester Daily Tests
on:
push:
branches: ["main"]
# Run once a day at midnight
schedule:
- cron: "0 0 * * *"
# Allows to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
id-token: write
contents: read
checks: write
jobs:
run-maester-tests:
name: Run Maester Tests
runs-on: ubuntu-latest
steps:
- name: Run Maester action
id: maester # this is important, by setting the id you can use the output of the action in the next steps
uses: maester365/maester@main
with:
client_id: ${{ secrets.AZURE_CLIENT_ID }}
tenant_id: ${{ secrets.AZURE_TENANT_ID }}
include_public_tests: true # Optional
include_exchange: false # Optional
include_teams: false # Optional
pester_verbosity: None # Optional - 'None', 'Normal', 'Detailed', 'Diagnostic'
mail_recipients: '' # optional a list of email addresses to send the report to
mail_userid: '' # optional the user id to use for sending the email
include_tags: '' # optional a list of tags to include in the test run
exclude_tags: '' # optional a list of tags to exclude in the test run
step_summary: true # Optional: Set to false if you don't want a summary added to your GitHub Action run
artifact_upload: true # Optional: Set to false if you don't want summaries uploaded to GitHub Artifacts
install_prerelease: false # Optional: Set to true if you want to use Measter Preview Build when running tests
disable_telemetry: false # Optional: Set to true If you want telemetry information not to be logged.
notification_teams_webhook: '' # Optional: Set to the URL of your Teams webhook if you want to send notifications to Teams