You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/README.md
+16-10Lines changed: 16 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,8 +103,8 @@ The main CSV file containing one row per unique combination of solution, connect
103
103
|`connector_publisher`| Connector publisher name. Empty for solutions without data connectors. |
104
104
|`connector_title`| Connector display title. Empty for solutions without data connectors. |
105
105
|`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. |
108
108
|`connector_files`| Semicolon-separated list of GitHub URLs to connector definition files. Empty for solutions without data connectors. |
109
109
|`is_unique`|`true` if table appears in only one connector file, `false` otherwise |
110
110
|`table_detection_methods`| (Optional, with --show-detection-methods) Semicolon-separated list of methods used to detect this table |
@@ -318,8 +318,8 @@ connector-docs/
318
318
319
319
**Connector Pages** include:
320
320
- 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)
323
323
- List of solutions using this connector
324
324
- Tables ingested by the connector
325
325
- Links to GitHub connector definition files
@@ -329,25 +329,31 @@ connector-docs/
329
329
- Quick statistics
330
330
- Cross-references between solutions, connectors, and tables
331
331
332
-
## AI-Rendered Setup Instructions
332
+
## AI-Rendered Setup Instructions and Permissions
333
333
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.
335
335
336
336
### ⚠️ Important Disclaimer
337
337
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.
339
339
340
340
### How It Works
341
341
342
342
The rendering process involves several steps:
343
343
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
345
345
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:
347
352
- Form fields (textboxes, dropdowns) are described with their purposes and validation requirements
348
353
- Management grids and data selectors are explained with their configuration options
349
354
- 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
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/azureactivedirectory.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,9 @@ Gain insights into Microsoft Entra ID by connecting Audit and Sign-in logs to Mi
16
16
-**Workspace** (Workspace): read and write permissions.
17
17
-**Diagnostic Settings** (/providers/microsoft.aadiam): read and write permissions to AAD diagnostic settings.
18
18
19
+
**Tenant Permissions:**
20
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
21
+
19
22
## Setup Instructions
20
23
21
24
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/azureactivedirectoryidentityprotection.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,12 @@ Microsoft Entra ID Protection provides a consolidated view at risk users, risk e
19
19
**Resource Provider Permissions:**
20
20
-**Workspace** (Workspace): read and write permissions.
21
21
22
+
**Licenses:**
23
+
- Azure AD Premium P1/P2
24
+
25
+
**Tenant Permissions:**
26
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
27
+
22
28
## Setup Instructions
23
29
24
30
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/azureadvancedthreatprotection.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,12 @@ For more information, see the [Microsoft Sentinel documentation >](https://go.mi
37
37
**Resource Provider Permissions:**
38
38
-**Workspace** (Workspace): read and write permissions.
39
39
40
+
**Licenses:**
41
+
- Microsoft Defender for Identity
42
+
43
+
**Tenant Permissions:**
44
+
Requires SecurityAdmin, GlobalAdmin on the workspace's tenant
45
+
40
46
## Setup Instructions
41
47
42
48
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/azuredevopsauditlogs.md
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,13 +17,7 @@ The Azure DevOps Audit Logs data connector allows you to ingest audit events fro
17
17
-**Keys** (Workspace): Read permissions to shared keys for the workspace are required.
18
18
19
19
**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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/microsoftcloudappsecurity.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,12 @@ By connecting with [Microsoft Defender for Cloud Apps](https://aka.ms/asi-mcas-c
31
31
**Resource Provider Permissions:**
32
32
-**Workspace** (Workspace): read and write permissions.
33
33
34
+
**Licenses:**
35
+
- Microsoft Defender for Cloud Apps
36
+
37
+
**Tenant Permissions:**
38
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
39
+
34
40
## Setup Instructions
35
41
36
42
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/microsoftdefenderadvancedthreatprotection.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,12 @@ Microsoft Defender for Endpoint is a security platform designed to prevent, dete
15
15
**Resource Provider Permissions:**
16
16
-**Workspace** (Workspace): read and write permissions.
17
17
18
+
**Licenses:**
19
+
- Microsoft Defender for Endpoint
20
+
21
+
**Tenant Permissions:**
22
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
23
+
18
24
## Setup Instructions
19
25
20
26
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/microsoftdefenderforcloudtenantbased.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,9 @@ Microsoft Defender for Cloud is a security management tool that allows you to de
15
15
**Resource Provider Permissions:**
16
16
-**Workspace** (Workspace): read and write permissions.
17
17
18
+
**Tenant Permissions:**
19
+
Requires SecurityAdmin, GlobalAdmin on the workspace's tenant
20
+
18
21
## Setup Instructions
19
22
20
23
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/microsoftpurviewinformationprotection.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,9 @@ Microsoft Purview Information Protection helps you discover, classify, protect,
20
20
**Custom Permissions:**
21
21
-**License**: Enterprise Mobility + Security E5/A5 or Microsoft 365 E5/A5 or P2
22
22
23
+
**Tenant Permissions:**
24
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
25
+
23
26
## Setup Instructions
24
27
25
28
> ⚠️ **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.
Copy file name to clipboardExpand all lines: Tools/Solutions Analyzer/connector-docs/connectors/microsoftthreatprotection.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,9 @@ For more information, see the [Microsoft Sentinel documentation](https://go.micr
36
36
**Custom Permissions:**
37
37
-**License**: M365 E5, M365 A5 or any other Microsoft Defender XDR eligible license.
38
38
39
+
**Tenant Permissions:**
40
+
Requires GlobalAdmin, SecurityAdmin on the workspace's tenant
41
+
39
42
## Setup Instructions
40
43
41
44
> ⚠️ **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