az sql vm

Commands

Name	Description	Type	Status
az sql vm add-to-group	Adds SQL virtual machine to a SQL virtual machine group.	Core	GA
az sql vm create	Creates a SQL virtual machine.	Core	GA
az sql vm delete	Deletes a SQL virtual machine.	Core	GA
az sql vm enable-azure-ad-auth	Enable Azure AD authentication of a SQL virtual machine.	Core	GA
az sql vm group	Manage SQL virtual machine groups.	Core	GA
az sql vm group ag-listener	Manage SQL availability group listeners.	Core	GA
az sql vm group ag-listener create	Creates an availability group listener.	Core	GA
az sql vm group ag-listener delete	Deletes an availability group listener.	Core	GA
az sql vm group ag-listener list	Lists all availability group listeners in a SQL virtual machine group.	Core	GA
az sql vm group ag-listener show	Gets an availability group listener.	Core	GA
az sql vm group ag-listener update	Updates an availability group listener.	Core	GA
az sql vm group create	Creates a SQL virtual machine group.	Core	GA
az sql vm group delete	Deletes a SQL virtual machine group.	Core	GA
az sql vm group list	Lists all SQL virtual machine groups in a resource group or subscription.	Core	GA
az sql vm group show	Gets a SQL virtual machine group.	Core	GA
az sql vm group update	Updates a SQL virtual machine group if there are not SQL virtual machines attached to the group.	Core	GA
az sql vm list	Lists all SQL virtual machines in a resource group or subscription.	Core	GA
az sql vm remove-from-group	Remove SQL virtual machine from its current SQL virtual machine group.	Core	GA
az sql vm show	Gets a SQL virtual machine.	Core	GA
az sql vm start-assessment	Starts SQL best practice assessment on SQL virtual machine.	Core	GA
az sql vm update	Updates the properties of a SQL virtual machine.	Core	GA
az sql vm validate-azure-ad-auth	Validate Azure AD authentication of a SQL virtual machine at the client side without enabling it.	Core	GA

az sql vm add-to-group --sqlvm-group
                       [--bootstrap-acc-pwd]
                       [--ids]
                       [--name]
                       [--operator-acc-pwd]
                       [--resource-group]
                       [--service-acc-pwd]
                       [--subscription]

Examples

Add SQL virtual machine to a group.

az sql vm add-to-group -n sqlvm -g myresourcegroup --sqlvm-group sqlvmgroup --bootstrap-acc-pwd {bootstrappassword} --operator-acc-pwd {operatorpassword} --service-acc-pwd {servicepassword}

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm create --name
                 --resource-group
                 [--backup-pwd]
                 [--backup-schedule-type {Automated, Manual}]
                 [--backup-system-dbs {false, true}]
                 [--connectivity-type {LOCAL, PRIVATE, PUBLIC}]
                 [--credential-name]
                 [--day-of-week {Everyday, Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                 [--enable-auto-backup {false, true}]
                 [--enable-auto-patching {false, true}]
                 [--enable-encryption {false, true}]
                 [--enable-key-vault-credential {false, true}]
                 [--enable-r-services {false, true}]
                 [--full-backup-duration]
                 [--full-backup-frequency {Daily, Weekly}]
                 [--full-backup-start-hour]
                 [--image-offer]
                 [--image-sku {Developer, Enterprise, Express, Standard, Web}]
                 [--key-vault]
                 [--least-privilege-mode {Enabled, NotSet}]
                 [--license-type {AHUB, DR, PAYG}]
                 [--location]
                 [--log-backup-frequency]
                 [--maintenance-window-duration]
                 [--maintenance-window-start-hour]
                 [--port]
                 [--retention-period]
                 [--sa-key]
                 [--sp-name]
                 [--sp-secret]
                 [--sql-auth-update-pwd]
                 [--sql-auth-update-username]
                 [--sql-mgmt-type {Full, LightWeight, NoAgent}]
                 [--sql-workload-type {DW, GENERAL, OLTP}]
                 [--storage-account]
                 [--tags]

Examples

Create a SQL virtual machine with AHUB billing tag.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type AHUB

Create a SQL virtual machine with DR billing tag.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type DR

Create a SQL virtual machine with specific sku type and license type.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --image-sku Enterprise --license-type AHUB

Create a SQL virtual machine with least privilege mode enabled.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --least-privilege-mode Enabled --sql-mgmt-type Full

Create a SQL virtual machine with NoAgent type, only valid for EOS SQL 2008 and SQL 2008 R2.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type AHUB --sql-mgmt-type NoAgent --image-sku Enterprise --image-offer SQL2008-WS2008R2

Enable R services in SQL2016 onwards.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type PAYG --sql-mgmt-type Full --enable-r-services true

Create SQL virtual machine and configure auto backup settings.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type PAYG --sql-mgmt-type Full --backup-schedule-type manual --full-backup-frequency Weekly --full-backup-start-hour 2 --full-backup-duration 2 --sa-key {storageKey} --storage-account 'https://storageacc.blob.core.windows.net/' --retention-period 30 --log-backup-frequency 60

Create SQL virtual machine and configure auto patching settings.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type PAYG --sql-mgmt-type Full --day-of-week sunday --maintenance-window-duration 60 --maintenance-window-start-hour 2

Create SQL virtual machine and configure SQL connectivity settings.

az sql vm create -n sqlvm -g myresourcegroup -l eastus --license-type PAYG --sql-mgmt-type Full --connectivity-type private --port 1433 --sql-auth-update-username {newlogin} --sql-auth-update-pwd {sqlpassword}

Required Parameters

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm delete [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]
                 [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm enable-azure-ad-auth [--ids]
                               [--msi-client-id]
                               [--name]
                               [--resource-group]
                               [--skip-client-validation]
                               [--subscription]

Examples

Enable Azure AD authentication with system-assigned managed identity with client side validation.

az sql vm enable-azure-ad-auth -n sqlvm -g myresourcegroup

Enable Azure AD authentication with user-assigned managed identity with client side validation.

az sql vm enable-azure-ad-auth -n sqlvm -g myresourcegroup --msi-client-id 12345678

Enable Azure AD authentication with system-assigned managed identity skipping client side validation. The server side validation always happens.

az sql vm enable-azure-ad-auth -n sqlvm -g myresourcegroup --skip-client-validation

Enable Azure AD authentication with user-assigned managed identity skipping client side validation. The server side validation always happens.

az sql vm enable-azure-ad-auth -n sqlvm -g myresourcegroup --msi-client-id 12345678 --skip-client-validation

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm list [--resource-group]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm remove-from-group [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Examples

Remove SQL virtual machine from a group.

az sql vm remove-from-group -n sqlvm -g myresourcegroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm show [--expand {*, AssessmentSettings, AutoBackupSettings, AutoPatchingSettings, KeyVaultCredentialSettings, ServerConfigurationsManagementSettings}]
               [--ids]
               [--name]
               [--resource-group]
               [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm start-assessment [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Examples

Starts SQL best practice assessment.

az sql vm start-assessment -n sqlvm -g myresourcegroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm update [--add]
                 [--agent-rg]
                 [--am-day --assessment-day-of-week {Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                 [--am-month-occ --assessment-monthly-occurrence {-1, 1, 2, 3, 4}]
                 [--am-schedule --enable-assessment-schedule {false, true}]
                 [--am-time --assessment-start-time-local]
                 [--am-week-int --assessment-weekly-interval {1, 2, 3, 4, 5, 6}]
                 [--backup-pwd]
                 [--backup-schedule-type {Automated, Manual}]
                 [--backup-system-dbs {false, true}]
                 [--connectivity-type {LOCAL, PRIVATE, PUBLIC}]
                 [--credential-name]
                 [--day-of-week {Everyday, Friday, Monday, Saturday, Sunday, Thursday, Tuesday, Wednesday}]
                 [--enable-assessment {false, true}]
                 [--enable-auto-backup {false, true}]
                 [--enable-auto-patching {false, true}]
                 [--enable-encryption {false, true}]
                 [--enable-key-vault-credential {false, true}]
                 [--enable-r-services {false, true}]
                 [--force-string]
                 [--full-backup-duration]
                 [--full-backup-frequency {Daily, Weekly}]
                 [--full-backup-start-hour]
                 [--ids]
                 [--image-sku {Developer, Enterprise, Express, Standard, Web}]
                 [--key-vault]
                 [--least-privilege-mode {Enabled, NotSet}]
                 [--license-type {AHUB, DR, PAYG}]
                 [--log-backup-frequency]
                 [--maintenance-window-duration]
                 [--maintenance-window-start-hour]
                 [--name]
                 [--port]
                 [--remove]
                 [--resource-group]
                 [--retention-period]
                 [--sa-key]
                 [--set]
                 [--sp-name]
                 [--sp-secret]
                 [--sql-mgmt-type {Full, LightWeight, NoAgent}]
                 [--sql-workload-type {DW, GENERAL, OLTP}]
                 [--storage-account]
                 [--subscription]
                 [--tags]
                 [--workspace-name]
                 [--workspace-rg]
                 [--workspace-sub]
                 [--yes]

Examples

Add or update a tag.

az sql vm update -n sqlvm -g myresourcegroup --set tags.tagName=tagValue

Remove a tag.

az sql vm update -n sqlvm -g myresourcegroup --remove tags.tagName

Update a SQL virtual machine with specific sku type.

az sql vm update -n sqlvm -g myresourcegroup --image-sku Enterprise

Update a SQL virtual machine manageability from LightWeight to Full.

az sql vm update -n sqlvm -g myresourcegroup --sql-mgmt-type Full

Update a SQL virtual machine to least privilege mode.

az sql vm update -n sqlvm -g myresourcegroup --least-privilege-mode Enabled --sql-mgmt-type Full

Update SQL virtual machine auto backup settings.

az sql vm update -n sqlvm -g myresourcegroup --backup-schedule-type manual --full-backup-frequency Weekly --full-backup-start-hour 2 --full-backup-duration 2 --sa-key {storageKey} --storage-account 'https://storageacc.blob.core.windows.net/' --retention-period 30 --log-backup-frequency 60

Disable SQL virtual machine auto backup settings.

az sql vm update -n sqlvm -g myresourcegroup --enable-auto-backup false

Update SQL virtual machine auto patching settings.

az sql vm update -n sqlvm -g myresourcegroup --day-of-week sunday --maintenance-window-duration 60 --maintenance-window-start-hour 2

Disable SQL virtual machine auto patching settings.

az sql vm update -n sqlvm -g myresourcegroup --enable-auto-patching false

Update a SQL virtual machine billing tag to AHUB.

az sql vm update -n sqlvm -g myresourcegroup --license-type AHUB

Update a SQL virtual machine billing tag to DR.

az sql vm update -n sqlvm -g myresourcegroup --license-type DR

Update a SQL virtual machine to disable SQL best practice assessment.

az sql vm update -n sqlvm -g myresourcegroup --enable-assessment false

Update a SQL virtual machine to disable schedule for SQL best practice assessment.

az sql vm update -n sqlvm -g myresourcegroup --enable-assessment-schedule false

Update a SQL virtual machine to enable schedule with weekly interval for SQL best practice assessment when VM is already associated with a Log Analytics workspace.

az sql vm update -n sqlvm -g myresourcegroup --assessment-weekly-interval 1 --assessment-day-of-week monday --assessment-start-time-local '19:30'

Update a SQL virtual machine to enable schedule with monthly occurrence for SQL best practice assessment while associating with a Log Analytics workspace and assigning a Resource group for the Agent resources.

az sql vm update -n sqlvm -g myresourcegroup --workspace-name myLogAnalyticsWorkspace --workspace-rg myRg --agent-rg myRg2 --assessment-monthly-occurrence 1 --assessment-day-of-week monday --assessment-start-time-local '19:30'

Update a SQL virtual machine to enable SQL best practices assessment without setting a schedule for running assessment on-demand. Must provide Log Analytics workspace and a Resource group for deploying the Agent resources.

az sql vm update -n sqlvm -g myresourcegroup --enable-assessment true --workspace-name myLogAnalyticsWorkspace --workspace-rg myRg --agent-rg myRg2

Update a SQL virtual machine to enable SQL best practices assessment while associating with a Log Analytics Workspace in a different subscription

az sql vm update -n sqlvm -g myresourcegroup --enable-assessment true --workspace-name myLogAnalyticsWorkspace --workspace-rg myRg --workspace-sub myLogAnalyticsWorkspaceSubName --agent-rg myRg2

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sql vm validate-azure-ad-auth [--ids]
                                 [--msi-client-id]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Validate Azure AD authentication with system-assigned managed identity at the client side.

az sql vm validate-azure-ad-auth -n sqlvm -g myresourcegroup

Validate Azure AD authentication with user-assigned managed identity at the client side.

az sql vm validate-azure-ad-auth -n sqlvm -g myresourcegroup --msi-client-id 12345678

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False