This template is used to deploy or update the Microsoft Sentinel Triage AssistanT (STAT) solution.
The Microsoft Sentinel Triage AssistanT (STAT) creates a series of Logic Apps, API connections, and a Logic Apps Custom Connector. To use the STAT solution these items must be deployed in the same subscription and datacenter region as the Microsoft Sentinel playbooks which will use the solution. In the event you would like to use STAT from multiple subscriptions or datacenter regions, a deployment of STAT will need to be created in each location.
In most cases it is only necessary to deploy STAT a single time, but in some circumstances such as when it needs to be available from multiple subscriptions or in multiple data center regions the solution may need to be deployed more than once. If you must deploy STAT in multiple subscriptions or multiple datacenters it is recommended to use the advanced setup option and choose unique names for each logic app. Using the same names in multiple deployments may result in issues with the GrantPermissions.ps1 script as the script presently relies on finding the logic apps by name.
To upgrade the Microsoft Sentinel Triage AssistanT you can simply deploy the solution again, using the same settings as your original deployment. This will update all of the STAT components but will maintain any existing connections to other logic apps you have a built and you will not be required to reassign the permissions as they will also be maintained. When upgrading an advanced mode deployment, it is important that you use the same module names as the original deployment, otherwise new logic apps will be created.
When upgrading the base module from versions below 0.4.0 to this version or above the additional Graph API permissions of Reports.Read.All is used by the base module (See GrantPermissions.ps1). If this permissions is not added, the module will return Unknown for all values that use the permission.
- Run GrantPermissions.ps1 to grant the necessary API and RBAC permissions to the logic apps deployed by this template.
The GrantPermissions.ps1 script contains 2 types of permissions assignments that are set via PowerShell Functions. To execute these functions you will require permission:
Function | Permissions |
---|---|
Set-APIPermissions | Calls to this function require the user to be either an Azure AD Global Administrator or Azure AD Privileged Role Administrator |
Set-RBACPermissions | Calls to this function require the user to be either a Resource Group Owner or User Access Administrator on the Resource Group where Microsoft Sentinel is installed |
If you do not have a single account with both the necessary Azure AD and Resource group permissions, you can run the Set-APIPermissions and Set-RBACPermissions calls seperately under different accounts.
All STAT modules, except the STAT Coordinator, are restricted to only being called from a Logic Apps IP and with a valid Shared Access Signature. However, by default the STAT coordinator is only protected by the Shared Access Signature. This is due to the Logic Apps Custom connector using IP addresses outside of the standard Logic Apps IP ranges.
To restrict the STAT coordinator to only accept calls from the Logic apps custom connector:
- Locate the appropriate IP ranges for your Azure datacenter region here under the section AzureConnectors.<AzureRegion>
- Navigate in the Azure Portal to the STAT-Coordinator logic app
- Locate Settings -> Workflow settings
- Change the drop down menu from Any IP to Specific IP ranges
- Add the IP ranges obtained in step 1
- Save
Note: To maintain these IP restrictions, these steps will need to be repeated when updating the STAT solution.