You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/sql-assessment-api/sql-assessment-api-overview.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ author: markingmyname
8
8
ms.author: maghan
9
9
ms.reviewer: ""
10
10
ms.custom: ""
11
-
ms.date: 3/3/2021
11
+
ms.date: 3/5/2021
12
12
---
13
13
14
14
# SQL Assessment API
15
15
16
-
SQL Assessment API provides a mechanism to evaluate the configuration of your SQL Server for best practices. The API is delivered with a ruleset containing best practice rules suggested by SQL Server Team. This ruleset is enhanced with the release of new versions but at the same time, the API is built with the intent to give a highly customizable and extensible solution. So, users can tune the default rules and create their own.
16
+
The SQL Assessment API provides a mechanism to evaluate the configuration of your SQL Server for best practices. The API is delivered with a ruleset containing best practice rules suggested by SQL Server Team. This ruleset is enhanced with the release of new versions, but at the same time, the API is built with the intent to give a highly customizable and extensible solution. So, users can tune the default rules and create their own.
17
17
18
-
SQL Assessment API is useful when you want to make sure your SQL Server configuration is in line with recommended best practices. After an initial assessment, configuration stability can be tracked by regularly scheduled assessments.
18
+
The SQL Assessment API is useful when you want to make sure your SQL Server configuration is in line with recommended best practices. After an initial assessment, configuration stability can be tracked by regularly scheduled assessments.
19
19
20
20
The API can be used to assess:
21
21
@@ -29,11 +29,14 @@ The API can be used to assess:
29
29
30
30
The API is also used by SQL Server Assessment Extension for Azure Data Studio (ADS).
31
31
32
+
>[!NOTE]
33
+
>The SQL Assessment API provides assessment on a variety of areas, but it does not go deeply into security. We recommend you use [SQL Vulnerability Assessment](https://docs.microsoft.com/sql/relational-databases/security/sql-vulnerability-assessment) to proactively improve your database security.
34
+
32
35
## Rules
33
36
34
37
Rules (sometimes referred to as checks) are defined in JSON formatted files. The ruleset format requires a ruleset name and version to be specified. When you use custom rulesets, you can easily know which recommendations from what ruleset come.
35
38
36
-
Microsoft's shipped ruleset is available on GitHub. You can visit the [samplesrepository](https://aka.ms/sql-assessment-api) for more details.
39
+
The Microsoft's shipped ruleset is available on GitHub. You can view the [entire ruleset](https://github.com/microsoft/sql-server-samples/blob/567d49a42d4cf10e4942b19290ab80828b451b77/samples/manage/sql-assessment-api/DefaultRuleset.csv) in the [samples repository](https://aka.ms/sql-assessment-api).
37
40
38
41
## SQL Assessment cmdlets and associated extensions
39
42
@@ -151,10 +154,11 @@ Specific rules have thresholds that are compared against the current value of a
151
154
152
155
You can string together rulesets by adding one or more JSON files as parameters to your SQL Assessment API call. Your organization might write those files or obtain them from a third party. For example, you can have your JSON file that disables specific rules from the Microsoft ruleset, and another JSON file by an industry expert that include rules you find useful for your environment, followed by another JSON file that changes some threshold values in that JSON file.
153
156
154
-
>[!IMPORTANT]
155
-
>We urge you not to use rulesets that come from untrusted sources until you thoroughly review them to make sure they are safe.
157
+
>[!IMPORTANT]
158
+
>We urge you not to use rulesets that come from untrusted sources until you thoroughly review them to make sure they are safe.
156
159
157
160
## Next steps
158
161
159
162
* [SQL Server Management Objects (SMO)](../../relational-databases/server-management-objects-smo/overview-smo.md)
0 commit comments