microsoft / microsoft/sql-server-samples
SQLAssessment API Documentation
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 11.2k
- Forks
- 9.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 14
Description
There appears to be insufficient documentation around the authoring of probes and rules.
Although there are examples there is nothing to show what is allowed.
- What can be used under Condition and is there a reference for each option
- What Items are Optional
- How to use PowerShell scripts as opposed to single commands
- is encoded PowerShell supported
- Can we use multiline scripts - Is encryption of the Ruleset supported to protect IP?
Is there any documentation that can be shared (even under NDA)
I am happy to share more information on what we are doing but it would have to be in a private setting.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue concerns SQLAssessment probes and rules, including Condition options, optional items, PowerShell scripts, and ruleset encryption, but names no files or tests. Start by locating the SQLAssessment API and its existing examples, then compare them with the supported authoring options. Done means documenting the supported fields, optional items, script forms, and encryption support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100