Merge pull request #789 from altanatsedenova/master

Update SQL Assessment folder for July release

Author: ebruersan

samples/manage/sql-assessment-api/DefaultRuleset.csv

@@ -7,7 +7,7 @@
 			"target": {
 			  "type": "Database",
 			  "version": "[13.0,)",
-			  "platform": "/^(Windows|Linux)$/",
+			  "platform": "Windows, Linux",
 			  "engineEdition": "OnPremises, ManagedInstance",
 			  "name": { "not": "/^(master|tempdb|model)$/" }
 			},
@@ -26,7 +26,7 @@
 		{
 			"target": {
 			  "type": "Server",
-			  "platform": "/^(Windows|Linux)$/",
+			  "platform": "Windows, Linux",
 			  "engineEdition": "OnPremises"
 			},
 			"id": "Custom_TF834",
@@ -60,7 +60,7 @@
 			  "target": {
 				"type": "Database",
 				"version": "(,12.0)",
-				"platform": "/^(Windows|Linux)$/",
+				"platform": "Windows, Linux",
 				"engineEdition": "OnPremises, ManagedInstance"
 			  },
 			  "implementation": {
@@ -72,7 +72,7 @@
 			  "target": {
 				"type": "Database",
 				"version": "[12.0, 13.0)",
-				"platform": "/^(Windows|Linux)$/",
+				"platform": "Windows, Linux",
 				"engineEdition": "OnPremises, ManagedInstance"
 			  },
 			  "implementation": {
@@ -84,7 +84,7 @@
 			  "target": {
 				"type": "Database",
 				"version": "[13.0,)",
-				"platform": "/^(Windows|Linux)$/",
+				"platform": "Windows, Linux",
 				"engineEdition": "OnPremises, ManagedInstance"
 			  },
 			  "implementation": {

samples/manage/sql-assessment-api/MakingCustomChecks_sample.json

@@ -28,7 +28,7 @@ You will see in the results that each rule has some properties (not the full lis
 - Message property explains the recommendation but if you need more info, there is a HelpLink property that points at documentation on the subject.
 - Origin shows which ruleset and version the recommendation is coming from
 
-See [config.json](./config.json) for a full list of rules and properties.
+See [ruleset.json](./ruleset.json) for a full list of rules and properties.
 
 If you want to get recommendations for all databases on the local instance, run this command.
 
@@ -42,4 +42,4 @@ To learn more about SQL Assessment API such as customizing and extending the rul
 
 - Docs online page: https://docs.microsoft.com/sql/sql-assessment-api/sql-assessment-api-overview 
 - GitHub repo: http://aka.ms/sql-assessment-api
-- SQL Assessment API Tutorial notebook: coming soon
+- SQL Assessment API Tutorial notebook: [SQLAssessmentAPITutorialNotebook.ipynb](./notebooks/SQLAssessmentAPITutorialNotebook.ipynb)

samples/manage/sql-assessment-api/QuickStart.md

@@ -4,11 +4,13 @@ SQL Assessment API provides a mechanism to evaluate the configuration of your SQ
 
 Learn more about the API on the [SQL Assessment API docs page](https://docs.microsoft.com/en-us/sql/sql-assessment-api/sql-assessment-api-overview).
 
+If you are into Azure Data Studio, you can evaluate your SQL Server right from it. Learn about SQL Assessment ADS extension [here](https://techcommunity.microsoft.com/t5/sql-server/released-sql-server-assessment-extension-for-azure-data-studio/ba-p/1470603).
+
 ## QuickStart.md
 
 Learn how to assess your SQL Server configuration for best practices in 2 simple steps.
 
-## config.json
+## ruleset.json
 
 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.
 
@@ -34,7 +36,7 @@ Demonstrates how to make a custom ruleset containing two checks. The sample cont
         "type": "Database",                                                          //This check targets Database object
         "version": "[13.0,)",                                                        //Applies to SQL Server 2016 and higher
                                                                                      //Another example: "[12.0,13.0)" reads as "any SQL Server version >= 12.0 and < 13.0"
-        "platform": "/^(Windows|Linux)$/",                                           //Applies to SQL Server on Windows and Linux
+        "platform": "Windows, Linux",                                           //Applies to SQL Server on Windows and Linux
         "engineEdition": "OnPremises, ManagedInstance",                              //Applies to SQL on Premises and Azure SQL Managed Instance. Here you can also filter specific editions of SQL Server
         "name": { "not": "/^(master|tempdb|model)$/" }                               //Applies to any database excluding master, tempdb, and msdb
     },
@@ -67,7 +69,7 @@ Demonstrates how to make a custom ruleset containing two checks. The sample cont
         "target": {                                                             //Probes have their own target, usually to separate implementation for different versions, editions, or platforms. Probe targets work the same way as rule targets do.
             "type": "Database",
             "version": "(,12.0)",                                               //This target is for SQL Server of versions prior to 2014
-            "platform": "/^(Windows|Linux)$/",
+            "platform": "Windows, Linux",
             "engineEdition": "OnPremises, ManagedInstance"
         },
         "implementation": {                                                     //Implementation object with a T-SQL query. This probe is used in many rules, that's why the query return so many fields
@@ -79,7 +81,7 @@ Demonstrates how to make a custom ruleset containing two checks. The sample cont
         "target": {
             "type": "Database",
             "version": "[12.0, 13.0)",
-            "platform": "/^(Windows|Linux)$/",
+            "platform": "Windows, Linux",
             "engineEdition": "OnPremises, ManagedInstance"
         },
         "implementation": {
@@ -91,7 +93,7 @@ Demonstrates how to make a custom ruleset containing two checks. The sample cont
         "target": {
         "type": "Database",
         "version": "[13.0,)",
-        "platform": "/^(Windows|Linux)$/",
+        "platform": "Windows, Linux",
         "engineEdition": "OnPremises, ManagedInstance"
         },
         "implementation": {

samples/manage/sql-assessment-api/README.md

@@ -5,12 +5,12 @@
     "probes":{
         "ManagedCodeRuleProbe": [
             {
-                "type": "CLR",
+                "type": "External",
                 "target": {
                   "type": "Server"
                 },
                 "implementation": {
-                  "class": "TestsProbeLibrary.Probe1",
+                  "class": "TestsProbeLibrary.Probe2",
                   "assembly": "C:\\SQLAsmnt\\CustomizationSamples\\TestsProbeLibrary.dll"
                 }
             }
@@ -27,11 +27,11 @@
             "itemType": "definition",
             "displayName": "Check uses 3rd-party assembly",
             "description": "This is an example of a check using an assembly to get required data.",
-            "message": "Method from the assembly returned a number greater than the threshold: @{QueryResult} > @{threshold}.",
+            "message": "Method from the assembly returned a number greater than the threshold: @{ActualCpuUtilization} > @{threshold}.",
             "target": { "type": "Server" },
             "probes": ["ManagedCodeRuleProbe"],
             "threshold": 83,
-            "condition": { "less": ["@QueryResult", "@threshold"]  }
+            "condition": { "less": ["@ActualCpuUtilization", "@threshold"]  }
         }
     ]
 }

samples/manage/sql-assessment-api/notebooks/CustomizationSamples/CustomRuleCLRProbe.json

@@ -27,7 +27,7 @@
                 "\n",
                 "Supported products and platforms: SQL Server 2012 and up, both on Windows and Linux. Azure SQL DB Managed Instance. More products to come.\n",
                 "\n",
-                "Microsoft ruleset ([config.json](https://github.com/microsoft/sql-server-samples/blob/master/samples/manage/sql-assessment-api/config.json)) is  published on SQL Assessment API GitHub repo and continuously improved.\n",
+                "Microsoft ruleset ([ruleset.json](https://github.com/microsoft/sql-server-samples/blob/master/samples/manage/sql-assessment-api/ruleset.json)) is  published on SQL Assessment API GitHub repo and continuously improved.\n",
                 "\n",
                 "Useful links at the bottom of the tutorial."
             ],
@@ -239,7 +239,7 @@
             "source": [
                 "### 4. Browse applicable rules\r\n",
                 "\r\n",
-                "The full Microsoft ruleset is in [config.json](https://github.com/microsoft/sql-server-samples/blob/master/samples/manage/sql-assessment-api/config.json) in the GitHub repo. If you want to list the rules that apply to a particular instance or database, you can use Get-SqlAssessmentItem cmdlet. Below are some different ways of listing the rules."
+                "The full Microsoft ruleset is in [ruleset.json](https://github.com/microsoft/sql-server-samples/blob/master/samples/manage/sql-assessment-api/ruleset.json) in the GitHub repo. If you want to list the rules that apply to a particular instance or database, you can use Get-SqlAssessmentItem cmdlet. Below are some different ways of listing the rules."
             ],
             "metadata": {
                 "azdata_cell_guid": "97414396-2557-44c4-80e2-5afa6a5a5516"
@@ -508,4 +508,4 @@
             }
         }
     ]
-}
+}

samples/manage/sql-assessment-api/notebooks/CustomizationSamples/TestsProbeLibrary.dll

@@ -1,16 +1,63 @@
 # Release notes for SQL Assessment API
 
-This article provides details about updates, improvements, and bug fixes for the current and previous versions of SQL Assessment API. SQL Assessment API is part of the SQL Server Management Objects (SMO) and the SQL Server PowerShell module. Install one of them or both to start working with the API.
+This article provides details about updates, improvements, and bug fixes for the current and previous versions of SQL Assessment API. SQL Assessment API is part of the SQL Server Management Objects (SMO) and the SQL Server PowerShell module. To start working with the API, install the SQL Assessment Extention to Azure Data Studio or utilize either the SqlServer module or SMO.
+
+Installing SQL Assessment Extension: [SQL Server Assessment Extension for Azure Data Studio (Public Preview)](https://techcommunity.microsoft.com/t5/sql-server/released-sql-server-assessment-extension-for-azure-data-studio/ba-p/1470603)
 
 Download: [Download SqlServer module](https://www.powershellgallery.com/packages/SqlServer)
 
 Download: [SMO NuGet Package](https://www.nuget.org/packages/Microsoft.SqlServer.SqlManagementObjects)
 
 You can use GitHub issues to provide feedback to the product team.
 
+## July 2020 - 21.1.18226
+
+Version: SqlServer module 21.1.18226, SqlManagementObjects (SMO) package wasn't updated
+
+### What's new
+
+- Added new types of probes in addition to SQL and EXTERNAL: CMDSHELL, WMI, REGISTRY, POWERSHELL
+- Enabling/disabling database checks for particular SQL Server instances (by instance name)
+- Added 40 rules, including  
+  - Ad Hoc Distributed Queries are enabled
+  - Affinity Mask and Affinity I/O Mask overlapping
+  - Auto Soft NUMA should be enabled
+  - Blocking chains
+  - Blocked Process Threshold is set to recommended value
+  - Option 'cross db ownership chaining' should be disabled
+  - Default trace enabled
+  - Disk Partition alignment
+  - Full-text search option 'load_os_resources' set to default
+  - Full-text search option 'verify_signature' set to default
+  - HP Logical Processor issue
+  - Option 'index create memory' value should be greater 'min memory per query'
+  - Lightweight pooling option disabled
+  - Option 'locks' should be set to default
+  - Option 'min memory per query' set to default
+  - Option 'network packet size' set to default
+  - NTFS block size in volumes that hold database files <> 64KB
+  - Option 'Ole Automation Procedures' set to default
+  - Page file is not automatically managed
+  - Insufficient page file free space
+  - Page file configured
+  - Memory paged out
+  - Power plan is High Performance
+  - Option 'priority boost' set to default
+  - Option 'query wait' set to default
+  - Option 'recovery interval' set to default
+  - Remote admin connections enabled on cluster (DAC)
+  - Option 'remote query timeout' set to default
+  - Option 'scan for startup procs' disabled on replication servers
+  - Worker thread exhaustion on CPU-bound system
+  - Possible worker thread exhaustion on a not-CPU-bound system
+  - Option 'cost threshold for parallelism' set to default
+  - Option 'max worker threads' set to recommended value on x64 system
+  - Option 'max worker threads' set to recommended value on x86 system
+  - Option 'xp_cmdshell' is disabled
+
 ## March 2020 - 21.1.18221
 
-Version: SqlServer module 21.1.18221, SqlManagementObjects (SMO) package wasn't updated
+Version: SqlServer module 21.1.18221, SqlManagementObjects (SMO) package 160.2004021.0
 
 ### What's new