List and update configurations of an Azure Database for MySQL server using Azure CLI
[APPLIES TO:
Azure Database for MySQL - Single Server
Azure Database for MySQL - Flexible Server
This sample CLI script lists all available configuration parameters as well as their allowable values for Azure Database for MySQL server, and sets the innodb_lock_wait_timeout to a value that is other than the default one.
Prerequisites
Use the Bash environment in Azure Cloud Shell. For more information, see Azure Cloud Shell Quickstart - Bash.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you are running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For additional sign-in options, see Sign in with the Azure CLI.
When you're prompted, install Azure CLI extensions on first use. For more information about extensions, see Use extensions with the Azure CLI.
Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.
- This article requires version 2.0 or later of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.
Sample script
In this sample script, edit the highlighted lines to update the admin username and password to your own.
#!/bin/bash
# Create a resource group
az group create \
--name myresourcegroup \
--location westus
# Create a MySQL server in the resource group
# Name of a server maps to DNS name and is thus required to be globally unique in Azure.
# Substitute the <server_admin_password> with your own value.
az mysql server create \
--name mydemoserver \
--resource-group myresourcegroup \
--location westus \
--admin-user myadmin \
--admin-password <server_admin_password> \
--sku-name GP_Gen4_2 \
# Display all available configurations with valid values of an Azure Database for MySQL server
az mysql server configuration list \
--resource-group myresourcegroup \
--server-name mydemoserver
# Set value of *innodb_lock_wait_timeout*
az mysql server configuration set \
--resource-group myresourcegroup \
--server-name mydemoserver \
--name innodb_lock_wait_timeout \
--value 120
# Check the value of *innodb_lock_wait_timeout*
az mysql server configuration show \
--resource-group myresourcegroup \
--server-name mydemoserver \
--name innodb_lock_wait_timeout
Clean up deployment
Use the following command to remove the resource group and all resources associated with it after the script has been run.
#!/bin/bash
az group delete --name myresourcegroup
Script explanation
This script uses the commands outlined in the following table:
| Command | Notes |
|---|---|
| az group create | Creates a resource group in which all resources are stored. |
| az mysql server create | Creates a MySQL server that hosts the databases. |
| az mysql server configuration list | List the configurations of an Azure Database for MySQL server. |
| az mysql server configuration set | Update the configuration of an Azure Database for MySQL server. |
| az mysql server configuration show | Show the configuration of an Azure Database for MySQL server. |
| az group delete | Deletes a resource group including all nested resources. |
Next steps
- Read more information on the Azure CLI: Azure CLI documentation.
- Try additional scripts: Azure CLI samples for Azure Database for MySQL
- For more information on server parameters, see How To Configure Server Parameters in Azure Database for MySQL.
