Connect an Azure Database for MySQL instance to your application in Azure Spring Apps
Note
The Basic, Standard, and Enterprise plans entered a retirement period on March 17, 2025. For more information, see the Azure Spring Apps retirement announcement.
The Standard consumption and dedicated plan entered a retirement period on September 30, 2024, with a complete shutdown by the end of March 2025. For more information, see Migrate Azure Spring Apps Standard consumption and dedicated plan to Azure Container Apps.
This article applies to: ✅ Java ✅ C#
This article applies to: ✅ Basic/Standard ✅ Enterprise
With Azure Spring Apps, you can connect selected Azure services to your applications automatically, instead of having to configure your Spring Boot application manually. This article shows you how to connect your application to your Azure Database for MySQL instance.
Prerequisites
- An application deployed to Azure Spring Apps. For more information, see Quickstart: Deploy your first application to Azure Spring Apps.
- An Azure Database for MySQL Flexible Server instance.
- Azure CLI version 2.45.0 or higher.
Prepare your project
In your project's pom.xml file, add the following dependency:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> <dependency> <groupId>com.azure.spring</groupId> <artifactId>spring-cloud-azure-starter-jdbc-mysql</artifactId> </dependency>
In the application.properties file, remove any
spring.datasource.*
properties.Update the current app by running
az spring app deploy
, or create a new deployment for this change by runningaz spring app deployment create
.
Connect your app to the Azure Database for MySQL instance
Note
By default, Service Connectors are created at the application level. To override the connections, you can create other connections again in the deployments.
Follow these steps to configure your Spring app to connect to an Azure Database for MySQL Flexible Server with a system-assigned managed identity.
Use the following command to install the Service Connector passwordless extension for the Azure CLI.
az extension add --name serviceconnector-passwordless --upgrade
Then, use the following command to create a user-assigned managed identity for Microsoft Entra authentication. Be sure to replace the variables in the example with actual values. For more information, see Set up Microsoft Entra authentication for Azure Database for MySQL - Flexible Server.
export AZ_IDENTITY_RESOURCE_ID=$(az identity create \ --name $AZURE_USER_IDENTITY_NAME \ --resource-group $AZURE_IDENTITY_RESOURCE_GROUP \ --query id \ --output tsv)
Run the
az spring connection create
command, as shown in the following example. Be sure to replace the variables in the example with actual values.az spring connection create mysql-flexible \ --resource-group $AZURE_SPRING_APPS_RESOURCE_GROUP \ --service $AZURE_SPRING_APPS_SERVICE_INSTANCE_NAME \ --app $APP_NAME \ --target-resource-group $MYSQL_RESOURCE_GROUP \ --server $MYSQL_SERVER_NAME \ --database $DATABASE_NAME \ --system-identity mysql-identity-id=$AZ_IDENTITY_RESOURCE_ID
Next steps
In this article, you learned how to connect an application in Azure Spring Apps to an Azure Database for MySQL instance. To learn more about connecting services to an application, see Connect an Azure Cosmos DB database to an application in Azure Spring Apps.