Skip to content

Update playbook documentation and deployment templates#12237

Merged
v-prasadboke merged 10 commits intomasterfrom
origin/users/rahul/test-vt-playbooks
Jun 20, 2025
Merged

Update playbook documentation and deployment templates#12237
v-prasadboke merged 10 commits intomasterfrom
origin/users/rahul/test-vt-playbooks

Conversation

@rahul0216
Copy link
Collaborator

Required items, please complete

Change(s):

  • Updated readme.md for consistency (improved prerequisites, deployment, and post-deployment instructions)
  • Ensured playbook metadata and connection parameters are clear and consistent in all VirusTotal playbooks

Reason for Change(s):

  • Playbook configuration issues

Version Updated:

  • NA

Testing Completed:

  • Yes

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

  • Yes

- Rewrote readme.md for consistency (improved prerequisites, deployment, and post-deployment instructions)
- Ensured  playbook metadata and connection parameters are clear and consistent in all VirusTotal playbooks
@rahul0216 rahul0216 requested review from a team as code owners May 29, 2025 12:25
@rahul0216 rahul0216 requested a review from Copilot May 29, 2025 12:25
Copy link
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

This PR enhances the playbook documentation and updates deployment templates for VirusTotal playbooks to improve clarity, consistency, and usability. Key changes include updated README instructions and metadata in azuredeploy.json files, as well as standardized connection naming and deployment guidance across playbooks.

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Solutions/VirusTotal/ReleaseNotes.md Updated release information with a newer version and date.
Solutions/VirusTotal/Playbooks/Get-VirusTotalURLReport/readme.md Revised language and deployment instructions for the URL report playbook.
Solutions/VirusTotal/Playbooks/Get-VirusTotalURLReport/alert-trigger/azuredeploy.json Updated metadata for incident/alert triggers; minor spelling fixes observed.
Solutions/VirusTotal/Playbooks/Get-VirusTotalIPReport/alert-trigger/azuredeploy.json Adjusted connection naming consistency in variables.
Solutions/VirusTotal/Playbooks/Get-VirusTotalFileInfo/readme.md Revised file information documentation and deployment steps.
Solutions/VirusTotal/Playbooks/Get-VirusTotalFileInfo/incident-trigger/azuredeploy.json Updated playbook metadata; connection variable naming inconsistency noted.
Solutions/VirusTotal/Playbooks/Get-VirusTotalDomainReport/readme.md Improved domain report documentation; observed redundant author information.
Others (incident-trigger/alert-trigger templates) Similar improvements for consistency across all playbooks.
Comments suppressed due to low confidence (3)

Solutions/VirusTotal/Playbooks/Get-VirusTotalIPReport/alert-trigger/azuredeploy.json:33

  • There is a typo in the variable name 'AzureLoganAlyticsDataCollectorConnectionName'. It should likely be 'AzureLogAnalyticsDataCollectorConnectionName'.
AzureLogAnalyticsDataCollectorConnectionName": "[concat('AzureLoganAlyticsDataCollector-', parameters('PlaybookName'))]"

Solutions/VirusTotal/Playbooks/Get-VirusTotalFileInfo/incident-trigger/azuredeploy.json:33

  • The variable 'AzureLoganAlyticsDataCollectorConnectionName' appears to have a spelling error. Consider renaming it to 'AzureLogAnalyticsDataCollectorConnectionName'.
AzureLogAnalyticsDataCollectorConnectionName": "[concat('AzureLoganAlyticsDataCollector-', parameters('PlaybookName'))]"

Solutions/VirusTotal/Playbooks/Get-VirusTotalDomainReport/readme.md:2

  • The author line contains redundant 'Microsoft' entries. Consider listing the author information only once to avoid confusion.
Author: Nicholas DiCola, Microsoft, Microsoft, Microsoft

…rigger/azuredeploy.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@rahul0216 rahul0216 requested a review from Copilot May 29, 2025 12:37

This comment was marked as outdated.

@v-prasadboke v-prasadboke added the Solution Solution specialty review needed label May 30, 2025
manishkumar1991
manishkumar1991 previously approved these changes Jun 3, 2025
Copy link
Contributor

@manishkumar1991 manishkumar1991 left a comment

Choose a reason for hiding this comment

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

Approved

@rahul0216 rahul0216 requested a review from Copilot June 19, 2025 03:32
Copy link
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

This PR updates playbook documentation and deployment templates for the VirusTotal solution to address consistency and clarify instructions across the package. Key changes include updating version numbers (from 3.0.0 to 3.0.1), refining metadata and role assignment instructions in readme files, and revising deployment JSON templates (including improved message formatting and conditional URL path handling).

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Solutions/VirusTotal/ReleaseNotes.md Updated release notes with new version and clearer change descriptions.
Solutions/VirusTotal/Playbooks/*/readme.md Improved playbook descriptions, prerequisites, and post-deployment instructions.
Solutions/VirusTotal/Playbooks/*/azuredeploy.json Revised metadata in deployment templates (titles, prerequisites, version, and connection names).
Solutions/VirusTotal/Package/mainTemplate.json Updated solution version and connection variable formatting for consistency.
Solutions/VirusTotal/Package/createUiDefinition.json Adjusted UI definition description to match new documentation details.
Comments suppressed due to low confidence (2)

Solutions/VirusTotal/Playbooks/Get-VirusTotalDomainReport/incident-trigger/azuredeploy.json:222

  • The updated conditional logic in the 'path' property improves robustness when parsing URLs; please verify that this change handles all expected URL formats in production.
                                        "path": "/api/v3/domains/@{encodeURIComponent(if(greater(length(split(items('For_each')?['Url'], '/')), 2), split(items('For_each')?['Url'], '/')[2], items('For_each')?['Url']))}"

Solutions/VirusTotal/Package/mainTemplate.json:36

  • Ensure that the solution version update to '3.0.1' is reflected consistently across all deployment templates and associated documentation.
    "_solutionVersion": "3.0.1",

Copy link
Contributor

@manishkumar1991 manishkumar1991 left a comment

Choose a reason for hiding this comment

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

approve

Copy link
Contributor

@manishkumar1991 manishkumar1991 left a comment

Choose a reason for hiding this comment

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

approved

@v-prasadboke v-prasadboke merged commit 70f4c89 into master Jun 20, 2025
33 checks passed
@rahul0216 rahul0216 deleted the origin/users/rahul/test-vt-playbooks branch July 10, 2025 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content-Package Solution Solution specialty review needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants