Azure SQL Database CLI Reference

This document provides a comprehensive reference for the Azure CLI commands used to manage Azure SQL Databases.

az sql db

Manage Azure SQL databases.

Subgroups

  • copy - Manage database copies.
  • create - Create a SQL database.
  • delete - Delete a SQL database.
  • list - List SQL databases.
  • show - Show the details of a SQL database.
  • update - Update a SQL database.
  • restore - Restore a SQL database.
  • operation-status - Get the status of an operation.

az sql db create

Create a SQL database.

az sql db create
az sql db create --resource-group RESOURCE_GROUP --server SERVER_NAME --name DATABASE_NAME [options]

Parameters

  • --name -n Name of the SQL database.
  • --resource-group -g Name of resource group. You can configure the default group using az configure --defaults group=<name>.
  • --server -s Name of the Azure SQL server.
  • --edition Edition of the database. Possible values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical, Hyperscale.
  • --capacity The capacity of the database in DTUs or vCores.
  • --zone-redundant Enable or disable zone redundancy.
  • --collation Collation of the database. Default is 'SQL_Latin1_General_CP1_CI_AS'.
  • --catalog-collection-max-size Maximum size of the Catalog Collection, in GB. Applicable for Hyperscale.
  • --max-size Maximum size of the database.
To see all available editions and their corresponding capacity values, run az sql db list --resource-group <resource-group> -s <server-name> --query "[].{Name:name, Edition:edition, Capacity:requestedServiceObjectiveName}" -o table.

Example

Create a Standard S0 database
az sql db create -g myResourceGroup -s myAzureSQLServer -n mySampleDatabase -e Standard -c 10
Create a GeneralPurpose vCore based database
az sql db create -g myResourceGroup -s myAzureSQLServer -n myVCoreDatabase -e GeneralPurpose -c 4 --tier GeneralPurpose

az sql db list

List SQL databases.

az sql db list
az sql db list [options]

Parameters

  • --resource-group -g Name of resource group.
  • --server -s Name of the Azure SQL server.
  • --expand The comma separated list of OData IDs. See Azure SQL Database REST API for details.

Example

List databases in a specific server
az sql db list -g myResourceGroup -s myAzureSQLServer

az sql db show

Show the details of a SQL database.

az sql db show
az sql db show --resource-group RESOURCE_GROUP --server SERVER_NAME --name DATABASE_NAME

Parameters

  • --name -n Name of the SQL database.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Azure SQL server.

Example

Show details of a specific database
az sql db show -g myResourceGroup -s myAzureSQLServer -n mySampleDatabase

az sql db update

Update a SQL database.

az sql db update
az sql db update --resource-group RESOURCE_GROUP --server SERVER_NAME --name DATABASE_NAME [options]

Parameters

  • --name -n Name of the SQL database.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Azure SQL server.
  • --edition Edition of the database. Possible values include: Basic, Standard, Premium, GeneralPurpose, BusinessCritical, Hyperscale.
  • --capacity The capacity of the database in DTUs or vCores.
  • --zone-redundant Enable or disable zone redundancy.
  • --tags Space-separated tags in the form: key[=value].

Example

Update database edition and capacity
az sql db update -g myResourceGroup -s myAzureSQLServer -n mySampleDatabase -e Premium -c 100

az sql db delete

Delete a SQL database.

az sql db delete
az sql db delete --resource-group RESOURCE_GROUP --server SERVER_NAME --name DATABASE_NAME [options]

Parameters

  • --name -n Name of the SQL database.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Azure SQL server.
  • --yes -y Do not prompt for confirmation.

Example

Delete a database without confirmation
az sql db delete -g myResourceGroup -s myAzureSQLServer -n mySampleDatabase -y

az sql db restore

Restore a SQL database.

az sql db restore
az sql db restore --resource-group RESOURCE_GROUP --server SERVER_NAME --name DATABASE_NAME --dest-name DESTINATION_DATABASE_NAME [options]

Parameters

  • --name -n Name of the source SQL database to restore.
  • --resource-group -g Name of resource group.
  • --server -s Name of the Azure SQL server.
  • --dest-name Name for the new restored database.
  • --time Restore point in time to restore from (ISO8601 format).

Example

Restore a database to a specific point in time
az sql db restore -g myResourceGroup -s myAzureSQLServer -n mySampleDatabase --dest-name mySampleDatabaseRestored -t "2023-10-27T10:30:00Z"