az sql

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure SQL Databases and Data Warehouses.

Commands

Name Description Type Status
az sql db

Manage databases.

Core GA
az sql db-arc

Manage databases for Azure Arc-enabled SQL Server instance.

Extension Preview
az sql db-arc backups-policy

Manage backups policy.

Extension Preview
az sql db-arc backups-policy delete

Delete your current backups policy.

Extension Preview
az sql db-arc backups-policy set

Set your backups policy.

Extension Preview
az sql db-arc backups-policy show

See your current backups policy.

Extension Preview
az sql db-arc restore

Restore a database from the built-in automatic backups.

Extension Preview
az sql db advanced-threat-protection-setting

Manage a database's advanced threat protection setting.

Core GA
az sql db advanced-threat-protection-setting show

Gets an advanced threat protection setting.

Core GA
az sql db advanced-threat-protection-setting update

Update a database's advanced threat protection setting.

Core GA
az sql db audit-policy

Manage a database's auditing policy.

Core GA
az sql db audit-policy show

Show database audit policy.

Core GA
az sql db audit-policy update

Update a database's auditing policy.

Core GA
az sql db audit-policy wait

Place the CLI in a waiting state until a condition of the database's audit policy is met.

Core GA
az sql db classification

Manage sensitivity classifications.

Core GA
az sql db classification delete

Delete the sensitivity classification of a given column.

Core GA
az sql db classification list

Get the sensitivity classifications of a given database.

Core GA
az sql db classification recommendation

Manage sensitivity classification recommendations.

Core GA
az sql db classification recommendation disable

Disable sensitivity recommendations for a given column (recommendations are enabled by default on all columns).

Core GA
az sql db classification recommendation enable

Enable sensitivity recommendations for a given column (recommendations are enabled by default on all columns).

Core GA
az sql db classification recommendation list

List the recommended sensitivity classifications of a given database.

Core GA
az sql db classification show

Get the sensitivity classification of a given column.

Core GA
az sql db classification update

Update a columns's sensitivity classification.

Core GA
az sql db copy

Create a copy of a database.

Core GA
az sql db create

Create a database.

Core GA
az sql db delete

Delete a database.

Core GA
az sql db export

Export a database to a bacpac.

Core GA
az sql db geo-backup

Manage SQL database geo redundant backups.

Core Preview
az sql db geo-backup list

Gets a list of recoverable databases.

Core Preview
az sql db geo-backup restore

Restore a geo-redundant backup to a new database.

Core Preview
az sql db geo-backup show

Gets a recoverable database, which is a resource representing a database's geo backup.

Core Preview
az sql db import

Imports a bacpac into a new database, or an existing empty database.

Core GA
az sql db ledger-digest-uploads

Manage ledger digest upload settings.

Core GA
az sql db ledger-digest-uploads disable

Disable uploading ledger digests.

Core GA
az sql db ledger-digest-uploads enable

Enable uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger. If uploading ledger digests is already enabled, the cmdlet resets the digest storage endpoint to a new value.

Core GA
az sql db ledger-digest-uploads show

Show the current ledger digest settings.

Core GA
az sql db list

List databases on a server or elastic pool.

Core GA
az sql db list-deleted

Gets a list of restorable dropped databases.

Core GA
az sql db list-editions

Show database editions available for the currently active subscription.

Core GA
az sql db list-usages

Gets database usages.

Core GA
az sql db ltr-backup

Manage SQL database long term retention backups.

Core Preview
az sql db ltr-backup delete

Delete a long term retention backup.

Core Preview
az sql db ltr-backup list

List the long term retention backups for a location, server or database.

Core Preview
az sql db ltr-backup restore

Restore a long term retention backup to a new database.

Core Preview
az sql db ltr-backup show

Get a long term retention backup for a database.

Core Preview
az sql db ltr-backup wait

Place the CLI in a waiting state until a condition of the database is met.

Core Preview
az sql db ltr-policy

Manage SQL database long term retention policy.

Core Preview
az sql db ltr-policy set

Update long term retention settings for a database.

Core Preview
az sql db ltr-policy show

Show the long term retention policy for a database.

Core Preview
az sql db op

Manage operations on a database.

Core GA
az sql db op cancel

Cancels the asynchronous operation on the database.

Core GA
az sql db op list

