Tutorial: Deploy an application to Azure Spring Apps and connect it to Azure Database for MySQL Flexible Server using Service Connector

In this tutorial, you'll complete the following tasks using the Azure portal or the Azure CLI. Both methods are explained in the following procedures.

• Provision an instance of Azure Spring Apps
• Build and deploy apps to Azure Spring Apps
• Integrate Azure Spring Apps with Azure Database for MySQL with Service Connector

Warning

Microsoft recommends that you use the most secure authentication flow available. The authentication flow described in this procedure requires a very high degree of trust in the application, and carries risks that are not present in other flows. You should only use this flow when other more secure flows, such as managed identities, aren't viable.

Prerequisites

• Install JDK 8 or JDK 11
• Sign up for an Azure subscription
• Install the Azure CLI version 2.0.67 or higher and install the Azure Spring Apps extension with the command: az extension add --name spring

Provision an instance of Azure Spring Apps

The following procedure uses the Azure CLI extension to provision an instance of Azure Spring Apps.

1. Update Azure CLI with the Azure Spring Apps extension.

   az extension update --name spring
   

2. Sign in to the Azure CLI and choose your active subscription.

   az login
   az account list -o table
   az account set --subscription <Name or ID of subscription, skip if you only have 1 subscription>
   

3. Create a resource group to contain your app and an instance of the Azure Spring Apps service.

   az group create --name ServiceConnector-tutorial-mysqlf --location eastus
   

4. Create an instance of Azure Spring Apps. Its name must be between 4 and 32 characters long and can only contain lowercase letters, numbers, and hyphens. The first character of the Azure Spring Apps instance name must be a letter and the last character must be either a letter or a number.

   az spring create -n my-azure-spring -g ServiceConnector-tutorial-mysqlf
   

Create an Azure Database for MySQL Flexible Server

Create a MySQL Flexible Server instance. In the command below, replace <admin-username> and <admin-password> by credentials of your choice to create an administrator user for the MySQL flexible server. The admin username can't be azure_superuser, azure_pg_admin, admin, administrator, root, guest, or public. It can't start with pg_. The password must contain 8 to 128 characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters (for example, !, #, %). The password can't contain username.

az mysql flexible-server create \
    --resource-group ServiceConnector-tutorial-mysqlf \
    --name mysqlf-server \
    --database-name mysqlf-db \
    --admin-user <admin-username> \
    --admin-password <admin-password>

The server is created with the following default values unless you manually override them:

Setting	Default value	Description
server-name	System generated	A unique name that identifies your Azure Database for MySQL server.
sku-name	GP_Gen5_2	The name of the sku. Follows the convention {pricing tier}_{compute generation}_{vCores} in shorthand. The default is a General Purpose Gen5 server with 2 vCores. For more information about the pricing, go to our pricing page.
backup-retention	7	How long a backup should be retained. Unit is days.
geo-redundant-backup	Disabled	Whether geo-redundant backups should be enabled for this server or not.
location	westus2	The Azure location for the server.
ssl-enforcement	Enabled	Whether SSL should be enabled or not for this server.
storage-size	5120	The storage capacity of the server (unit is megabytes).
version	5.7	The MySQL major version.

Note

Standard_B1ms SKU is used by default. Refer to Azure Database for MySQL pricing for pricing details.

Note

For more information about the az mysql flexible-server create command and its additional parameters, see the Azure CLI documentation.

Build and deploy the app

1. Create the app with public endpoint assigned. If you selected Java version 11 when generating the Azure Spring Apps project, include the --runtime-version=Java_11 switch.

   az spring app create -n hellospring -s my-azure-spring -g ServiceConnector-tutorial-mysqlf --assign-endpoint true
   

2. Run the az spring connection create command to connect the application deployed to Azure Spring Apps to the MySQL Flexible Server database. Replace the placeholders below with your own information.

   az spring connection create mysql-flexible \
       --resource-group ServiceConnector-tutorial-mysqlf \
       --service my-azure-spring \
       --app hellospring \
       --target-resource-group ServiceConnector-tutorial-mysqlf \
       --server mysqlf-server \
       --database mysqlf-db \
       --secret name=<admin-username> secret=<admin-secret>
   

   Setting	Description
   --resource-group	The name of the resource group that contains the app hosted by Azure Spring Apps.
   --service	The name of the Azure Spring Apps resource.
   --app	The name of the application hosted by Azure Spring Apps that connects to the target service.
   --target-resource-group	The name of the resource group with the storage account.
   --server	The MySQL Flexible Server you want to connect to
   --database	The name of the database you created earlier.
   --secret name	The MySQL Flexible Server username.
   --secret	The MySQL Flexible Server password.

   Note

   If you see the error message "The subscription is not registered to use Microsoft.ServiceLinker", please run az provider register -n Microsoft.ServiceLinker to register the Service Connector resource provider and run the connection command again.

3. Clone sample code

   git clone https://github.com/Azure-Samples/serviceconnector-springcloud-mysql-springboot.git
   

4. Build the project using Maven.

   cd serviceconnector-springcloud-mysql-springboot
   mvn clean package -DskipTests 
   

5. Deploy the JAR file for the app target/demo-0.0.1-SNAPSHOT.jar.

   az spring app deploy \
       --name hellospring \
       --service my-azure-spring \
       --resource-group ServiceConnector-tutorial-mysqlf \
       --artifact-path target/demo-0.0.1-SNAPSHOT.jar
   

6. Query app status after deployment with the following command.

   az spring app list  --resource-group ServiceConnector-tutorial-mysqlf --service my-azure-spring --output table
   

   You should see the following output:

   Name         Location    ResourceGroup                     Public Url                                                 Production Deployment    Provisioning State    CPU    Memory    Running Instance    Registered Instance    Persistent Storage    Bind Service Registry    Bind Application Configuration Service
   -----------  ----------  --------------------------------  ---------------------------------------------------------  -----------------------  --------------------  -----  --------  ------------------  ---------------------  --------------------  -----------------------  ----------------------------------------
   hellospring  eastus      ServiceConnector-tutorial-mysqlf  https://my-azure-spring-hellospring.azuremicroservices.io  default                  Succeeded             1      1Gi       1/1                 0/1                    -                     -
   
   

Next steps

Follow the tutorials listed below to learn more about Service Connector.

Learn about Service Connector concepts