|
| 1 | +--- |
| 2 | +title: "CommvaultSecurityIQ (using Azure Functions) connector for Microsoft Sentinel" |
| 3 | +description: "Learn how to install the connector CommvaultSecurityIQ (using Azure Functions) to connect your data source to Microsoft Sentinel." |
| 4 | +author: cwatson-cat |
| 5 | +ms.topic: how-to |
| 6 | +ms.date: 11/20/2024 |
| 7 | +ms.service: microsoft-sentinel |
| 8 | +ms.author: cwatson |
| 9 | +ms.collection: sentinel-data-connector |
| 10 | +--- |
| 11 | + |
| 12 | +# CommvaultSecurityIQ (using Azure Functions) connector for Microsoft Sentinel |
| 13 | + |
| 14 | +This Azure Function enables Commvault users to ingest alerts/events into their Microsoft Sentinel instance. With Analytic Rules,Microsoft Sentinel can automatically create Microsoft Sentinel incidents from incoming events and logs. |
| 15 | + |
| 16 | +This is autogenerated content. For changes, contact the solution provider. |
| 17 | + |
| 18 | +## Connector attributes |
| 19 | + |
| 20 | +| Connector attribute | Description | |
| 21 | +| --- | --- | |
| 22 | +| **Application settings** | apiUsername<br/>apipassword<br/>apiToken<br/>workspaceID<br/>workspaceKey<br/>uri<br/>logAnalyticsUri (optional)(add any other settings required by the Function App)Set the <code>uri</code> value to: <code><add uri value></code> | |
| 23 | +| **Azure function app code** | Add%20GitHub%20link%20to%20Function%20App%20code | |
| 24 | +| **Log Analytics table(s)** | CommvaultSecurityIQ_CL<br/> | |
| 25 | +| **Data collection rules support** | Not currently supported | |
| 26 | +| **Supported by** | [Commvault](https://www.commvault.com/support) | |
| 27 | + |
| 28 | +## Query samples |
| 29 | + |
| 30 | +**Last 10 events/alerts ** |
| 31 | + |
| 32 | + ```kusto |
| 33 | +CommvaultSecurityIQ_CL |
| 34 | +
|
| 35 | + | where TimeGenerated > ago(24h) |
| 36 | +
|
| 37 | + | limit 10 |
| 38 | + ``` |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +## Prerequisites |
| 43 | + |
| 44 | +To integrate with CommvaultSecurityIQ (using Azure Functions) make sure you have: |
| 45 | + |
| 46 | +- **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/). |
| 47 | +- **Commvault Environment Endpoint URL**: Make sure to follow the documentation and set the secret value in KeyVault |
| 48 | +- **Commvault QSDK Token**: Make sure to follow the documentation and set the secret value in KeyVault |
| 49 | + |
| 50 | + |
| 51 | +## Vendor installation instructions |
| 52 | + |
| 53 | + |
| 54 | +> [!NOTE] |
| 55 | + > This connector uses Azure Functions to connect to a Commvault Instance 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. |
| 56 | +
|
| 57 | + |
| 58 | +>**(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. |
| 59 | +
|
| 60 | + |
| 61 | +**STEP 1 - Configuration steps for the Commvalut QSDK Token** |
| 62 | + |
| 63 | +[Follow these instructions](/cloud-app-security/api-authentication) to create an API Token. |
| 64 | + |
| 65 | + |
| 66 | +**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function** |
| 67 | + |
| 68 | +>**IMPORTANT:** Before deploying the CommvaultSecurityIQ data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Commvault Endpoint URL and QSDK Token, readily available. |
| 69 | +
|
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +**Option 1 - Azure Resource Manager (ARM) Template** |
| 74 | + |
| 75 | +Use this method for automated deployment of the Commvault Security IQ data connector. |
| 76 | + |
| 77 | +1. Click the **Deploy to Azure** button below. |
| 78 | + |
| 79 | + [](https://aka.ms/sentinel-CommvaultSecurityIQ-azuredeploy) |
| 80 | +2. Select the preferred **Subscription**, **Resource Group** and **Location**. |
| 81 | +3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password**, 'and/or Other required fields'. |
| 82 | +>Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](/azure/app-service/app-service-key-vault-references) for further details. |
| 83 | +4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. |
| 84 | +5. Click **Purchase** to deploy. |
| 85 | + |
| 86 | + |
| 87 | +**Option 2 - Manual Deployment of Azure Functions** |
| 88 | + |
| 89 | + Use the following step-by-step instructions to deploy the CommvaultSecurityIQ data connector manually with Azure Functions. |
| 90 | + |
| 91 | +1. Create a Function App |
| 92 | + |
| 93 | +1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp). |
| 94 | +2. Click **+ Add** at the top. |
| 95 | +3. In the **Basics** tab, ensure Runtime stack is set to **'Add Required Language'**. |
| 96 | +4. In the **Hosting** tab, ensure **Plan type** is set to **'Add Plan Type'**. |
| 97 | +5. 'Add other required configurations'. |
| 98 | +5. 'Make other preferable configuration changes', if needed, then click **Create**. |
| 99 | + |
| 100 | +2. Import Function App Code |
| 101 | + |
| 102 | +1. In the newly created Function App, select **Functions** from the navigation menu and click **+ Add**. |
| 103 | +2. Select **Timer Trigger**. |
| 104 | +3. Enter a unique Function **Name** in the New Function field and leave the default cron schedule of every 5 minutes, then click **Create Function**. |
| 105 | +4. Click on the function name and click **Code + Test** from the left pane. |
| 106 | +5. Copy the [Function App Code](<Add GitHub link to Function App code>) and paste into the Function App `run.ps1` editor. |
| 107 | +6. Click **Save**. |
| 108 | + |
| 109 | +3. Configure the Function App |
| 110 | + |
| 111 | +1. In the Function App screen, click the Function App name and select **Configuration**. |
| 112 | +2. In the **Application settings** tab, select **+ New application setting**. |
| 113 | +3. Add each of the following 'x (number of)' application settings individually, under Name, with their respective string values (case-sensitive) under Value: |
| 114 | + apiUsername |
| 115 | + apipassword |
| 116 | + apiToken |
| 117 | + workspaceID |
| 118 | + workspaceKey |
| 119 | + uri |
| 120 | + logAnalyticsUri (optional) |
| 121 | +(add any other settings required by the Function App) |
| 122 | +Set the `uri` value to: `<add uri value>` |
| 123 | +>Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Azure Key Vault references documentation](/azure/app-service/app-service-key-vault-references) for further details. |
| 124 | + - 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. |
| 125 | +4. Once all application settings have been entered, click **Save**. |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | +## Next steps |
| 130 | + |
| 131 | +For more information, go to the [related solution](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/commvault.microsoft-sentinel-solution-commvaultsecurityiq?tab=Overview) in the Azure Marketplace. |
0 commit comments