Gets a list of operations performed on the database.

Core GA
az sql db rename

Rename a database.

Core GA
az sql db replica

Manage replication between databases.

Core GA
az sql db replica create

Create a database as a readable secondary replica of an existing database.

Core GA
az sql db replica delete-link

Permanently stop data replication between two database replicas.

Core GA
az sql db replica list-links

List the replicas of a database and their replication status.

Core GA
az sql db replica set-primary

Set the primary replica database by failing over from the current primary replica database.

Core GA
az sql db restore

Create a new database by restoring from a backup.

Core GA
az sql db show

Get the details for a database.

Core GA
az sql db show-connection-string

Generates a connection string to a database.

Core GA
az sql db show-deleted

Get the details for a deleted database.

Core GA
az sql db str-policy

Manage SQL database short term retention policy.

Core Preview
az sql db str-policy set

Update short term retention settings for a live database.

Core Preview
az sql db str-policy show

Show the short term retention policy for a live database.

Core Preview
az sql db str-policy wait

Place the CLI in a waiting state until the policy is set.

Core Preview
az sql db tde

Manage a database's transparent data encryption.

Core GA
az sql db tde key

Manage a database's encryption protector.

Core GA
az sql db tde key revalidate

Revalidates a database's encryption protector key.

Core GA
az sql db tde key revert

Reverts a database's encryption protector key to server level.

Core GA
az sql db tde set

Sets a database's transparent data encryption configuration.

Core GA
az sql db tde show

Shows a Transparent Data Encryption.

Core GA
az sql db threat-policy

Manage a database's threat detection policies.

Core Deprecated
az sql db threat-policy show

Gets a threat detection policy.

Core Deprecated
az sql db threat-policy update

Update a database's threat detection policy.

Core Deprecated
az sql db update

Update a database.

Core GA
az sql down

Delete the SQL server and its cached information.

Extension Deprecated
az sql dw

Manage data warehouses.

Core GA
az sql dw create

Create a data warehouse.

Core GA
az sql dw delete

Delete a data warehouse.

Core GA
az sql dw list

List data warehouses for a server.

Core GA
az sql dw pause

Pauses a datawarehouse.

Core GA
az sql dw resume

Resumes a datawarehouse.

Core GA
az sql dw show

Get the details for a data warehouse.

Core GA
az sql dw update

Update a data warehouse.

Core GA
az sql elastic-pool

Manage elastic pools.

Core GA
az sql elastic-pool create

Create an elastic pool.

Core GA
az sql elastic-pool delete

Deletes an elastic pool.

Core GA
az sql elastic-pool list

Gets all elastic pools in a server.

Core GA
az sql elastic-pool list-dbs

Gets a list of databases in an elastic pool.

Core GA
az sql elastic-pool list-editions

List elastic pool editions available for the active subscription.

Core GA
az sql elastic-pool op

Manage operations on an elastic pool.

Core GA
az sql elastic-pool op cancel

Cancels the asynchronous operation on the elastic pool.

Core GA
az sql elastic-pool op list

Gets a list of operations performed on the elastic pool.

Core GA
az sql elastic-pool show

Gets an elastic pool.

Core GA
az sql elastic-pool update

Update an elastic pool.

Core GA
az sql failover-group

Manage SQL Failover Groups.

Core GA
az sql failover-group create

Creates a failover group.

Core GA
az sql failover-group delete

Deletes a failover group.

Core GA
az sql failover-group list

Lists the failover groups in a server.

Core GA
az sql failover-group set-primary

Set the primary of the failover group by failing over all databases from the current primary server.

Core GA
az sql failover-group show

Gets a failover group.

Core GA
az sql failover-group update

Updates the failover group.

Core GA
az sql instance-failover-group

Manage SQL Instance Failover Groups.

Core GA
az sql instance-failover-group-arc

Manage Arc-enabled SQL managed instance Failover Groups.

Extension GA
az sql instance-failover-group-arc create

Create a failover group resource.

Extension GA
az sql instance-failover-group-arc delete

Delete an Arc-enabled SQL Managed Instance failover group.

Extension GA
az sql instance-failover-group-arc list

List all failover groups.

Extension GA
az sql instance-failover-group-arc show

Show the details of a failover group resource.

Extension GA
az sql instance-failover-group-arc update

