diff --git a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityAPISentinelConn.zip b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityAPISentinelConn.zip index 9759e96b431..104db769457 100644 Binary files a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityAPISentinelConn.zip and b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityAPISentinelConn.zip differ diff --git a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityConnector/__init__.py b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityConnector/__init__.py index 78c2720a905..df6a9e17023 100644 --- a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityConnector/__init__.py +++ b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurityConnector/__init__.py @@ -7,7 +7,7 @@ import requests import os import azure.functions as func -from typing import List, Dict, Optional +from typing import List, Dict def build_signature(date: str, content_length: int, method: str, content_type: str, resource: str, shared_key: str, customer_id: str) -> str: @@ -46,7 +46,7 @@ def fetch_events(self, token: str, endpoint: str) -> List[Dict]: "Authorization": f"Bearer {token}", "Content-Type": "application/json" } - response = requests.get(endpoint, headers=headers) + response = requests.post(endpoint, headers=headers, json={}) response.raise_for_status() return response.json() @@ -66,10 +66,8 @@ def __init__(self, log_analytics_uri: str, shared_key: str, customer_id: str): self.log_analytics_uri = log_analytics_uri self.shared_key = shared_key self.customer_id = customer_id - self.success_user_events = 0 - self.success_admin_events = 0 - self.failed_user_events = 0 - self.failed_admin_events = 0 + self.success_events = 0 + self.failed_events = 0 self.chunksize = 10000 def post_results(self, data: List[Dict], table: str): @@ -77,15 +75,11 @@ def post_results(self, data: List[Dict], table: str): body = json.dumps(chunk) self.post_data(body, len(chunk), table) - def increase_counters(self, chunk_count: int, table: str, status: str): - if table == "TransmitSecurityUserActivity" and status == "success": - self.success_user_events += chunk_count - elif table == "TransmitSecurityAdminActivity" and status == "success": - self.success_admin_events += chunk_count - elif table == "TransmitSecurityUserActivity" and status == "fail": - self.failed_user_events += chunk_count - elif table == "TransmitSecurityAdminActivity" and status == "fail": - self.failed_admin_events += chunk_count + def increase_counters(self, chunk_count: int, status: str): + if status == "success": + self.success_events += chunk_count + elif status == "fail": + self.failed_events += chunk_count def post_data(self, body: str, chunk_count: int, table: str): method = 'POST' @@ -104,10 +98,10 @@ def post_data(self, body: str, chunk_count: int, table: str): response = requests.post(uri, data=body, headers=headers) if 200 <= response.status_code <= 299: logging.info(f"Chunk processed ({chunk_count} events)") - self.increase_counters(chunk_count, table, "success") + self.increase_counters(chunk_count, "success") else: logging.error(f"Error sending events to Azure Sentinel. Response code: {response.status_code}") - self.increase_counters(chunk_count, table, "fail") + self.increase_counters(chunk_count, "fail") def main(mytimer: func.TimerRequest) -> None: @@ -116,34 +110,30 @@ def main(mytimer: func.TimerRequest) -> None: logging.warning("The timer is past due!") logging.info(f"Python timer trigger function ran at {utc_timestamp}") - + try: - user_activity_endpoint = os.getenv('TransmitSecurityUserActivityEndpoint', None) - admin_activity_endpoint = os.getenv('TransmitSecurityAdminActivityEndpoint', None) + pull_endpoint = os.getenv('TransmitSecurityPullEndpoint', None) token_endpoint = os.getenv('TransmitSecurityTokenEndpoint', '') client_id = os.getenv('TransmitSecurityClientID', '') client_secret = os.getenv('TransmitSecurityClientSecret', '') - user_activity_tbl_name = "TransmitSecurityUserActivity" - admin_activity_tbl_name = "TransmitSecurityAdminActivity" + table_name = "TransmitSecurityActivity" customer_id = os.getenv('WorkspaceID', '') shared_key = os.getenv('WorkspaceKey', '') log_analytics_uri = os.getenv('logAnalyticsUri', f'https://{customer_id}.ods.opinsights.azure.com') - if not user_activity_endpoint and not admin_activity_endpoint: - raise ValueError("One of the endpoints is required to be set.") - + if not pull_endpoint: + raise ValueError("The TransmitSecurityPullEndpoint environment variable is required.") + connector = TransmitSecurityConnector(token_endpoint, client_id, client_secret) azure_sentinel = AzureSentinel(log_analytics_uri, shared_key, customer_id) - + token = connector.get_access_token() - config = zip([user_activity_endpoint, admin_activity_endpoint], [user_activity_tbl_name, admin_activity_tbl_name]) - for endpoint, table in config: - if endpoint: - logging.info(f"Processing events for {table}") - events = connector.fetch_events(token, endpoint) - while events: - azure_sentinel.post_results(events, table) - events = connector.fetch_events(token, endpoint) + + logging.info(f"Processing events for {table_name}") + events = connector.fetch_events(token, pull_endpoint) + while events: + azure_sentinel.post_results(events, table_name) + events = connector.fetch_events(token, pull_endpoint) except ValueError as ve: logging.error(f"Configuration error: {ve}") @@ -155,5 +145,5 @@ def main(mytimer: func.TimerRequest) -> None: logging.error(f"Unexpected error: {e}") raise - logging.info(f"Events processed successfully - Admin: {azure_sentinel.success_admin_events}, User: {azure_sentinel.success_user_events}") - logging.info(f"Events failed - Admin: {azure_sentinel.failed_admin_events}, User: {azure_sentinel.failed_user_events}") \ No newline at end of file + logging.info(f"Events processed successfully: {azure_sentinel.success_events}") + logging.info(f"Events failed: {azure_sentinel.failed_events}") diff --git a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurity_API_FunctionApp.JSON b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurity_API_FunctionApp.JSON index b4c425e7559..9c160d57522 100644 --- a/Solutions/TransmitSecurity/Data Connectors/TransmitSecurity_API_FunctionApp.JSON +++ b/Solutions/TransmitSecurity/Data Connectors/TransmitSecurity_API_FunctionApp.JSON @@ -1,140 +1,129 @@ { - "id": "TransmitSecurity", - "title": "Transmit Security Connector", - "publisher": "TransmitSecurity", - "descriptionMarkdown": "The [Transmit Security] data connector provides the capability to ingest common Transmit Security API events into Microsoft Sentinel through the REST API. [Refer to API documentation for more information](https://developer.transmitsecurity.com/). The connector provides ability to get events which helps to examine potential security risks, analyze your team's use of collaboration, diagnose configuration problems and more.", - "graphQueries": [ - { - "metricName": "Admin activities data received", - "legend": "TransmitSecurityAdminActivity_CL", - "baseQuery": "TransmitSecurityAdminActivity_CL" - }, - { - "metricName": "User activities data received", - "legend": "TransmitSecurityUserActivity_CL", - "baseQuery": "TransmitSecurityUserActivity_CL" - } - ], - "sampleQueries": [ - { - "name": "All admin activities", - "query": "TransmitSecurityAdminActivity_CL\n | sort by TimeGenerated desc" - }, - { - "name": "All user activities", - "query": "TransmitSecurityUserActivity_CL\n | sort by TimeGenerated desc" - } - ], - "dataTypes": [ - { - "name": "TransmitSecurityAdminActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityAdminActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" - }, - { - "name": "TransmitSecurityUserActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityUserActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" - } - ], - "connectivityCriterias": [ - { - "type": "IsConnectedQuery", - "value": [ - "TransmitSecurityAdminActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)", - "TransmitSecurityUserActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" - ] - } - ], - "availability": { - "status": 1, - "isPreview": false - }, - "permissions": { - "resourceProvider": [{ - "provider": "Microsoft.OperationalInsights/workspaces", - "permissionsDisplayText": "read and write permissions on the workspace are required.", - "providerDisplayName": "Workspace", - "scope": "Workspace", - "requiredPermissions": { - "write": true, - "read": true, - "delete": true - } - }, - { - "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", - "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", - "providerDisplayName": "Keys", - "scope": "Workspace", - "requiredPermissions": { - "action": true - } - } - ], - "customs": [ - { - "name": "Microsoft.Web/sites permissions", - "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." - }, - { - "name": "REST API Client ID", - "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." - }, - { - "name": "REST API Client Secret", - "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." - } - ] - }, - "instructionSteps": [{ - "title": "", - "description": ">**NOTE:** This connector uses Azure Functions to connect to the Transmit Security 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." - }, - { - "title": "", - "description": ">**(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](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." - }, - { - "title": "", - "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\n Follow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." - }, - { - "title": "", - "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Transmit Security data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following).", - "instructions": [{ - "parameters": { - "fillWith": [ - "WorkspaceId" - ], - "label": "Workspace ID" - }, - "type": "CopyableLabel" - }, - { - "parameters": { - "fillWith": [ - "PrimaryKey" - ], - "label": "Primary Key" - }, - "type": "CopyableLabel" - } - ] - }, - { - "title": "Option 1 - Azure Resource Manager (ARM) Template", - "description": "Use this method for automated deployment of the Transmit Security Audit data connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select existing resource group without Windows apps in it or create new resource group.\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityUserActivityEndpoint**, **TransmitSecurityAdminActivityEndpoint**, **TransmitSecurityTokenEndpoint** and deploy. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." - }, - { - "title": "Option 2 - Manual Deployment of Azure Functions", - "description": "Use the following step-by-step instructions to deploy the TransmitSecurity Reports data connector manually with Azure Functions (Deployment via Visual Studio Code)." - }, - { - "title": "", - "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract archive to your local development computer.\n2. Start VS Code. Choose File in the main menu and select Open Folder.\n3. Select the top level folder from extracted files.\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\nIf 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**\nIf you're already signed in, go to the next step.\n5. Provide the following information at the prompts:\n\n\ta. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n\tb. **Select Subscription:** Choose the subscription to use.\n\n\tc. Select **Create new Function App in Azure** (Don't choose the Advanced option)\n\n\td. **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.\n\n\te. **Select a runtime:** Choose Python 3.11.\n\n\tf. 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n7. Go to Azure Portal for the Function App configuration." - }, - { - "title": "", - "description": "**2. Configure the Function App**\n\n 1. In the Function App, select the Function App Name and select **Configuration**.\n\n 2. Select **Environment variables**.\n\n 3. Add each of the following application settings individually, with their respective string values (case-sensitive): \n\t\t TransmitSecurityClientID\n\t\t TransmitSecurityClientSecret\n\t\t TransmitSecurityAdminActivityEndpoint\n\t\t TransmitSecurityUserActivityEndpoint\n\t\t TransmitSecurityTokenEndpoint\n\t\t WorkspaceID\n\t\t WorkspaceKey\n\t\t logAnalyticsUri (optional)\n\n> - 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://.ods.opinsights.azure.us`.\n\n 4. Once all application settings have been entered, click **Apply**." - } - ] -} \ No newline at end of file + "id": "TransmitSecurity", + "title": "Transmit Security Connector", + "publisher": "TransmitSecurity", + "descriptionMarkdown": "The [Transmit Security] data connector provides the capability to ingest common Transmit Security API events into Microsoft Sentinel through the REST API. [Refer to API documentation for more information](https://developer.transmitsecurity.com/). The connector provides ability to get events which helps to examine potential security risks, analyze your team's use of collaboration, diagnose configuration problems and more.", + "graphQueries": [ + { + "metricName": "Activity data received", + "legend": "TransmitSecurityActivity_CL", + "baseQuery": "TransmitSecurityActivity_CL" + } + ], + "sampleQueries": [ + { + "name": "All activities", + "query": "TransmitSecurityActivity_CL\n | sort by TimeGenerated desc" + } + ], + "dataTypes": [ + { + "name": "TransmitSecurityActivity_CL", + "lastDataReceivedQuery": "TransmitSecurityActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriterias": [ + { + "type": "IsConnectedQuery", + "value": [ + "TransmitSecurityActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": false + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "REST API Client ID", + "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + }, + { + "name": "REST API Client Secret", + "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to the Transmit Security 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." + }, + { + "title": "", + "description": ">**(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](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\nFollow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Transmit Security data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following).", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Transmit Security data connector using an ARM Template.\n\n1. Click the **Deploy to Azure** button below.\n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group**, and **Location**.\n\n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select an existing resource group without Windows apps in it or create a new resource group.\n\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityPullEndpoint**, **TransmitSecurityTokenEndpoint**, and deploy.\n\n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**.\n\n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Transmit Security data connector manually with Azure Functions (Deployment via Visual Studio Code)." + }, + { + "title": "", + "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS Code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract the archive to your local development computer.\n\n2. Start VS Code. Choose **File** in the main menu and select **Open Folder**.\n\n3. Select the top-level folder from the extracted files.\n\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\n\n 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**.\n\n If you're already signed in, go to the next step.\n\n5. Provide the following information at the prompts:\n\n a. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n b. **Select Subscription:** Choose the subscription to use.\n\n c. Select **Create new Function App in Azure** (Don't choose the Advanced option).\n\n 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.\n\n e. **Select a runtime:** Choose Python 3.11.\n\n 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n\n7. Go to the Azure Portal for the Function App configuration." + }, + { + "title": "", + "description": "**2. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n\n2. Select **Environment variables**.\n\n3. Add each of the following application settings individually, with their respective string values (case-sensitive):\n\n - **TransmitSecurityClientID**\n - **TransmitSecurityClientSecret**\n - **TransmitSecurityPullEndpoint**\n - **TransmitSecurityTokenEndpoint**\n - **WorkspaceID**\n - **WorkspaceKey**\n - **logAnalyticsUri** (optional)\n\n > - Use **logAnalyticsUri** to override the log analytics API endpoint for a dedicated cloud. For example, for the public cloud, leave the value empty; for the Azure GovUS cloud environment, specify the value in the following format: `https://.ods.opinsights.azure.us`.\n\n4. Once all application settings have been entered, click **Apply**." + } + ] + } diff --git a/Solutions/TransmitSecurity/Data Connectors/azuredeploy_Connector_TransmitSecurityAPI_AzureFunction.json b/Solutions/TransmitSecurity/Data Connectors/azuredeploy_Connector_TransmitSecurityAPI_AzureFunction.json index a2ed464b787..1b141ca83fe 100644 --- a/Solutions/TransmitSecurity/Data Connectors/azuredeploy_Connector_TransmitSecurityAPI_AzureFunction.json +++ b/Solutions/TransmitSecurity/Data Connectors/azuredeploy_Connector_TransmitSecurityAPI_AzureFunction.json @@ -24,13 +24,9 @@ "type": "string", "defaultValue": "" }, - "TransmitSecurityUserActivityEndpoint": { + "TransmitSecurityPullEndpoint": { "type": "string", - "defaultValue": "" - }, - "TransmitSecurityAdminActivityEndpoint": { - "type": "string", - "defaultValue": "" + "defaultValue": "" }, "TransmitSecurityTokenEndpoint": { "type": "string", @@ -39,14 +35,14 @@ "AppInsightsWorkspaceResourceID": { "type": "string", "metadata": { - "description": "Migrate Classic Application Insights to Log Analytic Workspace which is retiring by 29 Febraury 2024. Use 'Log Analytic Workspace-->Properties' blade having 'Resource ID' property value. This is a fully qualified resourceId which is in format '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}'" + "description": "Migrate Classic Application Insights to Log Analytic Workspace which is retiring by 29 February 2024. Use 'Log Analytic Workspace-->Properties' blade having 'Resource ID' property value. This is a fully qualified resourceId which is in format '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}'" } } }, "variables": { "FunctionName": "[concat(toLower(parameters('FunctionName')), uniqueString(resourceGroup().id))]", - "StorageSuffix": "[environment().suffixes.storage]", - "LogAnaltyicsUri": "[replace(environment().portal, 'https://portal', concat('https://', toLower(parameters('WorkspaceID')), '.ods.opinsights'))]" + "StorageSuffix": "[environment().suffixes.storage]", + "LogAnaltyicsUri": "[replace(environment().portal, 'https://portal', concat('https://', toLower(parameters('WorkspaceID')), '.ods.opinsights'))]" }, "resources": [ { @@ -173,8 +169,7 @@ "WorkspaceKey": "[parameters('WorkspaceKey')]", "TransmitSecurityClientID": "[parameters('TransmitSecurityClientID')]", "TransmitSecurityClientSecret": "[parameters('TransmitSecurityClientSecret')]", - "TransmitSecurityUserActivityEndpoint": "[parameters('TransmitSecurityUserActivityEndpoint')]", - "TransmitSecurityAdminActivityEndpoint": "[parameters('TransmitSecurityAdminActivityEndpoint')]", + "TransmitSecurityPullEndpoint": "[parameters('TransmitSecurityPullEndpoint')]", "TransmitSecurityTokenEndpoint": "[parameters('TransmitSecurityTokenEndpoint')]", "WEBSITE_RUN_FROM_PACKAGE": "https://aka.ms/sentinel-TransmitSecurityAPI-functionapp" } diff --git a/Solutions/TransmitSecurity/Data Connectors/readme.md b/Solutions/TransmitSecurity/Data Connectors/readme.md index ce6cd970087..bc964cbe723 100644 --- a/Solutions/TransmitSecurity/Data Connectors/readme.md +++ b/Solutions/TransmitSecurity/Data Connectors/readme.md @@ -2,16 +2,16 @@ ## Introduction -This folder contains the Azure function time trigger code for the Transmit Security-Microsoft Sentinel connector. The connector will run periodically and ingest the Transmit Security data into the Microsoft Sentinel logs custom table `TransmitSecurityAdminActivity_CL` and `TransmitSecurityUserActivity_CL`. +This folder contains the Azure Function Time Trigger code for the Transmit Security-Microsoft Sentinel connector. The connector will run periodically and ingest Transmit Security data into the Microsoft Sentinel logs custom table `TransmitSecurityActivity_CL`. ## Folders -1. **TransmitSecurity/** - This contains the package, requirements, ARM JSON file, connector page template JSON, and other dependencies. -2. **TransmitSecurityConnector/** - This contains the Azure function source code along with sample data. +1. **TransmitSecurity/** - Contains the package, requirements, ARM JSON file, connector page template JSON, and other dependencies. +2. **TransmitSecurityConnector/** - Contains the Azure Function source code along with sample data. ## Installing for Users -After the solution is published, we can find the connector in the connector gallery of Microsoft Sentinel among other connectors in the Data connectors section of Sentinel. +After the solution is published, you can find the connector in the connector gallery of Microsoft Sentinel among other connectors in the Data Connectors section. 1. Go to **Microsoft Sentinel** -> **Data Connectors**. 2. Click on the **Transmit Security connector**; the connector page will open. @@ -19,21 +19,21 @@ After the solution is published, we can find the connector in the connector gall This will lead to a custom deployment page where, after entering accurate credentials and other information, the resources will be created. -The connector should start ingesting the data into the logs in the next 10-15 minutes. +The connector should start ingesting data into the logs within the next 10-15 minutes. ## Installing for Testing 1. Log in to the Azure portal using the URL - [https://aka.ms/sentineldataconnectorvalidateurl](https://aka.ms/sentineldataconnectorvalidateurl). 2. Go to **Microsoft Sentinel** -> **Data Connectors**. -3. Click the **import** button at the top and select the JSON file `TransmitSecurity_API_FunctionApp.JSON` downloaded on your local machine from GitHub. +3. Click the **Import** button at the top and select the JSON file `TransmitSecurity_API_FunctionApp.JSON` downloaded on your local machine from GitHub. 4. This will load the connector page; the rest of the process will be the same as the **Installing for Users** guideline above. ## Monitoring the Function Each invocation and its logs of the function can be seen in the Function App service of Azure, available in the Azure Portal outside Microsoft Sentinel. -1. Go to **Function App** and click on the function you have deployed, identified with the given name at the deployment stage. -2. Go to **Functions** -> **Transmit Security Connector** -> **Monitor**. +1. Go to **Function App** and click on the function you have deployed, identified by the name given at the deployment stage. +2. Go to **Functions** -> **TransmitSecurityConnector** -> **Monitor**. 3. By clicking on the invocation time, you can see all the logs for that run. -**Note:** For more detailed logs, you can check Application Insights of the given function. You can search the logs by operation ID in the Transaction search section. \ No newline at end of file +**Note:** For more detailed logs, check Application Insights of the function. You can search the logs by operation ID in the Transaction search section. diff --git a/Solutions/TransmitSecurity/Data/Solution_TransmitSecurity.json b/Solutions/TransmitSecurity/Data/Solution_TransmitSecurity.json index a33910967f5..1dda57848dd 100644 --- a/Solutions/TransmitSecurity/Data/Solution_TransmitSecurity.json +++ b/Solutions/TransmitSecurity/Data/Solution_TransmitSecurity.json @@ -8,7 +8,7 @@ "Data Connectors/TransmitSecurity_API_FunctionApp.json" ], "BasePath": "C:\\GitHub\\Azure-Sentinel\\Solutions\\TransmitSecurity\\", - "Version": "3.0.1", + "Version": "3.0.2", "Metadata": "SolutionMetadata.json", "TemplateSpec": true, "Is1Pconnector": false diff --git a/Solutions/TransmitSecurity/Package/3.0.1.zip b/Solutions/TransmitSecurity/Package/3.0.1.zip index 63c7bc06ab1..8f4613d1c0a 100644 Binary files a/Solutions/TransmitSecurity/Package/3.0.1.zip and b/Solutions/TransmitSecurity/Package/3.0.1.zip differ diff --git a/Solutions/TransmitSecurity/Package/mainTemplate.json b/Solutions/TransmitSecurity/Package/mainTemplate.json index cce7fce096b..4f782cbc26a 100644 --- a/Solutions/TransmitSecurity/Package/mainTemplate.json +++ b/Solutions/TransmitSecurity/Package/mainTemplate.json @@ -76,42 +76,28 @@ "descriptionMarkdown": "The [Transmit Security] data connector provides the capability to ingest common Transmit Security API events into Microsoft Sentinel through the REST API. [Refer to API documentation for more information](https://developer.transmitsecurity.com/). The connector provides ability to get events which helps to examine potential security risks, analyze your team's use of collaboration, diagnose configuration problems and more.", "graphQueries": [ { - "metricName": "Admin activities data received", - "legend": "TransmitSecurityAdminActivity_CL", - "baseQuery": "TransmitSecurityAdminActivity_CL" - }, - { - "metricName": "User activities data received", - "legend": "TransmitSecurityUserActivity_CL", - "baseQuery": "TransmitSecurityUserActivity_CL" + "metricName": "Activity data received", + "legend": "TransmitSecurityActivity_CL", + "baseQuery": "TransmitSecurityActivity_CL" } ], "sampleQueries": [ { - "name": "All admin activities", - "query": "TransmitSecurityAdminActivity_CL\n | sort by TimeGenerated desc" - }, - { - "name": "All user activities", - "query": "TransmitSecurityUserActivity_CL\n | sort by TimeGenerated desc" + "name": "All activities", + "query": "TransmitSecurityActivity_CL\n | sort by TimeGenerated desc" } ], "dataTypes": [ { - "name": "TransmitSecurityAdminActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityAdminActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" - }, - { - "name": "TransmitSecurityUserActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityUserActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + "name": "TransmitSecurityActivity_CL", + "lastDataReceivedQuery": "TransmitSecurityActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" } ], "connectivityCriterias": [ { "type": "IsConnectedQuery", "value": [ - "TransmitSecurityAdminActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)", - "TransmitSecurityUserActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" + "TransmitSecurityActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" ] } ], @@ -149,11 +135,11 @@ }, { "name": "REST API Client ID", - "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." }, { "name": "REST API Client Secret", - "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." } ] }, @@ -165,7 +151,7 @@ "description": ">**(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](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." }, { - "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\n Follow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." + "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\nFollow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." }, { "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Transmit Security data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following).", @@ -191,18 +177,18 @@ ] }, { - "description": "Use this method for automated deployment of the Transmit Security Audit data connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select existing resource group without Windows apps in it or create new resource group.\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityUserActivityEndpoint**, **TransmitSecurityAdminActivityEndpoint**, **TransmitSecurityTokenEndpoint** and deploy. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy.", + "description": "Use this method for automated deployment of the Transmit Security data connector using an ARM Template.\n\n1. Click the **Deploy to Azure** button below.\n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group**, and **Location**.\n\n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select an existing resource group without Windows apps in it or create a new resource group.\n\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityPullEndpoint**, **TransmitSecurityTokenEndpoint**, and deploy.\n\n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**.\n\n5. Click **Purchase** to deploy.", "title": "Option 1 - Azure Resource Manager (ARM) Template" }, { - "description": "Use the following step-by-step instructions to deploy the TransmitSecurity Reports data connector manually with Azure Functions (Deployment via Visual Studio Code).", + "description": "Use the following step-by-step instructions to deploy the Transmit Security data connector manually with Azure Functions (Deployment via Visual Studio Code).", "title": "Option 2 - Manual Deployment of Azure Functions" }, { - "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract archive to your local development computer.\n2. Start VS Code. Choose File in the main menu and select Open Folder.\n3. Select the top level folder from extracted files.\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\nIf 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**\nIf you're already signed in, go to the next step.\n5. Provide the following information at the prompts:\n\n\ta. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n\tb. **Select Subscription:** Choose the subscription to use.\n\n\tc. Select **Create new Function App in Azure** (Don't choose the Advanced option)\n\n\td. **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.\n\n\te. **Select a runtime:** Choose Python 3.11.\n\n\tf. 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n7. Go to Azure Portal for the Function App configuration." + "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS Code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract the archive to your local development computer.\n\n2. Start VS Code. Choose **File** in the main menu and select **Open Folder**.\n\n3. Select the top-level folder from the extracted files.\n\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\n\n 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**.\n\n If you're already signed in, go to the next step.\n\n5. Provide the following information at the prompts:\n\n a. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n b. **Select Subscription:** Choose the subscription to use.\n\n c. Select **Create new Function App in Azure** (Don't choose the Advanced option).\n\n 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.\n\n e. **Select a runtime:** Choose Python 3.11.\n\n 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n\n7. Go to the Azure Portal for the Function App configuration." }, { - "description": "**2. Configure the Function App**\n\n 1. In the Function App, select the Function App Name and select **Configuration**.\n\n 2. Select **Environment variables**.\n\n 3. Add each of the following application settings individually, with their respective string values (case-sensitive): \n\t\t TransmitSecurityClientID\n\t\t TransmitSecurityClientSecret\n\t\t TransmitSecurityAdminActivityEndpoint\n\t\t TransmitSecurityUserActivityEndpoint\n\t\t TransmitSecurityTokenEndpoint\n\t\t WorkspaceID\n\t\t WorkspaceKey\n\t\t logAnalyticsUri (optional)\n\n> - 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://.ods.opinsights.azure.us`.\n\n 4. Once all application settings have been entered, click **Apply**." + "description": "**2. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n\n2. Select **Environment variables**.\n\n3. Add each of the following application settings individually, with their respective string values (case-sensitive):\n\n - **TransmitSecurityClientID**\n - **TransmitSecurityClientSecret**\n - **TransmitSecurityPullEndpoint**\n - **TransmitSecurityTokenEndpoint**\n - **WorkspaceID**\n - **WorkspaceKey**\n - **logAnalyticsUri** (optional)\n\n > - Use **logAnalyticsUri** to override the log analytics API endpoint for a dedicated cloud. For example, for the public cloud, leave the value empty; for the Azure GovUS cloud environment, specify the value in the following format: `https://.ods.opinsights.azure.us`.\n\n4. Once all application settings have been entered, click **Apply**." } ] } @@ -288,43 +274,29 @@ "descriptionMarkdown": "The [Transmit Security] data connector provides the capability to ingest common Transmit Security API events into Microsoft Sentinel through the REST API. [Refer to API documentation for more information](https://developer.transmitsecurity.com/). The connector provides ability to get events which helps to examine potential security risks, analyze your team's use of collaboration, diagnose configuration problems and more.", "graphQueries": [ { - "metricName": "Admin activities data received", - "legend": "TransmitSecurityAdminActivity_CL", - "baseQuery": "TransmitSecurityAdminActivity_CL" - }, - { - "metricName": "User activities data received", - "legend": "TransmitSecurityUserActivity_CL", - "baseQuery": "TransmitSecurityUserActivity_CL" + "metricName": "Activity data received", + "legend": "TransmitSecurityActivity_CL", + "baseQuery": "TransmitSecurityActivity_CL" } ], "dataTypes": [ { - "name": "TransmitSecurityAdminActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityAdminActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" - }, - { - "name": "TransmitSecurityUserActivity_CL", - "lastDataReceivedQuery": "TransmitSecurityUserActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + "name": "TransmitSecurityActivity_CL", + "lastDataReceivedQuery": "TransmitSecurityActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" } ], "connectivityCriterias": [ { "type": "IsConnectedQuery", "value": [ - "TransmitSecurityAdminActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)", - "TransmitSecurityUserActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" + "TransmitSecurityActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(3d)" ] } ], "sampleQueries": [ { - "name": "All admin activities", - "query": "TransmitSecurityAdminActivity_CL\n | sort by TimeGenerated desc" - }, - { - "name": "All user activities", - "query": "TransmitSecurityUserActivity_CL\n | sort by TimeGenerated desc" + "name": "All activities", + "query": "TransmitSecurityActivity_CL\n | sort by TimeGenerated desc" } ], "availability": { @@ -361,11 +333,11 @@ }, { "name": "REST API Client ID", - "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + "description": "**TransmitSecurityClientID** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." }, { "name": "REST API Client Secret", - "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." + "description": "**TransmitSecurityClientSecret** is required. See the documentation to learn more about API on the `https://developer.transmitsecurity.com/`." } ] }, @@ -377,7 +349,7 @@ "description": ">**(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](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." }, { - "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\n Follow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." + "description": "**STEP 1 - Configuration steps for the Transmit Security API**\n\nFollow the instructions to obtain the credentials.\n\n1. Log in to the Transmit Security Portal.\n2. Configure a [management app](https://developer.transmitsecurity.com/guides/user/management_apps/). Give the app a suitable name, for example, MyAzureSentinelCollector.\n3. Save credentials of the new user for using in the data connector." }, { "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Transmit Security data connector, have the Workspace ID and Workspace Primary Key (can be copied from the following).", @@ -403,18 +375,18 @@ ] }, { - "description": "Use this method for automated deployment of the Transmit Security Audit data connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select existing resource group without Windows apps in it or create new resource group.\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityUserActivityEndpoint**, **TransmitSecurityAdminActivityEndpoint**, **TransmitSecurityTokenEndpoint** and deploy. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy.", + "description": "Use this method for automated deployment of the Transmit Security data connector using an ARM Template.\n\n1. Click the **Deploy to Azure** button below.\n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy) [![Deploy to Azure Gov](https://aka.ms/deploytoazuregovbutton)](https://aka.ms/sentinel-TransmitSecurityAPI-azuredeploy-gov)\n\n2. Select the preferred **Subscription**, **Resource Group**, and **Location**.\n\n> **NOTE:** Within the same resource group, you can't mix Windows and Linux apps in the same region. Select an existing resource group without Windows apps in it or create a new resource group.\n\n3. Enter the **TransmitSecurityClientID**, **TransmitSecurityClientSecret**, **TransmitSecurityPullEndpoint**, **TransmitSecurityTokenEndpoint**, and deploy.\n\n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**.\n\n5. Click **Purchase** to deploy.", "title": "Option 1 - Azure Resource Manager (ARM) Template" }, { - "description": "Use the following step-by-step instructions to deploy the TransmitSecurity Reports data connector manually with Azure Functions (Deployment via Visual Studio Code).", + "description": "Use the following step-by-step instructions to deploy the Transmit Security data connector manually with Azure Functions (Deployment via Visual Studio Code).", "title": "Option 2 - Manual Deployment of Azure Functions" }, { - "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract archive to your local development computer.\n2. Start VS Code. Choose File in the main menu and select Open Folder.\n3. Select the top level folder from extracted files.\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\nIf 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**\nIf you're already signed in, go to the next step.\n5. Provide the following information at the prompts:\n\n\ta. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n\tb. **Select Subscription:** Choose the subscription to use.\n\n\tc. Select **Create new Function App in Azure** (Don't choose the Advanced option)\n\n\td. **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.\n\n\te. **Select a runtime:** Choose Python 3.11.\n\n\tf. 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n7. Go to Azure Portal for the Function App configuration." + "description": "**1. Deploy a Function App**\n\n> **NOTE:** You will need to [prepare VS Code](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-python#prerequisites) for Azure function development.\n\n1. Download the [Azure Function App](https://aka.ms/sentinel-TransmitSecurityAPI-functionapp) file. Extract the archive to your local development computer.\n\n2. Start VS Code. Choose **File** in the main menu and select **Open Folder**.\n\n3. Select the top-level folder from the extracted files.\n\n4. Choose the Azure icon in the Activity bar, then in the **Azure: Functions** area, choose the **Deploy to function app** button.\n\n 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**.\n\n If you're already signed in, go to the next step.\n\n5. Provide the following information at the prompts:\n\n a. **Select folder:** Choose a folder from your workspace or browse to one that contains your function app.\n\n b. **Select Subscription:** Choose the subscription to use.\n\n c. Select **Create new Function App in Azure** (Don't choose the Advanced option).\n\n 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.\n\n e. **Select a runtime:** Choose Python 3.11.\n\n 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.\n\n6. Deployment will begin. A notification is displayed after your function app is created and the deployment package is applied.\n\n7. Go to the Azure Portal for the Function App configuration." }, { - "description": "**2. Configure the Function App**\n\n 1. In the Function App, select the Function App Name and select **Configuration**.\n\n 2. Select **Environment variables**.\n\n 3. Add each of the following application settings individually, with their respective string values (case-sensitive): \n\t\t TransmitSecurityClientID\n\t\t TransmitSecurityClientSecret\n\t\t TransmitSecurityAdminActivityEndpoint\n\t\t TransmitSecurityUserActivityEndpoint\n\t\t TransmitSecurityTokenEndpoint\n\t\t WorkspaceID\n\t\t WorkspaceKey\n\t\t logAnalyticsUri (optional)\n\n> - 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://.ods.opinsights.azure.us`.\n\n 4. Once all application settings have been entered, click **Apply**." + "description": "**2. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n\n2. Select **Environment variables**.\n\n3. Add each of the following application settings individually, with their respective string values (case-sensitive):\n\n - **TransmitSecurityClientID**\n - **TransmitSecurityClientSecret**\n - **TransmitSecurityPullEndpoint**\n - **TransmitSecurityTokenEndpoint**\n - **WorkspaceID**\n - **WorkspaceKey**\n - **logAnalyticsUri** (optional)\n\n > - Use **logAnalyticsUri** to override the log analytics API endpoint for a dedicated cloud. For example, for the public cloud, leave the value empty; for the Azure GovUS cloud environment, specify the value in the following format: `https://.ods.opinsights.azure.us`.\n\n4. Once all application settings have been entered, click **Apply**." } ], "id": "[variables('_uiConfigId1')]" @@ -462,7 +434,7 @@ ] }, "firstPublishDate": "2024-06-10", - "lastPublishDate": "2024-06-10", + "lastPublishDate": "2024-11-20", "providers": [ "TransmitSecurity" ], diff --git a/Solutions/TransmitSecurity/ReleaseNotes.md b/Solutions/TransmitSecurity/ReleaseNotes.md index 1a5961d5093..ebcdba34e81 100644 --- a/Solutions/TransmitSecurity/ReleaseNotes.md +++ b/Solutions/TransmitSecurity/ReleaseNotes.md @@ -1,4 +1,5 @@ -| **Version** | **Date Modified (DD-MM-YYYY)** | **Change History** | -|-------------|--------------------------------|------------------------------------| -| 3.0.1 | 03-09-2024 | Updated the python runtime version to 3.11 | -| 3.0.0 | 11-07-2024 | Initial Solution Release | +| **Version** | **Date Modified (DD-MM-YYYY)** | **Change History** | +|-------------|--------------------------------|-----------------------------------------------------| +| 3.0.2 | 20-11-2024 | Change Functions to support one endpoint at a time | +| 3.0.1 | 03-09-2024 | Updated the python runtime version to 3.11 | +| 3.0.0 | 11-07-2024 | Initial Solution Release | diff --git a/Solutions/TransmitSecurity/SolutionMetadata.json b/Solutions/TransmitSecurity/SolutionMetadata.json index a5fa4f2c89e..52adfbf3b23 100644 --- a/Solutions/TransmitSecurity/SolutionMetadata.json +++ b/Solutions/TransmitSecurity/SolutionMetadata.json @@ -2,7 +2,7 @@ "publisherId": "transmitsecurity", "offerId": "microsoft-sentinel-solution-transmitsecurity", "firstPublishDate": "2024-06-10", - "lastPublishDate": "2024-06-10", + "lastPublishDate": "2024-11-20", "providers": ["TransmitSecurity"], "categories": { "domains" : ["Security - Threat Protection"],