Skip to content

Commit fe294dc

Browse files
Updated QuickStart.md
1 parent aae8c27 commit fe294dc

1 file changed

Lines changed: 45 additions & 46 deletions

File tree

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
1-
# SQL Assessment API Quick Start Guide
2-
3-
Assess your SQL Server configuration for best practices in 2 simple steps.
4-
5-
6-
### 1. Setup
7-
8-
You just need to install PowerShell SqlServer module using the following command. Get-Module will show you the version you have installed. 21.2.18179 is the latest version and CTP2 for SQL Assessment API.
9-
10-
```PowerShell
11-
Install-Module -Name SqlServer -AllowClobber -Force
12-
Get-Module
13-
```
14-
15-
### 2. Invoke an assessment
16-
17-
This command runs an assessment against your local SQL Server instance.
18-
19-
```PowerShell
20-
Get-SqlInstance -ServerInstance 'localhost' | Invoke-SqlAssessment
21-
```
22-
23-
Sample result:
24-
![Sample Result](images/SQLAssessmentPSResult.png)
25-
26-
You will see in the results that each rule has some properties (not the full list):
27-
28-
- Severity (info, warning, critical)
29-
- Message property explains the recommendation but if you need more info, there is a HelpLink property that points at documentation on the subject.
30-
- Origin shows which ruleset and version the recommendation is coming from
31-
32-
See config.json for a full list of rules and properties.
33-
34-
If you want to get recommendations for all databases on the local instance, you can run this command.
35-
36-
```PowerShell
37-
Get-SqlDatabase -ServerInstance 'localhost' | Invoke-SqlAssessment
38-
```
39-
40-
## Learn more about SQL Assessment API
41-
42-
To learn more about SQL Assessment API such as customizing and extending the ruleset, saving the results in a table, etc., please visit:
43-
44-
- Docs online page: https://docs.microsoft.com/sql/sql-assessment-api/sql-assessment-api-overview
45-
- GitHub repo: http://aka.ms/sql-assessment-api
46-
- SQL Assessment API Tutorial notebook: coming soon
1+
# SQL Assessment API Quick Start Guide
2+
3+
Assess your SQL Server configuration for best practices in 2 simple steps.
4+
5+
### 1. Setup
6+
7+
You just need to install PowerShell SqlServer module using the following command. Get-Module will show you the version you have installed. 21.1.18206 is the latest version and GA for SQL Assessment API.
8+
9+
```PowerShell
10+
Install-Module -Name SqlServer -AllowClobber
11+
Get-Module
12+
```
13+
14+
### 2. Invoke an assessment
15+
16+
This command runs an assessment against your local SQL Server instance.
17+
18+
```PowerShell
19+
Get-SqlInstance -ServerInstance 'localhost' | Invoke-SqlAssessment
20+
```
21+
22+
Sample result:
23+
![Sample Result](images/SQLAssessmentPSResult.png)
24+
25+
You will see in the results that each rule has some properties (not the full list):
26+
27+
- Severity (info, warning, critical)
28+
- Message property explains the recommendation but if you need more info, there is a HelpLink property that points at documentation on the subject.
29+
- Origin shows which ruleset and version the recommendation is coming from
30+
31+
See [config.json](./config.json) for a full list of rules and properties.
32+
33+
If you want to get recommendations for all databases on the local instance, run this command.
34+
35+
```PowerShell
36+
Get-SqlDatabase -ServerInstance 'localhost' | Invoke-SqlAssessment
37+
```
38+
39+
## Learn more about SQL Assessment API
40+
41+
To learn more about SQL Assessment API such as customizing and extending the ruleset, saving the results in a table, etc., please visit:
42+
43+
- Docs online page: https://docs.microsoft.com/sql/sql-assessment-api/sql-assessment-api-overview
44+
- GitHub repo: http://aka.ms/sql-assessment-api
45+
- SQL Assessment API Tutorial notebook: coming soon

0 commit comments

Comments
 (0)