Update a failover group resource.

Extension GA
az sql instance-failover-group create

Creates an instance failover group between two connected managed instances.

Core GA
az sql instance-failover-group delete

Deletes a failover group.

Core GA
az sql instance-failover-group set-primary

Set the primary of the instance failover group by failing over all databases from the current primary managed instance.

Core GA
az sql instance-failover-group show

Gets a failover group.

Core GA
az sql instance-failover-group update

Updates the instance failover group.

Core GA
az sql instance-pool

Manage instance pools.

Core Preview
az sql instance-pool create

Create an instance pool.

Core Preview
az sql instance-pool delete

Delete an instance pool.

Core Preview
az sql instance-pool list

List available instance pools.

Core Preview
az sql instance-pool show

Get the details for an instance pool.

Core Preview
az sql instance-pool update

Update an instance pool.

Core Preview
az sql instance-pool wait

Wait for an instance pool to reach a desired state.

Core Preview
az sql list-usages

Gets all subscription usage metrics in a given location.

Core GA
az sql mi

Manage SQL managed instances.

Core GA
az sql mi-arc

Manage Azure Arc-enabled SQL managed instances.

Extension GA
az sql mi-arc config

Configuration commands.

Extension GA
az sql mi-arc config add

Add a value for a json path in a config file.

Extension GA
az sql mi-arc config init

Initialize the CRD and specification files for a SQL managed instance.

Extension GA
az sql mi-arc config patch

Patch a config file based on a json patch file.

Extension GA
az sql mi-arc config remove

Remove a value for a json path in a config file.

Extension GA
az sql mi-arc config replace

Replace a value for a json path in a config file.

Extension GA
az sql mi-arc create

Create a SQL managed instance.

Extension GA
az sql mi-arc delete

Delete a SQL managed instance.

Extension GA
az sql mi-arc edit

Deprecated, use update over edit.

Extension Deprecated
az sql mi-arc endpoint

View and manage SQL endpoints.

Extension GA
az sql mi-arc endpoint list

List the SQL endpoints.

Extension GA
az sql mi-arc get-mirroring-cert

Retrieve certificate of availability group mirroring endpoint from sql mi and store in a file.

Extension GA
az sql mi-arc list

List SQL managed instances.

Extension GA
az sql mi-arc reprovision-replica

Reprovision a replica in a SQL managed instance.

Extension GA
az sql mi-arc show

Show the details of a SQL managed instance.

Extension GA
az sql mi-arc update

Update the configuration of a SQL managed instance.

Extension GA
az sql mi-arc upgrade

Upgrade SQL managed instance.

Extension GA
az sql mi ad-admin

Manage a managed instance's Active Directory administrator.

Core GA
az sql mi ad-admin create

Creates a new managed instance Active Directory administrator.

Core GA
az sql mi ad-admin delete

Deletes an existing managed instance Active Directory Administrator.

Core GA
az sql mi ad-admin list

Returns a list of managed instance Active Directory Administrators.

Core GA
az sql mi ad-admin update

Updates an existing managed instance Active Directory administrator.

Core GA
az sql mi ad-only-auth

Manage a Managed Instance's Azure Active Directory only settings.

Core GA
az sql mi ad-only-auth disable

Disable Azure Active Directory only Authentication for this Managed Instance.

Core GA
az sql mi ad-only-auth enable

Enable Azure Active Directory only Authentication for this Managed Instance.

Core GA
az sql mi ad-only-auth get

Get a specific Azure Active Directory only Authentication property.

Core GA
az sql mi advanced-threat-protection-setting

Manage a SQL Managed Instance's advanced threat protection setting.

Core GA
az sql mi advanced-threat-protection-setting show

Gets an advanced threat protection setting.

Core GA
az sql mi advanced-threat-protection-setting update

Update a SQL Managed Instance's advanced threat protection setting.

Core GA
az sql mi create

Create a managed instance.

Core GA
az sql mi delete

Delete a managed instance.

Core GA
az sql mi dtc

Commands related to managed instance DTC management.

Core GA
az sql mi dtc show

Get managed instance DTC settings.

Core GA
az sql mi dtc update

Update managed instance DTC settings.

Core GA
az sql mi dtc wait

Place the CLI in a waiting state until a condition is met.

Core GA
az sql mi endpoint-cert

Endpoint certificates management commands.

Core GA
az sql mi endpoint-cert list

List certificates used on endpoints on the target instance.

Core GA
az sql mi endpoint-cert show

Get a certificate used on the endpoint with the given id.

Core GA
az sql mi failover

Failover a managed instance.

Core GA
az sql mi key

Manage a SQL Instance's keys.

Core GA
az sql mi key create

Creates a SQL Instance key.

Core GA
az sql mi key delete

Deletes a SQL Instance key.

Core GA
az sql mi key list

Gets a list of managed instance keys.

Core GA
az sql mi key show

Shows a SQL Instance key.

Core GA
az sql mi link

Instance link management commands.

Core GA
az sql mi link create

Creates a new instance link.

Core GA
az sql mi link delete

Removes an instance link.

Core GA
az sql mi link list

Returns information about link feature for Azure SQL Managed Instance.

Core GA
az sql mi link show

Returns information about link feature for Azure SQL Managed Instance.

Core GA
az sql mi link update

Updates the properties of an instance link.

Core GA
az sql mi list

List available managed instances.

Core GA
az sql mi op

Manage operations on a managed instance.

Core GA
az sql mi op cancel

Cancels the asynchronous operation on the managed instance.

Core GA
az sql mi op list

Gets a list of operations performed on the managed instance.

Core GA
az sql mi op show

Gets a management operation on a managed instance.

Core GA
az sql mi partner-cert

Server trust certificate management commands.

Core GA
az sql mi partner-cert create

Upload a server trust certificate from box to Sql Managed Instance.

Core GA
az sql mi partner-cert delete

Delete a server trust certificate that was uploaded from box to Sql Managed Instance.

Core GA
az sql mi partner-cert list

Get a list of server trust certificates that were uploaded from box to the given Sql Managed Instance.

Core GA
az sql mi partner-cert show

Get a server trust certificate that was uploaded from box to Sql Managed Instance.

Core GA
az sql mi refresh-external-governance-status

Refresh external governance enablement status.

Core GA
az sql mi server-configuration-option

Server configuration option management commands.

Core GA
az sql mi server-configuration-option list

List a list of managed instance server configuration options.

Core GA
az sql mi server-configuration-option set

Set managed instance server configuration option.

Core GA
az sql mi server-configuration-option show

Get managed instance server configuration option.

Core GA
az sql mi server-configuration-option wait

Place the CLI in a waiting state until a condition is met.

Core GA
az sql mi show

Get the details for a managed instance.

Core GA
az sql mi start

Start the managed instance.

Core GA
az sql mi start-stop-schedule

Manage the managed instance's start stop schedule.

Core GA
az sql mi start-stop-schedule create

Create the managed instance's Start/Stop schedule.

Core GA
az sql mi start-stop-schedule delete

Delete the managed instance's Start/Stop schedule.

Core GA
az sql mi start-stop-schedule list

List the managed instance's Start/Stop schedules.

Core GA
az sql mi start-stop-schedule show

Get the managed instance's Start/Stop schedule.

Core GA
az sql mi start-stop-schedule update

Update the managed instance's Start/Stop schedule.

Core GA
az sql mi stop

Stop the managed instance.

Core GA
az sql mi tde-key

Manage a SQL Instance's encryption protector.

Core GA
az sql mi tde-key set

Sets the SQL Instance's encryption protector.

Core GA
az sql mi tde-key show

Shows a server encryption protector.

Core GA
az sql mi update

Update a managed instance.

Core GA
az sql midb

Manage SQL Managed Instance databases.

Core GA
az sql midb-arc

Manage databases for Azure Arc-enabled SQL managed instances.

Extension GA
az sql midb-arc restore

Restore a database to an Azure Arc enabled SQL managed instance.

Extension GA
az sql midb advanced-threat-protection-setting

Manage a SQL Managed Instance database's advanced threat protection setting.

Core GA
az sql midb advanced-threat-protection-setting show

Gets an advanced threat protection setting.

Core GA
az sql midb advanced-threat-protection-setting update

Update a SQL Managed Instance database's advanced threat protection setting.

Core GA
az sql midb copy

Start, complete, cancel and list managed database copy operations.

Core GA
az sql midb copy cancel

Cancel managed database copy operation.

