Skip to content

Commit e4f7033

Browse files
committed
Adding QuickStart.md and updating readme
1 parent 394257f commit e4f7033

3 files changed

Lines changed: 49 additions & 0 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +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+
### 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.2.18179 is the latest version and CTP2 for SQL Assessment API.
8+
9+
```PowerShell
10+
Install-Module -Name SqlServer -AllowClobber -Force
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 for a full list of rules and properties.
32+
33+
If you want to get recommendations for all databases on the local instance, you can 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

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Contains samples for customizing SQL Assessment API. 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).
44

5+
## QuickStart.md
6+
7+
Learn how to assess your SQL Server configuration for best practices in 2 simple steps.
8+
59
## config.json
610

711
This is the default set of checks shipped with SQL Assessment API. Feel free to open issues to have us fix or add checks. Also, we're happy to see your pull requests to this file.
460 KB
Loading

0 commit comments

Comments
 (0)