[SQL VM] az sql vm update: Add configuration options for SQL Best Practices Assessment

[vadeveka]

Description
SQL VM offers ability to configure and run assessment on-demand or on a schedule as noted in public doc. This allows customers to evaluate SQL Server on their VMs against the best practices and identify performance issues. This PR adds support for configuring assessment feature and starting assessment from CLI. Customers can then track progress of the run and view results on Azure Portal.

As defined in this technical spec, this pull request has been developed with Approach 1 in mind. In next iteration, this will be enhanced to Approach 2 by taking inspiration from az vm cretae/update implementation before publicizing the commandlets.

Testing Guide

// Enables Assessment feature and enables or updates schedule with assessment to run every 3 weeks, starting on Sunday at local time 23:00
az sql vm update –assessment-weekly-interval 3 --assessment-day-of-week Sunday –assessment-start-time-local "23:00" -g <Resource Group Name> -n <SQL VM Name>
 
// Enables Assessment feature and enables or updates schedule with assessment to run every 2nd Sunday of the month at local time 23:00
az sql vm update –monthly-occurrence 2 --assessment-day-of-week Sunday –assessment-start-time-local "23:00" -g <Resource Group Name> -n <SQL VM Name>

// Start assessment immediately
az sql vm start-assessment -g <Resource Group Name> -n <SQL VM Name>

// Disable schedule but keep the feature enabled
az sql vm update --enable-assessment-schedule false -g <Resource Group Name> -n <SQL VM Name>

// Disable feature and schedule if any
az sql vm update --enable-assessment false -g <Resource Group Name> -n <SQL VM Name>

History Notes

[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change.
[Component Name 2] az command b: Add some customer-facing feature.

---

This checklist is used to make sure that common guidelines for a pull request are followed.

• The PR title and description has followed the guideline in Submitting Pull Requests.

• I adhere to the Command Guidelines.

• I adhere to the Error Handling Guidelines.

[yonzhan]

sqlVM

[vadeveka]

@evelyn-ys - CLI linter is failing due to long argument names such as --assessment-monthly-occurrence. Even if I were to change it to --asmt-monthly-occurrence, it still exceeds 22 characters. For readability purposes, I think it would be best to keep the long names. I dont think there is easier alternative for "monthly-occurrence". Let me know if this requirement can be suppressed in some way for the 4 arguments.

[evelyn-ys]

Hi @vadeveka, You can keep the --assessment-monthly-occurrence argument and set more short options using options_list. For example:

c.argument('assessment_monthly_occurrence', options_list=['--assessment-monthly-occurrence', '--am-occur'], help='...')

[evelyn-ys]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).