Core GA
az sql midb copy complete

Complete managed database copy operation.

Core GA
az sql midb copy list

List managed database copy operations.

Core GA
az sql midb copy start

Start managed database copy operation.

Core GA
az sql midb create

Create a managed database.

Core GA
az sql midb delete

Delete a managed database.

Core GA
az sql midb ledger-digest-uploads

Manage ledger digest upload settings.

Core GA
az sql midb ledger-digest-uploads disable

Disable uploading ledger digests.

Core GA
az sql midb ledger-digest-uploads enable

Enable uploading ledger digests to an Azure Storage account or to Azure Confidential Ledger. If uploading ledger digests is already enabled, the cmdlet resets the digest storage endpoint to a new value.

Core GA
az sql midb ledger-digest-uploads show

Show the current ledger digest settings.

Core GA
az sql midb list

List managed databases on a managed instance.

Core GA
az sql midb list-deleted

List restorable deleted managed databases.

Core GA
az sql midb log-replay

SQL Managed Instance database Log Replay service commands.

Core GA
az sql midb log-replay complete

Complete Log Replay service on specified database.

Core GA
az sql midb log-replay show

Get status of Log Replay service.

Core GA
az sql midb log-replay start

Start Log Replay service on specified database.

Core GA
az sql midb log-replay stop

Stop Log Replay service.

Core GA
az sql midb log-replay wait

Place the CLI in a waiting state until a condition of the managed database is met.

Core GA
az sql midb ltr-backup

Manage SQL Managed Instance database long term retention backups.

Core GA
az sql midb ltr-backup delete

Delete a long term retention backup.

Core Preview
az sql midb ltr-backup list

List the long term retention backups for a location, instance or database.

Core Preview
az sql midb ltr-backup restore

Restore a long term retention backup to a new database.

Core Preview
az sql midb ltr-backup show

Get a long term retention backup for a managed database.

Core Preview
az sql midb ltr-backup wait

Place the CLI in a waiting state until a condition of the managed database is met.

Core GA
az sql midb ltr-policy

Manage SQL Managed Instance database long term retention policy.

Core GA
az sql midb ltr-policy set

Update long term retention settings for a managed database.

Core Preview
az sql midb ltr-policy show

Show the long term retention policy for a managed database.

Core Preview
az sql midb move

Start, complete, cancel and list managed database move operations.

Core GA
az sql midb move cancel

Cancel managed database move operation.

Core GA
az sql midb move complete

Complete managed database move operation.

Core GA
az sql midb move list

List managed database move operations.

Core GA
az sql midb move start

Start managed database move operation.

Core GA
az sql midb recover

Recover a managed database using geo-pair instance backup.

Core GA
az sql midb restore

Restore a managed database.

Core GA
az sql midb short-term-retention-policy

Manage SQL Managed Instance database backup short term retention policy.

Core GA
az sql midb short-term-retention-policy set

Update short term retention for automated backups on a single database.

Core Preview
az sql midb short-term-retention-policy show

Show short term retention for automated backups on a single database.

Core Preview
az sql midb show

Get the details for a managed database.

Core GA
az sql midb update

Update a managed database.

Core GA
az sql recoverable-midb

Recoverable managed databases command group.

Core GA
az sql recoverable-midb list

Get all recoverable managed databases for given instance name.

Core GA
az sql recoverable-midb show

Get recoverable managed database.

Core GA
az sql server

Manage SQL servers.

Core GA
az sql server-arc

Manage SQL Server enabled by Azure Arc.

Extension GA
az sql server-arc availability-group

Manage availability groups.

Extension Preview
az sql server-arc availability-group create

Create an availability group.

Extension Preview
az sql server-arc availability-group failover

Request manual failover of an availability group.

Extension Preview
az sql server-arc backups-policy

Manage backups policy.

Extension Preview
az sql server-arc backups-policy delete

Delete your current backups policy.

Extension Preview
az sql server-arc backups-policy set

Set your backups policy.

Extension Preview
az sql server-arc backups-policy show

See your current backups policy.

Extension Preview
az sql server-arc extension

Manage extension level properties.

Extension Preview
az sql server-arc extension feature-flag

Manage extension level feature flags.

Extension Preview
az sql server-arc extension feature-flag delete

Delete feature flag.

