Skip to content

Add workbook instructions and validation guide#13961

Merged
v-dvedak merged 10 commits intomasterfrom
v-sabiraj-workbookinstructions
Apr 10, 2026
Merged

Add workbook instructions and validation guide#13961
v-dvedak merged 10 commits intomasterfrom
v-sabiraj-workbookinstructions

Conversation

@v-sabiraj
Copy link
Copy Markdown
Contributor

Add a comprehensive .github/instructions/workbook.instructions.md file that documents standards and validation guidance for Microsoft Sentinel/Azure Monitor workbooks. The new guide specifies required workbook JSON top-level fields (version, items, fallbackResourceIds, fromTemplateId, $schema), provides minimal and full JSON examples, item/parameter/query/chart guidelines, naming and folder conventions, metadata requirements (WorkbooksMetadata.json), versioning rules, common validation errors, and a PR description template to help contributors create and submit valid workbooks.

Required items, please complete

Change(s):

  • See guidance below

Reason for Change(s):

  • See guidance below

Version Updated:

  • Required only for Detections/Analytic Rule templates
  • See guidance below

Testing Completed:

  • See guidance below

Checked that the validations are passing and have addressed any issues that are present:

  • See guidance below

Guidance <- remove section before submitting


Before submitting this PR please ensure that you have read the following sections and filled out the changes, reason for change and testing complete sections:

Thank you for your contribution to the Microsoft Sentinel Github repo.

Details of the code changes in your submitted PR. Providing descriptions for pull requests ensures there is context to changes being made and greatly enhances the code review process. Providing associated Issues that this resolves also easily connects the reason.

Change(s):

  • Updated syntax for XYZ.yaml

Reason for Change(s):

Version updated:

  • Yes
  • Detections/Analytic Rule templates are required to have the version updated

The code should have been tested in a Microsoft Sentinel environment that does not have any custom parsers, functions or tables, so that you validate no incorrect syntax and execution functions properly. If your submission requires a custom parser or function, it must be submitted with the PR.

Testing Completed:

  • Yes/No/Need Help

Note: If updating a detection, you must update the version field.

Before the submission has been made, please look at running the KQL and Yaml Validation Checks locally.
https://github.com/Azure/Azure-Sentinel#run-kql-validation-locally

Checked that the validations are passing and have addressed any issues that are present:

  • Yes/No/Need Help

Note: Let us know if you have tried fixing the validation error and need help.

References:


Add a comprehensive .github/instructions/workbook.instructions.md file that documents standards and validation guidance for Microsoft Sentinel/Azure Monitor workbooks. The new guide specifies required workbook JSON top-level fields (version, items, fallbackResourceIds, fromTemplateId, $schema), provides minimal and full JSON examples, item/parameter/query/chart guidelines, naming and folder conventions, metadata requirements (WorkbooksMetadata.json), versioning rules, common validation errors, and a PR description template to help contributors create and submit valid workbooks.
@v-sabiraj v-sabiraj requested a review from a team as a code owner April 1, 2026 15:49
@v-sabiraj v-sabiraj requested a review from Copilot April 1, 2026 15:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new contributor instruction guide for Microsoft Sentinel/Azure Monitor workbook JSON files, aiming to standardize required fields, naming, metadata, validation expectations, and PR submission details.

Changes:

  • Introduces .github/instructions/workbook.instructions.md with required workbook JSON field guidance and examples
  • Documents workbook item/parameter/query/chart conventions and common validation errors
  • Adds metadata (WorkbooksMetadata.json) requirements and a PR description template for workbook submissions

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md
@v-shukore v-shukore self-assigned this Apr 2, 2026
@v-sabiraj v-sabiraj marked this pull request as draft April 2, 2026 06:47
@v-sabiraj v-sabiraj requested a review from Copilot April 2, 2026 07:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 6 comments.

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md
Clarify fromTemplateId naming (use sentinel- prefix with descriptive identifier; allow kebab-case or PascalCase and provide filename/vendor/purpose examples) and reorganize examples/rules. Add comprehensive standards for query quality, documentation, visualizations, interactivity/parameters, structure/navigation, and general best practices (including no-data messaging, performance tips, and parameter usage). These updates provide guidance to ensure consistent, performant, and user-friendly workbook templates.
@v-sabiraj v-sabiraj requested a review from Copilot April 2, 2026 10:53
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 7 comments.

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md Outdated
@v-sabiraj v-sabiraj marked this pull request as ready for review April 7, 2026 06:53
@v-sabiraj v-sabiraj requested a review from Copilot April 7, 2026 08:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
v-atulyadav
v-atulyadav previously approved these changes Apr 8, 2026
Copy link
Copy Markdown
Collaborator

@rahul0216 rahul0216 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good. Please address the inline comments. Dismiss or implement comments provided by copilot with proper justification.

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Add an optional description-detailed field to hunting queries guidance to allow extended narrative (>255 chars) with rules and an example. Update workbook instructions to list common item types (add types like multi-select, time range, workspace/subscription selectors, toggle, etc.), include a doc reference, and reorder the Workbook Organization to surface the Help section earlier for clarity.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.

Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/workbook.instructions.md
Comment thread .github/instructions/workbook.instructions.md Outdated
Comment thread .github/instructions/releasenotes.instructions.md
Comment thread .github/instructions/releasenotes.instructions.md
Comment thread .github/instructions/huntingqueries.instructions.md
@v-dvedak v-dvedak merged commit ad9a759 into master Apr 10, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants