Edit

Share via

List and update configurations of an Azure Database for MySQL server using Azure CLI

  • Article

[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.

If you don't have an Azure subscription, create an Azure free account before you begin.

Prerequisites

Sample script

Launch Azure Cloud Shell

The Azure Cloud Shell is a free interactive shell that you can use to run the steps in this article. It has common Azure tools preinstalled and configured to use with your account.

To open the Cloud Shell, just select Try it from the upper right corner of a code block. You can also launch Cloud Shell in a separate browser tab by going to https://shell.azure.com.

When Cloud Shell opens, verify that Bash is selected for your environment. Subsequent sessions will use Azure CLI in a Bash environment, Select Copy to copy the blocks of code, paste it into the Cloud Shell, and press Enter to run it.

Sign in to Azure

Cloud Shell is automatically authenticated under the initial account signed-in with. Use the following script to sign in using a different subscription, replacing <Subscription ID> with your Azure Subscription ID. If you don't have an Azure subscription, create an Azure free account before you begin.

subscription="<subscriptionId>" # add subscription here

az account set -s $subscription # ...or use 'az login'

For more information, see set active subscription or log in interactively

Run the script

# List and update configurations of an Azure Database for MySQL server

# Variable block
let "randomIdentifier=$RANDOM*$RANDOM"
location="East US"
resourceGroup="msdocs-mysql-rg-$randomIdentifier"
tag="change-server-cofigurations-mysql"
server="msdocs-mysql-server-$randomIdentifier"
sku="GP_Gen5_2"
login="azureuser"
password="Pa$$w0rD-$randomIdentifier"

echo "Using resource group $resourceGroup with login: $login, password: $password..."

# Create a resource group
echo "Creating $resourceGroup in $location..."
az group create --name $resourceGroup --location "$location" --tags $tag

# 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.
echo "Creating $server in $location..."
az mysql server create --name $server --resource-group $resourceGroup --location "$location" --admin-user $login --admin-password $password --sku-name $sku

# Display all available configurations with valid values of an Azure Database for MySQL server
az mysql server configuration list --resource-group $resourceGroup --server-name $server

# Set value of *innodb_lock_wait_timeout*
echo "Setting value of the innodb_lock_wait_timeout setting on $server"
az mysql server configuration set --resource-group $resourceGroup --server-name $server --name innodb_lock_wait_timeout --value 120

# Check the value of *innodb_lock_wait_timeout*
echo "Checking the value of the innodb_lock_wait_timeout setting on $server"
az mysql server configuration show --resource-group $resourceGroup --server-name $server --name innodb_lock_wait_timeout

Clean up resources

Use the following command to remove the resource group and all resources associated with it using the az group delete command - unless you have an ongoing need for these resources. Some of these resources may take a while to create, as well as to delete.

az group delete --name $resourceGroup

Sample reference

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