Extension Preview
az sql server-arc extension feature-flag set

Set feature flag.

Extension Preview
az sql server-arc extension feature-flag show

Show feature flag.

Extension Preview
az sql server-arc extension set

Update common host properties.

Extension Preview
az sql server-arc extension show

Show host properties.

Extension Preview
az sql server ad-admin

Manage a server's Active Directory administrator.

Core GA
az sql server ad-admin create

Create a new server Active Directory administrator.

Core GA
az sql server ad-admin delete

Sets a server's AD admin.

Core GA
az sql server ad-admin list

Gets a list of Azure Active Directory administrators in a server.

Core GA
az sql server ad-admin update

Update an existing server Active Directory administrator.

Core GA
az sql server ad-only-auth

Manage Azure Active Directory only Authentication settings for this Server.

Core GA
az sql server ad-only-auth disable

Disable Azure Active Directory only Authentication for this Server.

Core GA
az sql server ad-only-auth enable

Enable Azure Active Directory only Authentication for this Server.

Core GA
az sql server ad-only-auth get

Get a specific Azure Active Directory only Authentication property.

Core GA
az sql server advanced-threat-protection-setting

Manage a server's advanced threat protection setting.

Core GA
az sql server advanced-threat-protection-setting show

Gets an advanced threat protection setting.

Core GA
az sql server advanced-threat-protection-setting update

Update a server's advanced threat protection setting.

Core GA
az sql server audit-policy

Manage a server's auditing policy.

Core GA
az sql server audit-policy show

Show server audit policy.

Core GA
az sql server audit-policy update

Update a server's auditing policy.

Core GA
az sql server audit-policy wait

Place the CLI in a waiting state until a condition of the server's audit policy is met.

Core GA
az sql server conn-policy

Manage a server's connection policy.

Core GA
az sql server conn-policy show

Gets a server's secure connection policy.

Core GA
az sql server conn-policy update

Updates a server's secure connection policy.

Core GA
az sql server create

Create a server.

Core GA
az sql server delete

Deletes a server.

Core GA
az sql server dns-alias

Manage a server's DNS aliases.

Core GA
az sql server dns-alias create

Creates a server DNS alias.

Core GA
az sql server dns-alias delete

Deletes the server DNS alias with the given name.

Core GA
az sql server dns-alias list

Gets a list of server DNS aliases for a server.

Core GA
az sql server dns-alias set

Sets a server to which DNS alias should point.

Core GA
az sql server dns-alias show

Gets a server DNS alias.

Core GA
az sql server firewall-rule

Manage a server's firewall rules.

Core GA
az sql server firewall-rule create

Create a firewall rule.

Core GA
az sql server firewall-rule delete

Deletes a firewall rule.

Core GA
az sql server firewall-rule list

List a server's firewall rules.

Core GA
az sql server firewall-rule show

Shows the details for a firewall rule.

Core GA
az sql server firewall-rule update

Update a firewall rule.

Core GA
az sql server ipv6-firewall-rule

Manage a server's ipv6 firewall rules.

Core GA
az sql server ipv6-firewall-rule create

Create an ipv6 firewall rule.

Core GA
az sql server ipv6-firewall-rule delete

Deletes an IPv6 firewall rule.

Core GA
az sql server ipv6-firewall-rule list

List a server's ipv6 firewall rules.

Core GA
az sql server ipv6-firewall-rule show

Shows the details for an ipv6 firewall rule.

Core GA
az sql server ipv6-firewall-rule update

Update an ipv6 firewall rule.

Core GA
az sql server key

Manage a server's keys.

Core GA
az sql server key create

Creates a server key.

Core GA
az sql server key delete

Deletes a server key.

Core GA
az sql server key list

Gets a list of server keys.

Core GA
az sql server key show

Shows a server key.

Core GA
az sql server list

List available servers.

Core GA
az sql server list-usages

Returns server usages.

Core GA
az sql server ms-support

Manage a server's Microsoft support operations.

Core GA
az sql server ms-support audit-policy

Manage a server's Microsoft support operations auditing policy.

Core GA
az sql server ms-support audit-policy show

Show server Microsoft support operations audit policy.

Core GA
az sql server ms-support audit-policy update

Update a server's Microsoft support operations auditing policy.

