Skip to content

Commit 21d447f

Browse files
committed
Update v3 to render correctly also permissions
1 parent b95b15d commit 21d447f

34 files changed

+1305
-1280
lines changed

Tools/Solutions Analyzer/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ The main CSV file containing one row per unique combination of solution, connect
103103
| `connector_publisher` | Connector publisher name. Empty for solutions without data connectors. |
104104
| `connector_title` | Connector display title. Empty for solutions without data connectors. |
105105
| `connector_description` | Connector description (newlines replaced with `<br>` for GitHub CSV rendering). Empty for solutions without data connectors. |
106-
| `connector_instruction_steps` | Setup and configuration instructions rendered from connector UI definitions using AI, stored as JSON-encoded string with standard JSON `\n` encoding. May contain inaccuracies - verify in portal. Empty for solutions without data connectors. |
107-
| `connector_permissions` | Required permissions and prerequisites in markdown format (newlines replaced with `<br>`). Empty for solutions without data connectors. |
106+
| `connector_instruction_steps` | Setup and configuration instructions from connector UI definitions, stored as JSON-encoded string. Rendered in documentation using Microsoft Sentinel UI definitions. Empty for solutions without data connectors. |
107+
| `connector_permissions` | Required permissions and prerequisites from connector UI definitions, stored as JSON-encoded string. Rendered in documentation according to Microsoft Sentinel permissions schema (resourceProvider, customs, licenses, tenant). Empty for solutions without data connectors. |
108108
| `connector_files` | Semicolon-separated list of GitHub URLs to connector definition files. Empty for solutions without data connectors. |
109109
| `is_unique` | `true` if table appears in only one connector file, `false` otherwise |
110110
| `table_detection_methods` | (Optional, with --show-detection-methods) Semicolon-separated list of methods used to detect this table |
@@ -318,8 +318,8 @@ connector-docs/
318318

319319
**Connector Pages** include:
320320
- Connector description and metadata
321-
- **AI-rendered setup instructions** from connector UI definitions with step-by-step guidance
322-
- Required permissions and prerequisites
321+
- **AI-rendered setup instructions and permissions** from connector UI definitions with step-by-step guidance
322+
- Required permissions and prerequisites (rendered from Microsoft Sentinel permissions schema)
323323
- List of solutions using this connector
324324
- Tables ingested by the connector
325325
- Links to GitHub connector definition files
@@ -329,25 +329,31 @@ connector-docs/
329329
- Quick statistics
330330
- Cross-references between solutions, connectors, and tables
331331

332-
## AI-Rendered Setup Instructions
332+
## AI-Rendered Setup Instructions and Permissions
333333

334-
The "Setup Instructions" sections in the generated connector documentation are **automatically rendered from connector UI definition files using AI**. These instructions interpret the UI-centric JSON structures that define the Azure Portal configuration interface and convert them into readable step-by-step guidance.
334+
The "Setup Instructions" and "Permissions" sections in the generated connector documentation are **automatically rendered from connector UI definition files**. These sections interpret the UI-centric JSON structures that define the Azure Portal configuration interface and convert them into readable documentation.
335335

336336
### ⚠️ Important Disclaimer
337337

338-
**These AI-rendered instructions may not be fully accurate.** They are generated by interpreting UI definition metadata and should always be verified against the actual Microsoft Sentinel portal before implementation. The instructions provide a helpful starting point but are not a substitute for official documentation or hands-on portal verification.
338+
**These AI-rendered instructions and permissions may not be fully accurate.** They are generated by interpreting UI definition metadata and should always be verified against the actual Microsoft Sentinel portal before implementation. The content provides a helpful starting point but is not a substitute for official documentation or hands-on portal verification.
339339

340340
### How It Works
341341

342342
The rendering process involves several steps:
343343

344-
1. **JSON Parsing**: The script extracts `instructionSteps` arrays from connector definition files in the Solutions directory
344+
1. **JSON Parsing**: The script extracts `instructionSteps` and `permissions` objects from connector definition files in the Solutions directory
345345
2. **UI Type Detection**: Each instruction step has a `type` property (e.g., `DataConnectorsGrid`, `ContextPane`, `GCPGrid`) that determines how it should be interpreted
346-
3. **AI-Powered Rendering**: Specialized handlers for each UI type convert the JSON structure into descriptive markdown:
346+
3. **Permissions Schema Parsing**: Permission objects are rendered according to the Microsoft Sentinel permissions schema, including:
347+
- **resourceProvider**: Azure resource provider permissions with scope, required actions (read/write/delete/action)
348+
- **customs**: Custom prerequisites with names and descriptions
349+
- **licenses**: Required Microsoft 365 licenses with friendly names
350+
- **tenant**: Azure AD tenant permissions with required roles
351+
4. **AI-Powered Rendering**: Specialized handlers for each UI type convert the JSON structure into descriptive markdown:
347352
- Form fields (textboxes, dropdowns) are described with their purposes and validation requirements
348353
- Management grids and data selectors are explained with their configuration options
349354
- Portal-only interfaces are identified and marked with clear indicators
350-
4. **Markdown Formatting**: The rendered content is formatted with emoji indicators, step numbers, and disclaimers
355+
- Permission requirements are formatted with clear scope and action descriptions
356+
5. **Markdown Formatting**: The rendered content is formatted with emoji indicators, step numbers, and disclaimers
351357

352358
### UI Types Supported
353359

Tools/Solutions Analyzer/connector-docs/connectors/azureactivedirectory.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Gain insights into Microsoft Entra ID by connecting Audit and Sign-in logs to Mi
1616
- **Workspace** (Workspace): read and write permissions.
1717
- **Diagnostic Settings** (/providers/microsoft.aadiam): read and write permissions to AAD diagnostic settings.
1818

19+
**Tenant Permissions:**
20+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
21+
1922
## Setup Instructions
2023

2124
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/azureactivedirectoryidentityprotection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Microsoft Entra ID Protection provides a consolidated view at risk users, risk e
1919
**Resource Provider Permissions:**
2020
- **Workspace** (Workspace): read and write permissions.
2121

22+
**Licenses:**
23+
- Azure AD Premium P1/P2
24+
25+
**Tenant Permissions:**
26+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
27+
2228
## Setup Instructions
2329

2430
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/azureadvancedthreatprotection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ For more information, see the [Microsoft Sentinel documentation >](https://go.mi
3737
**Resource Provider Permissions:**
3838
- **Workspace** (Workspace): read and write permissions.
3939

40+
**Licenses:**
41+
- Microsoft Defender for Identity
42+
43+
**Tenant Permissions:**
44+
Requires SecurityAdmin, GlobalAdmin on the workspace's tenant
45+
4046
## Setup Instructions
4147

4248
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/azuredevopsauditlogs.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,7 @@ The Azure DevOps Audit Logs data connector allows you to ingest audit events fro
1717
- **Keys** (Workspace): Read permissions to shared keys for the workspace are required.
1818

1919
**Custom Permissions:**
20-
- **Azure DevOps Prerequisite**: Please ensure the following:
21-
1. Register an Entra App in Microsoft Entra Admin Center under App Registrations.
22-
2. In 'API permissions' - add Permissions to 'Azure DevOps - vso.auditlog'.
23-
3. In 'Certificates & secrets' - generate 'Client secret'.
24-
4. In 'Authentication' - add Redirect URI: 'https://portal.azure.com/TokenAuthorize/ExtensionName/Microsoft_Azure_Security_Insights'.
25-
5. In the Azure DevOps settings - enable audit log and set **View audit log** for the user. [Azure DevOps Auditing](https://learn.microsoft.com/en-us/azure/devops/organizations/audit/azure-devops-auditing?view=azure-devops&tabs=preview-page).
26-
6. Ensure the user assigned to connect the data connector has the View audit logs permission explicitly set to Allow at all times. This permission is essential for successful log ingestion. If the permission is revoked or not granted, data ingestion will fail or be interrupted.
20+
- **Azure DevOps Prerequisite**: Please ensure the following:<br> 1. Register an Entra App in Microsoft Entra Admin Center under App Registrations.<br> 2. In 'API permissions' - add Permissions to 'Azure DevOps - vso.auditlog'.<br> 3. In 'Certificates & secrets' - generate 'Client secret'.<br> 4. In 'Authentication' - add Redirect URI: 'https://portal.azure.com/TokenAuthorize/ExtensionName/Microsoft_Azure_Security_Insights'.<br> 5. In the Azure DevOps settings - enable audit log and set **View audit log** for the user. [Azure DevOps Auditing](https://learn.microsoft.com/en-us/azure/devops/organizations/audit/azure-devops-auditing?view=azure-devops&tabs=preview-page).<br> 6. Ensure the user assigned to connect the data connector has the View audit logs permission explicitly set to Allow at all times. This permission is essential for successful log ingestion. If the permission is revoked or not granted, data ingestion will fail or be interrupted.
2721

2822
## Setup Instructions
2923

Tools/Solutions Analyzer/connector-docs/connectors/microsoftcloudappsecurity.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ By connecting with [Microsoft Defender for Cloud Apps](https://aka.ms/asi-mcas-c
3131
**Resource Provider Permissions:**
3232
- **Workspace** (Workspace): read and write permissions.
3333

34+
**Licenses:**
35+
- Microsoft Defender for Cloud Apps
36+
37+
**Tenant Permissions:**
38+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
39+
3440
## Setup Instructions
3541

3642
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/microsoftdefenderadvancedthreatprotection.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Microsoft Defender for Endpoint is a security platform designed to prevent, dete
1515
**Resource Provider Permissions:**
1616
- **Workspace** (Workspace): read and write permissions.
1717

18+
**Licenses:**
19+
- Microsoft Defender for Endpoint
20+
21+
**Tenant Permissions:**
22+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
23+
1824
## Setup Instructions
1925

2026
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/microsoftdefenderforcloudtenantbased.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Microsoft Defender for Cloud is a security management tool that allows you to de
1515
**Resource Provider Permissions:**
1616
- **Workspace** (Workspace): read and write permissions.
1717

18+
**Tenant Permissions:**
19+
Requires SecurityAdmin, GlobalAdmin on the workspace's tenant
20+
1821
## Setup Instructions
1922

2023
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/microsoftpurviewinformationprotection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Microsoft Purview Information Protection helps you discover, classify, protect,
2020
**Custom Permissions:**
2121
- **License**: Enterprise Mobility + Security E5/A5 or Microsoft 365 E5/A5 or P2
2222

23+
**Tenant Permissions:**
24+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
25+
2326
## Setup Instructions
2427

2528
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

Tools/Solutions Analyzer/connector-docs/connectors/microsoftthreatprotection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ For more information, see the [Microsoft Sentinel documentation](https://go.micr
3636
**Custom Permissions:**
3737
- **License**: M365 E5, M365 A5 or any other Microsoft Defender XDR eligible license.
3838

39+
**Tenant Permissions:**
40+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
41+
3942
## Setup Instructions
4043

4144
> ⚠️ **Note**: These instructions were automatically generated from the connector's user interface definition file using AI and may not be fully accurate. Please verify all configuration steps in the Microsoft Sentinel portal.

0 commit comments

Comments
 (0)