Skip to content

Commit 57831eb

Browse files
authored
Merge pull request #18740 from TDzakhov/march_release
[SQL API] Mentioned Vulnerability Assessment
2 parents b8db7f0 + 2877835 commit 57831eb

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

docs/tools/sql-assessment-api/sql-assessment-api-overview.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ author: markingmyname
88
ms.author: maghan
99
ms.reviewer: ""
1010
ms.custom: ""
11-
ms.date: 3/3/2021
11+
ms.date: 3/5/2021
1212
---
1313

1414
# SQL Assessment API
1515

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.
1717

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.
1919

2020
The API can be used to assess:
2121

@@ -29,11 +29,14 @@ The API can be used to assess:
2929

3030
The API is also used by SQL Server Assessment Extension for Azure Data Studio (ADS).
3131

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+
3235
## Rules
3336

3437
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.
3538

36-
Microsoft's shipped ruleset is available on GitHub. You can visit the [samples repository](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).
3740

3841
## SQL Assessment cmdlets and associated extensions
3942

@@ -151,10 +154,11 @@ Specific rules have thresholds that are compared against the current value of a
151154
152155
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.
153156
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.
156159
157160
## Next steps
158161
159162
* [SQL Server Management Objects (SMO)](../../relational-databases/server-management-objects-smo/overview-smo.md)
160-
* [PowerShell](../../powershell/download-sql-server-ps-module.md).
163+
* [PowerShell](../../powershell/download-sql-server-ps-module.md)
164+
* [SQL Vulnerability Assessment](https://docs.microsoft.com/sql/relational-databases/security/sql-vulnerability-assessment)

0 commit comments

Comments
 (0)