Muokkaa

Jaa

Armis Alerts Activities (using Azure Functions) connector for Microsoft Sentinel

  • Artikkeli

The Armis 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.

This is autogenerated content. For changes, contact the solution provider.

Connector attributes

Connector attribute Description
Azure function app code https://aka.ms/sentinel-ArmisAlertsActivitiesAPI-functionapp
Log Analytics table(s) Armis_Alerts_CL
Armis_Activities_CL
Data collection rules support Not currently supported
Supported by Armis Corporation

Query samples

Armis Alert Events - All Alerts.

Armis_Alerts_CL

| sort by TimeGenerated desc

Armis Activity Events - All Activities.

Armis_Activities_CL

| sort by TimeGenerated desc

Prerequisites

To integrate with Armis Alerts Activities (using Azure Functions) make sure you have:

  • 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.
  • 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

Vendor installation instructions

Note

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 for details.

(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 to use Azure Key Vault with an Azure Function App.

Note

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.

STEP 1 - Configuration steps for the Armis API

Follow these instructions to create an Armis API secret key.

  1. Log into your Armis instance
  2. Navigate to Settings -> API Management
  3. If the secret key has not already been created, press the Create button to create the secret key
  4. To access the secret key, press the Show button
  5. The secret key can now be copied and used during the Armis Alerts Activities connector configuration

STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function

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)

Option 1 - Azure Resource Manager (ARM) Template

Use this method for automated deployment of the Armis connector.

  1. Click the Deploy to Azure button below.

    Deploy To Azure Deploy to Azure Gov

  2. Select the preferred Subscription, Resource Group and Location.

  3. Enter the below information :

    • Function Name
    • Workspace ID
    • Workspace Key
    • Armis Secret Key
    • Armis URL https://<armis-instance>.armis.com/api/v1/
    • Armis Alert Table Name
    • Armis Activity Table Name
    • Armis Schedule
    • Avoid Duplicates (Default: true)

  4. Mark the checkbox labeled I agree to the terms and conditions stated above.

  5. Click Purchase to deploy.

Option 2 - Manual Deployment of Azure Functions

Use the following step-by-step instructions to deploy the Armis Alerts Activities data connector manually with Azure Functions (Deployment via Visual Studio Code).

1. Deploy a Function App

NOTE: You will need to prepare VS code for Azure function development.

  1. Download the Azure Function App file. Extract archive to your local development computer.

  2. Start VS Code. Choose File in the main menu and select Open Folder.

  3. Select the top level folder from extracted files.

  4. Choose the Azure icon in the Activity bar, then in the Azure: Functions area, choose the Deploy to function app button. 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 If you're already signed in, go to the next step.

  5. Provide the following information at the prompts:

    a. Select folder: Choose a folder from your workspace or browse to one that contains your function app.

    b. Select Subscription: Choose the subscription to use.

    c. Select Create new Function App in Azure (Don't choose the Advanced option)

    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).

    e. Select a runtime: Choose Python 3.11

    f. Select a location for new resources. For better performance and lower costs choose the same region where Microsoft Sentinel is located.

  6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.

  7. Go to Azure Portal for the Function App configuration.

2. Configure the Function App

  1. In the Function App, select the Function App Name and select Configuration.
  2. In the Application settings tab, select + New application setting.
  3. Add each of the following application settings individually, with their respective values (case-sensitive):
    • Workspace ID
    • Workspace Key
    • Armis Secret Key
    • Armis URL https://<armis-instance>.armis.com/api/v1/
    • Armis Alert Table Name
    • Armis Activity Table Name
    • Armis Schedule
    • Avoid Duplicates (Default: true)
    • logAnalyticsUri (optional)
  • 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.
  1. Once all application settings have been entered, click Save.

Next steps

For more information, go to the related solution in the Azure Marketplace.