Add/Edit Custom Test
This page will allow you to create a new custom test or edit an existing custom test.
Test Guidance
Custom tests are read-only. You will not be able to write any information to tables or the client tenant.
Review the Test Guidance section for additional information on how to craft a custom test.
Configuration Options
Script Name
The display name for the test.
Category
Existing Options: License Management, Security, Compliance, User Management, Group Management, Device Management, Guest Management, General. You are able to create custom categories by entering your desired category test and clicking "Add option: <your text>"
Description
Describes what the script checks or monitors.
Risk Level
Options: Low, Medium, High, Critical. Used for alert severity.
Pillar
Options: Identity, Devices, Data. Classifies which test category this belongs to.
User Impact
Options: Low, Medium, High
Implementation Effort
Options: Low, Medium, High.
Result Display Type
Options: JSON or Markdown. Controls how test failure output is rendered in CIPP test details.
Result Mode
Options: Auto, Always Pass, Always Info, or Always Investigate. For Auto the script output determines pass/fail.
Enable Script
Whether the test runs during scheduled test execution.
Notify on Alert
Whether a notification fires when the test fails.
Markdown/PowerShell
Markdown Result Template
This is only displayed when the Result Display Type is set to Markdown. This allows you to define the Markdown that will be generated by the test result. See usage notes on the page for formatting, etc.
PowerShell Script
This editor allows you to create the PowerShell script used in the test. See the usage notes on the page for how to construct the test script.
Type % to insert replacement variables (e.g. %tenantid%, %defaultdomain%, or custom variables).
Test Script Output
After saving the script, you are presented with the options below:
Script Parameters (JSON)
Optional JSON object of parameters to pass to the script for the preview run. Multi-line text field. E.g. {"DaysThreshold": 30}.
Run Test
This button will execute the test script against the currently selected tenant in Tenant Select.
Test runs on the page are preview only and are not written to the cache db.
Feature Requests / Ideas
We value your feedback and ideas. Please raise any feature requests on GitHub.
Last updated
Was this helpful?