|
| 1 | +--- |
| 2 | +title: "Armis Alerts Activities (using Azure Functions) connector for Microsoft Sentinel" |
| 3 | +description: "Learn how to install the connector Armis Alerts Activities (using Azure Functions) to connect your data source to Microsoft Sentinel." |
| 4 | +author: cwatson-cat |
| 5 | +ms.topic: how-to |
| 6 | +ms.date: 10/15/2024 |
| 7 | +ms.service: microsoft-sentinel |
| 8 | +ms.author: cwatson |
| 9 | +ms.collection: sentinel-data-connector |
| 10 | +--- |
| 11 | + |
| 12 | +# Armis Alerts Activities (using Azure Functions) connector for Microsoft Sentinel |
| 13 | + |
| 14 | +The [Armis](https://www.armis.com/) Alerts Activities connector gives the capability to ingest Armis Alerts and Activities into Microsoft Sentinel through the Armis REST API. Refer to the API documentation: `https://<YourArmisInstance>.armis.com/api/v1/docs` for more information. The connector provides the ability to get alert and activity information from the Armis platform and to identify and prioritize threats in your environment. Armis uses your existing infrastructure to discover and identify devices without having to deploy any agents. |
| 15 | + |
| 16 | +This is autogenerated content. For changes, contact the solution provider. |
| 17 | + |
| 18 | +## Connector attributes |
| 19 | + |
| 20 | +| Connector attribute | Description | |
| 21 | +| --- | --- | |
| 22 | +| **Azure function app code** | https://aka.ms/sentinel-ArmisAlertsActivitiesAPI-functionapp | |
| 23 | +| **Log Analytics table(s)** | Armis_Alerts_CL<br/> Armis_Activities_CL<br/> | |
| 24 | +| **Data collection rules support** | Not currently supported | |
| 25 | +| **Supported by** | [Armis Corporation](https://support.armis.com/) | |
| 26 | + |
| 27 | +## Query samples |
| 28 | + |
| 29 | +**Armis Alert Events - All Alerts.** |
| 30 | + |
| 31 | + ```kusto |
| 32 | +Armis_Alerts_CL |
| 33 | + |
| 34 | + | sort by TimeGenerated desc |
| 35 | + ``` |
| 36 | + |
| 37 | +**Armis Activity Events - All Activities.** |
| 38 | + |
| 39 | + ```kusto |
| 40 | +Armis_Activities_CL |
| 41 | + |
| 42 | + | sort by TimeGenerated desc |
| 43 | + ``` |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +## Prerequisites |
| 48 | + |
| 49 | +To integrate with Armis Alerts Activities (using Azure Functions) make sure you have: |
| 50 | + |
| 51 | +- **Microsoft.Web/sites permissions**: Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](/azure/azure-functions/). |
| 52 | +- **REST API Credentials/permissions**: **Armis Secret Key** is required. See the documentation to learn more about API on the `https://<YourArmisInstance>.armis.com/api/v1/doc` |
| 53 | + |
| 54 | + |
| 55 | +## Vendor installation instructions |
| 56 | + |
| 57 | + |
| 58 | +> [!NOTE] |
| 59 | + > This connector uses Azure Functions to connect to the Armis API to pull its logs into Microsoft Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details. |
| 60 | +
|
| 61 | + |
| 62 | +>**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App. |
| 63 | +
|
| 64 | + |
| 65 | +> [!NOTE] |
| 66 | + > This data connector depends on a parser based on a Kusto Function to work as expected which is deployed as part of the solution. To view the function code in Log Analytics, open Log Analytics/Microsoft Sentinel Logs blade, click Functions and search for the alias ArmisActivities/ArmisAlerts and load the function code. The function usually takes 10-15 minutes to activate after solution installation/update. |
| 67 | +
|
| 68 | + |
| 69 | +**STEP 1 - Configuration steps for the Armis API** |
| 70 | + |
| 71 | + Follow these instructions to create an Armis API secret key. |
| 72 | + 1. Log into your Armis instance |
| 73 | + 2. Navigate to Settings -> API Management |
| 74 | + 3. If the secret key has not already been created, press the Create button to create the secret key |
| 75 | + 4. To access the secret key, press the Show button |
| 76 | + 5. The secret key can now be copied and used during the Armis Alerts Activities connector configuration |
| 77 | + |
| 78 | + |
| 79 | +**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function** |
| 80 | + |
| 81 | +>**IMPORTANT:** Before deploying the Armis Alerts Activities data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following) readily available.., as well as the Armis API Authorization Key(s) |
| 82 | +
|
| 83 | + |
| 84 | + |
| 85 | +Option 1 - Azure Resource Manager (ARM) Template |
| 86 | + |
| 87 | +Use this method for automated deployment of the Armis connector. |
| 88 | + |
| 89 | +1. Click the **Deploy to Azure** button below. |
| 90 | + |
| 91 | + [](https://aka.ms/sentinel-ArmisAlertsActivitiesAPI-azuredeploy) [](https://aka.ms/sentinel-ArmisAlertsActivitiesAPI-azuredeploy-gov) |
| 92 | +2. Select the preferred **Subscription**, **Resource Group** and **Location**. |
| 93 | +3. Enter the below information : |
| 94 | + Function Name |
| 95 | + Workspace ID |
| 96 | + Workspace Key |
| 97 | + Armis Secret Key |
| 98 | + Armis URL (https://<armis-instance>.armis.com/api/v1/) |
| 99 | + Armis Alert Table Name |
| 100 | + Armis Activity Table Name |
| 101 | + Armis Schedule |
| 102 | + Avoid Duplicates (Default: true) |
| 103 | +4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. |
| 104 | +5. Click **Purchase** to deploy. |
| 105 | + |
| 106 | +Option 2 - Manual Deployment of Azure Functions |
| 107 | + |
| 108 | +Use the following step-by-step instructions to deploy the Armis Alerts Activities data connector manually with Azure Functions (Deployment via Visual Studio Code). |
| 109 | + |
| 110 | + |
| 111 | +**1. Deploy a Function App** |
| 112 | + |
| 113 | +> **NOTE:** You will need to [prepare VS code](/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development. |
| 114 | +
|
| 115 | +1. Download the [Azure Function App](https://aka.ms/sentinel-ArmisAlertsActivitiesAPI-functionapp) file. Extract archive to your local development computer. |
| 116 | +2. Start VS Code. Choose File in the main menu and select Open Folder. |
| 117 | +3. Select the top level folder from extracted files. |
| 118 | +4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button. |
| 119 | +If you aren't already signed in, choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose **Sign in to Azure** |
| 120 | +If you're already signed in, go to the next step. |
| 121 | +5. Provide the following information at the prompts: |
| 122 | + |
| 123 | + a. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app. |
| 124 | + |
| 125 | + b. **Select Subscription:** Choose the subscription to use. |
| 126 | + |
| 127 | + c. Select **Create new Function App in Azure** (Don't choose the Advanced option) |
| 128 | + |
| 129 | + d. **Enter a globally unique name for the function app:** Type a name that is valid in a URL path. The name you type is validated to make sure that it's unique in Azure Functions. (e.g. ARMISXXXXX). |
| 130 | + |
| 131 | + e. **Select a runtime:** Choose Python 3.11 |
| 132 | + |
| 133 | + f. Select a location for new resources. For better performance and lower costs choose the same [region](https://azure.microsoft.com/regions/) where Microsoft Sentinel is located. |
| 134 | + |
| 135 | +6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied. |
| 136 | +7. Go to Azure Portal for the Function App configuration. |
| 137 | + |
| 138 | + |
| 139 | +**2. Configure the Function App** |
| 140 | + |
| 141 | +1. In the Function App, select the Function App Name and select **Configuration**. |
| 142 | +2. In the **Application settings** tab, select **+ New application setting**. |
| 143 | +3. Add each of the following application settings individually, with their respective values (case-sensitive): |
| 144 | + Workspace ID |
| 145 | + Workspace Key |
| 146 | + Armis Secret Key |
| 147 | + Armis URL (https://<armis-instance>.armis.com/api/v1/) |
| 148 | + Armis Alert Table Name |
| 149 | + Armis Activity Table Name |
| 150 | + Armis Schedule |
| 151 | + Avoid Duplicates (Default: true) |
| 152 | + logAnalyticsUri (optional) |
| 153 | + - Use logAnalyticsUri to override the log analytics API endpoint for dedicated cloud. For example, for public cloud, leave the value empty; for Azure GovUS cloud environment, specify the value in the following format: `https://<CustomerId>.ods.opinsights.azure.us`. |
| 154 | +4. Once all application settings have been entered, click **Save**. |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | +## Next steps |
| 159 | + |
| 160 | +For more information, go to the [related solution](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/armisinc1668090987837.armis-solution?tab=Overview) in the Azure Marketplace. |
0 commit comments