Workbook Logos and Descriptions

%3CLINGO-SUB%20id%3D%22lingo-sub-2570122%22%20slang%3D%22en-US%22%3EWorkbook%20Logos%20and%20Descriptions%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2570122%22%20slang%3D%22en-US%22%3E%3CP%3EWe%20are%20wanting%20to%20push%20branding%2C%20descriptions%20and%20possibly%20screenshot%20examples%20with%20our%20custom%20workbooks%20but%20are%20at%20a%20loss%20at%20where%2Fhow%20this%20would%20be%20accomplished.%26nbsp%3B%20Is%20this%20feature%20supported%3F%26nbsp%3B%20I%20have%20looked%20into%20Azure%20Sentinel%20Solutions%20as%20it%20appears%20this%20could%20be%20a%20contender%2C%20but%20as%20we%20are%20leveraging%20a%20CSP%20relationship%3B%20private%20solutions%20are%20not%20applicable.%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EThank%20you%20very%20much!%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2570255%22%20slang%3D%22en-US%22%3ERe%3A%20Workbook%20Logos%20and%20Descriptions%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2570255%22%20slang%3D%22en-US%22%3EAll%20of%20that%20would%20be%20included%20in%20the%20JSON%20file.%20See%20the%20bottom%20of%20the%20following%20page%20for%20the%20JSON%20format%3A%20%3CA%20href%3D%22https%3A%2F%2Fgithub.com%2FAzure%2FAzure-Sentinel%2Ftree%2Fmaster%2FWorkbooks%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3Ehttps%3A%2F%2Fgithub.com%2FAzure%2FAzure-Sentinel%2Ftree%2Fmaster%2FWorkbooks%3C%2FA%3E%3CBR%20%2F%3E%3CBR%20%2F%3EYou%20can%20add%20a%20logo%2C%20etc.%20If%20you%20want%20logos%20and%20images%20directly%20in%20the%20Workbook%2C%20use%20the%20HTML%20%3CIMG%20%2F%3E%20tag.%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2570599%22%20slang%3D%22en-US%22%3ERe%3A%20Workbook%20Logos%20and%20Descriptions%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2570599%22%20slang%3D%22en-US%22%3EPerfect!%20Thank%20you%20very%20much%20for%20this.%20Other%20than%20a%20pr%2C%20how%20would%20this%20get%20pushed%20into%20Azure%20Sentinel%3F%20Could%20this%20be%20pushed%20via%20API%20into%20the%20workspace%3F%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-2571108%22%20slang%3D%22en-US%22%3ERe%3A%20Workbook%20Logos%20and%20Descriptions%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-2571108%22%20slang%3D%22en-US%22%3EPlease%20see%20the%20workbooks%20section%20here%20%3CA%20href%3D%22https%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fazure-sentinel%2Fdeploying-and-managing-azure-sentinel-as-code%2Fba-p%2F1131928%22%20target%3D%22_blank%22%3Ehttps%3A%2F%2Ftechcommunity.microsoft.com%2Ft5%2Fazure-sentinel%2Fdeploying-and-managing-azure-sentinel-as-code%2Fba-p%2F1131928%3C%2FA%3E%20or%20%3CA%20href%3D%22https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Fazure-monitor%2Fvisualize%2Fworkbooks-automate%22%20target%3D%22_blank%22%20rel%3D%22noopener%20noreferrer%22%3Ehttps%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Fazure-monitor%2Fvisualize%2Fworkbooks-automate%3C%2FA%3E%3C%2FLINGO-BODY%3E
Occasional Contributor

We are wanting to push branding, descriptions and possibly screenshot examples with our custom workbooks but are at a loss at where/how this would be accomplished.  Is this feature supported?  I have looked into Azure Sentinel Solutions as it appears this could be a contender, but as we are leveraging a CSP relationship; private solutions are not applicable.

 

Thank you very much!

7 Replies
All of that would be included in the JSON file. See the bottom of the following page for the JSON format: https://github.com/Azure/Azure-Sentinel/tree/master/Workbooks

You can add a logo, etc. If you want logos and images directly in the Workbook, use the HTML <img> tag.
Perfect! Thank you very much for this. Other than a pr, how would this get pushed into Azure Sentinel? Could this be pushed via API into the workspace?

@Clive Watson My apologies, I do believe it was too vague in my initial request. I am looking to push a logo/description with the workbook to be displayed within "My Workbooks" The logo would be presented in the area marked with the default logo and description would replace "Customer Defined Workbook"  I am familiar with pushing workbooks via the deployment methods suggested but am unsuccessful when it comes to finding the parameter within the template that defines the logo or the presented description.

workbook2.PNG

Logos are outside your template, they are referenced in https://github.com/Azure/Azure-Sentinel/blob/master/Workbooks/WorkbooksMetadata.json and stored in https://github.com/Azure/Azure-Sentinel/tree/master/Workbooks/Images/Logos

Please see https://github.com/Azure/Azure-Sentinel/tree/master/Workbooks#step-2---create-a-pull-request-to-this...

Take a look in WorkbooksMetadata.json for examples like:
{
"workbookKey": "AIVectraDetectWorkbook",
"logoFileName": "AIVectraDetect.svg",
"description": "Start investigating network attacks surfaced by Vectra Detect directly from Sentinel. View critical hosts, accounts, campaigns and detections. Also monitor Vectra system health and audit logs.",
"dataTypesDependencies": ["CommonSecurityLog"],
"dataConnectorsDependencies": ["AIVectraDetect"],
"previewImagesFileNames": ["AIVectraDetectWhite1.png", "AIVectraDetectBlack1.png"],
"version": "1.1",
"title": "AI Vectra Detect",
"templateRelativePath": "AIVectraDetectWorkbook.json",
"subtitle": "",
"provider": "Vectra AI"
},
Understood, is there a mechanism to push the workbook with the associated metadata (logo, description ..) other than creating a PR? I would like to push these workbooks out individually and not via PR if possible.

@bsfergu not that I'm aware of, custom workbooks get the default Icon.  e.g. the bottom 4 in this list are all the same workbook, only the one from the github/PR has the icon.  

 

Screenshot 2021-07-21 181701.png