From 65a766666354aa2cbff1f6b7e3f71b5c466a4271 Mon Sep 17 00:00:00 2001 From: Alex Protsenko <53046834+alexprotsenko@users.noreply.github.com> Date: Mon, 4 Nov 2019 21:19:33 +0300 Subject: [PATCH] added a section about the notebooks folder --- samples/manage/sql-assessment-api/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/samples/manage/sql-assessment-api/README.md b/samples/manage/sql-assessment-api/README.md index f452752db6..2e2c093511 100644 --- a/samples/manage/sql-assessment-api/README.md +++ b/samples/manage/sql-assessment-api/README.md @@ -12,6 +12,10 @@ Learn how to assess your SQL Server configuration for best practices in 2 simple This is the default set of rules shipped with SQL Assessment API. Feel free to open issues to have us fix or add rules. Also, we're happy to see your pull requests to this file. +## Notebooks + +This folder contains two Azure Data Studio notebooks, one is for a quick start with SQL Assessment API and the other is a comprehensive tutorial that will step you through all the features of SQL Assessment API including customizing the existing rules and creating your own ones. The notebooks is written for the powershell kernel in Azure Data Studio, so make sure you use [ADS 1.13.0](https://docs.microsoft.com/sql/azure-data-studio/download) or newer. + ## DisablingBuiltInChecks_sample.json Contains three parts. First shows how you can disable a specified rule by its ID. The second disables all the rules with the "TraceFlag" tag. The last disables to run all rules of the default ruleset (using the DefaultRuleset tag) against databases named "DBName1" and "DBName2".