Skip to content

Updating

Brian Delaney edited this page Jan 6, 2025 · 11 revisions

Updating STATv2

Note

These upgrade instructions only apply to existing deployments of STAT v2, including pre-release versions (>= 1.5). For versions prior to v1.5 refer to migration

In most cases, only a single step is required to update to a new version of STATv2, but in some cases more steps may be required. The steps required depend on the version you are upgrading from and to.

This table indicates at which versions specific upgrade steps are required. If you are upgrading multiple versions, ensure you look at all intermediate versions to see if additional steps are required. For example, upgrading from v2.0.1 to v2.0.14 only requires the function app to be upgraded. However, upgrading from v1.5.0 to v2.0.14 requires both the function app upgrade and permissions to be added.

GitHub Release GitHub Release

Upgrading to Release Upgrade Function App Upgrade Connector Add Permissions
v1.5.0 ✅️ ✅️ ✅️
v2.0.0 ✅️ ✅️
v2.0.1 ✅️
v2.0.2 ✅️
v2.0.8 ✅️
v2.0.14 ✅️
v2.0.16 ✅️
v2.0.21 ✅️ ☑️

✅️ This step must be performed to upgrade to this version
☑️ This step is optional and only needed for new functionality
❌ This step is not required to upgrade to this version

Upgrading the function app

  1. Navigate to the function app within the Azure Portal
  2. Select Settings -> Environment variables
  3. Click on WEBSITE_RUN_FROM_PACKAGE
  4. Change the value to the new build, presently this is https://github.com/briandelmsft/STAT-Function/releases/download/v2.0.21/stat.zip
  5. Click Apply
  6. Click Apply
  7. Click Confirm
  8. Click Overview
  9. Click Restart

Upgrading the connector

Note

At this time, no releases require a connector upgrade.

To upgrade the connector, you need to first collection information about your existing STATv2 Deployment.

  1. In the Azure Portal navigate to Logic Apps Custom Connector and locate the connector for STATv2
  2. Make note of the Azure region and Resource Group the STATv2 connector is deployed to
  3. On the Overview page click on JSON View
  4. Make note of the name and displayName values
  5. In the Azure Portal navigate to Function App and locate the STATv2 function app
  6. On the Overview page click on JSON View
  7. Make note of the name, id and hostNames
  8. Deploy the template below supplying the following information:
Field Value Sample
Custom Connector Name name from Step 3 SentinelTriageAssistantv2
Custom Connector Display Name displayName from Step 3 STAT v2
STAT Function Site Name hostNames from Step 6 stat-<randomvalue>.azurewebsites.net
STAT Function Name name from Step 6 stat-<randomvalue>
STAT Function Resource Id id from Step 6 /subscriptions/<subId>/resourceGro...
Deploy Basic Sample false false
Basic Sample Template none none
Basic Sample Playbook Name none none

Note

Basic Sample Template and Basic Sample Playbook Name are required fields, you will need to supply a value such as none. These fields are ignored when the Sample is not being deployed. Additionally, there is no need to redeploy the sample during a connector upgrade.

Deploy Connector Upgrade

When deploying the updated connector, select the same region and resource group where the existing connector is located to update it. Selecting a different region or resource group will result in a second connector being deployed.

Deploy to Azure

Adding Permissions

Follow the Grant Permissions steps in the deployment documentation to update the permissions.

Release notes

Release notes for each version of STATv2 can be found here

⬆️ Use the indexed menu above to navigate through the wiki.

🏠 Home

⚙️ Deployment

⬆️ Updating

💥 Troubleshooting

FAQ

Clone this wiki locally