Core GA
az sql server ms-support audit-policy wait

Place the CLI in a waiting state until a condition of the server's Microsoft support operations audit policy is met.

Core GA
az sql server outbound-firewall-rule

Manage a server's outbound firewall rules.

Core GA
az sql server outbound-firewall-rule create

Create a new outbound firewall rule.

Core GA
az sql server outbound-firewall-rule delete

Delete the outbound firewall rule.

Core GA
az sql server outbound-firewall-rule list

List a server's outbound firewall rules.

Core GA
az sql server outbound-firewall-rule show

Show the details for an outbound firewall rule.

Core GA
az sql server refresh-external-governance-status

Refreshes external governance status.

Core GA
az sql server show

Gets a server.

Core GA
az sql server tde-key

Manage a server's encryption protector.

Core GA
az sql server tde-key revalidate

Revalidate a server encryption protector.

Core GA
az sql server tde-key set

Sets the server's encryption protector. Ensure to create the key first https://docs.microsoft.com/en-us/cli/azure/sql/server/key?view=azure-cli-latest#az-sql-server-key-create.

Core GA
az sql server tde-key show

Gets a server encryption protector.

Core GA
az sql server update

Update a server.

Core GA
az sql server vnet-rule

Manage a server's virtual network rules.

Core GA
az sql server vnet-rule create

Create a virtual network rule to allows access to an Azure SQL Server.

Core GA
az sql server vnet-rule delete

Deletes the virtual network rule with the given name.

Core GA
az sql server vnet-rule list

Gets a list of virtual network rules in a server.

Core GA
az sql server vnet-rule show

Gets a virtual network rule.

Core GA
az sql server vnet-rule update

Update a virtual network rule.

Core GA
az sql server wait

Place the CLI in a waiting state until a condition of the SQL server is met.

Core GA
az sql show-usage

Gets a subscription usage metric.

Core GA
az sql stg

Manage Server Trust Groups.

Core Preview
az sql stg create

Create a Server Trust Group.

Core Preview
az sql stg delete

Delete a Server Trust Group.

Core Preview
az sql stg list

Retrieve a list of Server Trust Groups.

Core Preview
az sql stg show

Retrieve a Server Trust Group.

Core Preview
az sql up

Set up an Azure Database for SQL server and configurations.

Extension Deprecated
az sql virtual-cluster

Manage SQL virtual clusters.

Core GA
az sql virtual-cluster delete

Delete a virtual cluster.

Core GA
az sql virtual-cluster list

List available virtual clusters.

Core GA
az sql virtual-cluster show

Get the details for a virtual cluster.

Core GA
az sql vm

Manage SQL virtual machines.

Core GA
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 down

Deprecated

'db-up' extension will be retired on November 20, 2024, please consider using the create command associated with the respective database

Delete the SQL server and its cached information.

az sql down [--delete-group]
            [--no-wait]
            [--resource-group]
            [--server-name]
            [--yes]

Examples

Delete the server and the cached data, aside from the resource group.

az sql down

Delete the resource group and the full cache.

az sql down --delete-group

Optional Parameters

--delete-group

Delete the resource group.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sql list-usages

Gets all subscription usage metrics in a given location.

az sql list-usages --location

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sql show-usage

Gets a subscription usage metric.

az sql show-usage --location
                  --usage

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--usage -u

Name of usage metric to return. Required.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az sql up

Deprecated

'db-up' extension will be retired on November 20, 2024, please consider using the create command associated with the respective database

Set up an Azure Database for SQL server and configurations.

az sql up [--admin-password]
          [--admin-user]
          [--database-name]
          [--generate-password]
          [--location]
          [--resource-group]
          [--server-name]
          [--tags]
          [--version]

Examples

Ensure that an Azure Database for SQL server is up and running and configured for immediate use.

az sql up

To override default names, provide parameters indicating desired values/existing resources.

az sql up -g MyResourceGroup -s MyServer -d MyDatabase -u MyUsername -p MyPassword

Optional Parameters

--admin-password -p

The login password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.Your password cannot contain all or part of the login name. Part of a login name is defined as three or more consecutive alphanumeric characters.

--admin-user -u

The login username of the administrator.

--database-name -d

The name of a database to initialize.

--generate-password

Generate a password.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--version

Server version.

Default value: 12.0
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.