Uploaded notebook files with my updates

Author: alexprotsenko

samples/manage/sql-assessment-api/notebooks/SQLAssessmentAPIQuickStartNotebook.ipynb

@@ -28,7 +28,7 @@
             "cell_type": "markdown",
             "source": [
                 "### 1. Setup\r\n",
-                "You need to install PowerShell SqlServer module using the following command. It is a good practice to run Import-Module at the beginning of your session as well. Get-Module will show you the version you have installed. The minimum version you want is 21.1.18206 (SQL Assessment API GA)."
+                "You need to install PowerShell SqlServer module using the following command. It is a good practice to run Import-Module at the beginning of your session as well. Get-Module will show you the version you have installed. The minimum version you want is 21.1.18206 — it is the version of SqlServer module containing SQL Assessment API GA."
             ],
             "metadata": {
                 "azdata_cell_guid": "2060c61e-6488-4b54-8aa8-8604a6159c0c"

samples/manage/sql-assessment-api/notebooks/SQLAssessmentAPITutorialNotebook.ipynb

@@ -42,9 +42,9 @@
                 "\r\n",
                 "There are two cmdlets: \r\n",
                 "\r\n",
-                "1. **Get-SqlAssessmentItem** shows a list of available rules for a given object (instance, database). Every rule has a target that describes what kind of SQL objects this rule applies to: SQL Server version, SQL Server platform, SQL Server engine edition. So by the availability of a rule, we mean that when you run Get-SqlAssessmentItem or Invoke-SqlAssessment, the API first verifies what rules aplly for the given object.  \r\n",
+                "1. **Get-SqlAssessmentItem** shows a list of available rules for a given object (5 kinds of objects is currently supported as input: Server, RegisteredServer, Database, AvailabilityGroup, Filegroup; the default ruleset contains rules for Server/RegisteredServer and Database only). Every rule has a target that describes what kind of SQL objects this rule applies to: Object Type, Object Name, SQL Server version, SQL Server platform, SQL Server engine edition. So by the availability of a rule, we mean that when you run Get-SqlAssessmentItem or Invoke-SqlAssessment, the API first verifies what rules apply for the given object.  \r\n",
                 "\r\n",
-                "2. **Invoke-SqlAssessment** performs an assessment of a passed object and provides the results. "
+                "2. **Invoke-SqlAssessment** performs an assessment of a passed object and provides the results. It's worthwhile to mention that assessment is invoked for a passed object only, so if you want to assess a SQL Server instance and all its databases, run the cmdlet with the instance object as input and then run it with the databases as input. We'll show you different ways of doing this below."
             ],
             "metadata": {
                 "azdata_cell_guid": "424b5be9-3f95-4fa0-b630-b5507a0e5db2"
@@ -54,7 +54,7 @@
             "cell_type": "markdown",
             "source": [
                 "### 1. Setup\r\n",
-                "You need to install PowerShell SqlServer module using the following command. It is a good practice to run Import-Module at the beginning of your session as well. Get-Module will show you the version you have installed. The minimum version you want is 21.1.18206 (SQL Assessment API GA)."
+                "You need to install PowerShell SqlServer module using the following command. It is a good practice to run Import-Module at the beginning of your session as well. Get-Module will show you the version you have installed. The minimum version you want is 21.1.18206 — it is the version of SqlServer module containing SQL Assessment API GA. You can [read more](https://docs.microsoft.com/sql/powershell/download-sql-server-ps-module) about installing and updating the SqlServer module on docs."
             ],
             "metadata": {
                 "azdata_cell_guid": "9575ad0b-daca-48ac-84f1-59431afd1387"
@@ -72,14 +72,15 @@
                 "azdata_cell_guid": "bf6a34ad-a006-4b24-858d-5d08b760b231"
             },
             "outputs": [],
-            "execution_count": 4
+            "execution_count": 2
         },
         {
             "cell_type": "markdown",
             "source": [
-                "### 2. Invoke an assessment (SQL Server instance)\r\n",
-                "There are various ways to run the assessment cmdlet. The following statements give recommendations for local default instance. Pick whatever style works for your script.\r\n",
-                ""
+                "### 2. Invoke an assessment for SQL Server instance\r\n",
+                "There are various ways to run the assessment cmdlet. The following statements give recommendations for a local default instance. Pick whatever style works for your script.\r\n",
+                "\r\n",
+                "Server and RegisteredServer objects are interchangeable, so you can pass any to the SQL Assessment cmdlets to assess a SQL Server instance."
             ],
             "metadata": {
                 "azdata_cell_guid": "a34fa4e1-bf4e-44c9-9274-3fca29a6c535"
@@ -160,10 +161,22 @@
             "outputs": [],
             "execution_count": 16
         },
+        {
+            "cell_type": "code",
+            "source": [
+                "# Option 7 - passing registered servers to the cmdlet\r\n",
+                "Get-ChildItem 'SQLSERVER:\\SQLRegistration\\Database Engine Server Group' | WHERE { $_.Mode -ne 'D'}  | Invoke-SqlAssessment"
+            ],
+            "metadata": {
+                "azdata_cell_guid": "dc8b69d6-6d20-4115-a68a-f6abd39d6c4a"
+            },
+            "outputs": [],
+            "execution_count": 0
+        },
         {
             "cell_type": "markdown",
             "source": [
-                "### 3. Invoke an assessment (SQL Server database)\r\n",
+                "### 3. Invoke an assessment for SQL Server database\r\n",
                 "You need to run Invoke-SqlAssessment against a database object to get database specific recommendations. Again, there are various ways of accomplishing this. Below are some examples."
             ],
             "metadata": {
@@ -212,10 +225,11 @@
             "cell_type": "code",
             "source": [
                 "# Get recommendations for all databases on local instance:\r\n",
-                "Get-SqlDatabase -ServerInstance 'localhost' | Invoke-SqlAssessment -Verbose"
+                "Get-SqlDatabase -ServerInstance 'localhost' | Invoke-SqlAssessment"
             ],
             "metadata": {
-                "azdata_cell_guid": "b374c2ec-8d2e-4c35-a48a-c427dec9c21c"
+                "azdata_cell_guid": "b374c2ec-8d2e-4c35-a48a-c427dec9c21c",
+                "tags": []
             },
             "outputs": [],
             "execution_count": 26
@@ -236,7 +250,7 @@
             "source": [
                 "# Get all rules available for an object:\r\n",
                 "$serverInstance = Get-SqlInstance -ServerInstance 'localhost'\r\n",
-                "Get-SqlAssessmentItem $serverInstance | Select ID, Description | Format-Table"
+                "Get-SqlAssessmentItem $serverInstance | Select Id, Description"
             ],
             "metadata": {
                 "azdata_cell_guid": "56b4a035-658b-4bc4-8870-90823b8c2549"
@@ -261,9 +275,9 @@
             "cell_type": "markdown",
             "source": [
                 "### 5. Run a specific rule\r\n",
-                "If you want to check a particular rule (maybe after you fixed it), you can run it by its name. You can also specify several rules in the –Check parameter, just delimit them by commas.\r\n",
+                "If you want to check a particular rule (maybe after you fixed it), you can run it by its name. You can also specify several rules in the -Check parameter, just delimit them by commas.\r\n",
                 "\r\n",
-                "Every rule in the default ruleset has tags to group them into logical sets. In the example below, we look for backup related issues only. Backup value used for the –Check parameter is a tag.  You can use both rule names and tags at the same time in a comma delimited list. "
+                "Every rule in the default ruleset has tags to group them into logical sets. In the example below, we look for backup related issues only. Backup value used for the -Check parameter is a tag.  You can use both rule names and tags at the same time in a comma delimited list. "
             ],
             "metadata": {
                 "azdata_cell_guid": "0267d880-c35e-4fbf-90db-dd9120194da9"
@@ -323,7 +337,8 @@
                 "## Customization\r\n",
                 "In this section you will learn how to customize existing rules and create new ones.\r\n",
                 "\r\n",
-                "You need to grab the json files in the Customization Sample JSON folder and place them in an accessible path. You need to edit the scripts below to point at the right path and server instance for your environment."
+                "As a prerequisite, make sure to grab the JSON files in the CustomizationSamples folder and place them in an accessible path and then edit the first script below to point at the right path and server instance for your environment.  We encourage you to look into every JSON sample so you can understand better the making of customizations for SQL Assessment.\r\n",
+                ""
             ],
             "metadata": {
                 "azdata_cell_guid": "3cfbe027-21f0-40be-b6f0-b871360aff5d"
@@ -341,16 +356,28 @@
         {
             "cell_type": "code",
             "source": [
-                "# Setup two parameters that are used in all the customization examples below\r\n",
-                "# $binariesPath=\"<replace this with the path to customization sample json files>\"\r\n",
-                "$binariesPath=\"C:\\Users\\ebrue\\OneDrive - Microsoft\\Monitoring\\API\\Custimization Sample JSON\"\r\n",
-                "$serverInstance = Get-SqlInstance -ServerInstance 'localhost'"
+                "#Setup two parameters that are used in all the customization examples below\r\n",
+                "#$binariesPath='<replace this with the path to customization json files, e.g. \"C:\\SQLAsmnt\\CustomizationSamples\">' \r\n",
+                "$binariesPath='C:\\SQLAsmnt\\CustomizationSamples'\r\n",
+                "######REMOVELINEBELOW\r\n",
+                "$binariesPath='D:\\Temp\\dem\\Wed Version\\notebooks\\CustomizationSamples'\r\n",
+                "$binariesPath\r\n",
+                "\r\n",
+                "#$serverInstance = Get-SqlInstance -ServerInstance 'localhost'\r\n",
+                "######REMOVELINEBELOW\r\n",
+                "$serverInstance = Get-SqlInstance -ServerInstance '.\\sql2017express'\r\n",
+                "$serverInstance\r\n",
+                "\r\n",
+                "$sqlDbMaster = $serverInstance | Get-SqlDatabase -Name master\r\n",
+                "$sqlDbMaster\r\n",
+                ""
             ],
             "metadata": {
-                "azdata_cell_guid": "5df878e7-8204-45c8-8bb2-4861131f3588"
+                "azdata_cell_guid": "5df878e7-8204-45c8-8bb2-4861131f3588",
+                "tags": []
             },
             "outputs": [],
-            "execution_count": 40
+            "execution_count": 37
         },
         {
             "cell_type": "code",
@@ -364,7 +391,7 @@
                 "azdata_cell_guid": "7a2a90f0-8341-4cd8-81a3-1fdedbd1adb6"
             },
             "outputs": [],
-            "execution_count": 74
+            "execution_count": 7
         },
         {
             "cell_type": "code",
@@ -374,24 +401,25 @@
                 "Get-SqlAssessmentItem $serverInstance -Configuration $(join-path $binariesPath \"DisableAllTF.json\")"
             ],
             "metadata": {
-                "azdata_cell_guid": "35ee6731-70dd-42b9-b041-f3b09ac02a4d"
+                "azdata_cell_guid": "35ee6731-70dd-42b9-b041-f3b09ac02a4d",
+                "tags": []
             },
             "outputs": [],
-            "execution_count": 76
+            "execution_count": 9
         },
         {
             "cell_type": "code",
             "source": [
                 "# Combine configurations\r\n",
-                "# This example disables all trace flag rules except for performance related ones using tags. \r\n",
-                "# The order of json files is important. First we disable all TF rules, then enable performance rules which re-enables performance related TF rules.\r\n",
+                "# This example disables all trace flag rules except for performance-related ones using tags. \r\n",
+                "# The order of json files is important. First we disable all TF rules, then enable performance rules which re-enables performance-related TF rules.\r\n",
                 "Get-SqlAssessmentItem $serverInstance -Configuration $(join-path $binariesPath \"DisableAllTF.json\"), $(join-path $binariesPath \"EnablePerformance.json\")"
             ],
             "metadata": {
                 "azdata_cell_guid": "4f79d729-4a3b-47a6-8cb3-d4a5b0c2db05"
             },
             "outputs": [],
-            "execution_count": 80
+            "execution_count": 11
         },
         {
             "cell_type": "markdown",
@@ -413,31 +441,29 @@
         {
             "cell_type": "code",
             "source": [
-                "# Create new rule with TSQL probe\r\n",
+                "# Create a new rule with TSQL probe\r\n",
                 "# This rule applies to databases and uses a TSQL statement to get the data for the rule. \r\n",
-                "$database = Get-SqlDatabase -ServerInstance 'localhost' -Name master\r\n",
-                "Invoke-SqlAssessment $database -configuration $(join-path $binariesPath \"CustomRuleTSQLProbe.json\")"
+                "Invoke-SqlAssessment $sqlDbMaster -configuration $(join-path $binariesPath \"CustomRuleTSQLProbe.json\")"
             ],
             "metadata": {
                 "azdata_cell_guid": "1df3379f-e5fe-47ea-a43e-920265f3d0e2",
                 "tags": []
             },
             "outputs": [],
-            "execution_count": 66
+            "execution_count": 45
         },
         {
             "cell_type": "code",
             "source": [
                 "# Override threshold parameter\r\n",
                 "# CustomRuleThresholdChange.json defines a new threshold value for DBSpaceAvailable rule created above\r\n",
-                "$database = Get-SqlDatabase -ServerInstance 'localhost' -Name master\r\n",
-                "Invoke-SqlAssessment $database -configuration $(join-path $binariesPath \"CustomRuleTSQLProbe.json\"),$(join-path $binariesPath \"CustomRuleThresholdChange.json\")"
+                "Invoke-SqlAssessment $sqlDbMaster -configuration $(join-path $binariesPath \"CustomRuleTSQLProbe.json\"),$(join-path $binariesPath \"CustomRuleThresholdChange.json\")"
             ],
             "metadata": {
                 "azdata_cell_guid": "953cd87b-4311-4553-9170-e219c231642a"
             },
             "outputs": [],
-            "execution_count": 68
+            "execution_count": 106
         },
         {
             "cell_type": "markdown",
@@ -459,7 +485,7 @@
                 "azdata_cell_guid": "1c7ef29f-3047-4718-923f-bad632bfdd96"
             },
             "outputs": [],
-            "execution_count": 70
+            "execution_count": 116
         },
         {
             "cell_type": "markdown",