| author | KarlErickson |
|---|---|
| ms.author | v-shilichen |
| ms.service | azure-spring-apps |
| ms.topic | include |
| ms.date | 08/19/2025 |
| ms.update-cycle | 1095-days |
[!INCLUDE prepare-spring-project]
Use the following steps to initialize the Pet Clinic application using Azure Developer CLI templates:
-
In the Bash window, create a new, empty folder and then navigate to it.
-
Use the following command to initialize the project:
azd init --template Azure-Samples/spring-petclinic-microservices
The following list describes the command interaction:
- Enter a new environment name: Provide an environment name, which is used as a suffix for the resource group that is created to hold all Azure resources. This name should be unique within your Azure subscription.
The console outputs messages similar to the following example:
Initializing a new project (azd init) Downloading template code to: <your-local-path> (✓) Done: Initialized git repository Enter a new environment name: <your-env-name> SUCCESS: New project initialized! You can view the template code in your directory: <your-local-path> Learn more about running 3rd party code on our DevHub: https://aka.ms/azd-third-party-code-notice
This section describes how to create an Azure Spring Apps service instance and prepare the Azure cloud environment.
Go to the Azure portal, enter your credentials, and sign in to the portal. The default view is your service dashboard.
Use the following steps to create the service instance:
-
Select Create a resource in the corner of the Azure portal.
-
On the Azure Services tab, select Compute > Azure Spring Apps.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/create-azure-spring-apps.png" alt-text="Screenshot of the Azure portal that shows the Create a Resource page with Azure Spring Apps highlighted." lightbox="../../media/quickstart-deploy-microservice-apps/create-azure-spring-apps.png":::
-
On the Create Azure Spring Apps page, fill out the form on the Basics tab.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/create-basics.png" alt-text="Screenshot of the Azure portal that shows the Create Azure Spring Apps page with the Basics tab selected." lightbox="../../media/quickstart-deploy-microservice-apps/create-basics.png":::
Use the following table as a guide for completing the form. The recommended Plan is Standard.
Setting Suggested value Description Subscription Your subscription name. The Azure subscription that you want to use for your server. If you have multiple subscriptions, choose the subscription for which you'd like to be billed for the resource. Resource group myresourcegroup A new resource group name or an existing one from your subscription. Name myasa A unique name that identifies your Azure Spring Apps instance. The name must be between 4 and 32 characters long and can contain only lowercase letters, numbers, and hyphens. The first character of the service name must be a letter and the last character must be either a letter or a number. Plan Standard The pricing plan determines the resources and cost associated with your instance. Region The region closest to your users. The location that is closest to your users. Zone Redundant Unselected Creates your Azure Spring Apps service in an Azure availability zone. Not currently supported in all regions. -
Navigate to the Diagnostic settings tab on the Create Azure Spring Apps page and then select Create new to create a new Log Analytics workspaces instance. On the Create new Log Analytics workspace page, update the name of the Log Analytics workspace as needed, and then select OK to confirm the creation.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/diagnostic-settings.png" alt-text="Screenshot of the Azure portal that shows the Create Azure Spring Apps page with the Diagnostics tab selected and the Create new button highlighted." lightbox="../../media/quickstart-deploy-microservice-apps/diagnostic-settings.png":::
-
Navigate to the Application Insights tab on the Create Azure Spring Apps page and then select Create new to create a new Application Insights instance. On the Create new Application Insights resource page, update the Application insights name as needed, select Workspace-based for Resource mode, and then select OK to confirm the creation.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/application-insights-creation.png" alt-text="Screenshot of the Azure portal that shows the Create Azure Spring Apps page with the Create new Application Insights resource pane showing." lightbox="../../media/quickstart-deploy-microservice-apps/application-insights-creation.png":::
-
Select Review and Create to review your selections. Then, select Create to provision the Azure Spring Apps instance.
-
Select the Notifications icon (a bell) to monitor the deployment process. After the deployment finishes, you can select Pin to dashboard to create a shortcut on your Azure portal dashboard to the service's Overview page.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/azure-spring-apps-notifications.png" alt-text="Screenshot of the Azure portal that shows a deployment of a resource and the Notification pane with Go to resource and Pin to dashboard buttons." lightbox="../../media/quickstart-deploy-microservice-apps/azure-spring-apps-notifications.png":::
-
Select Go to resource to go to the Azure Spring Apps Overview page.
-
Select Config Server in the navigation pane.
-
On the Config Server page, for URI, enter https://github.com/Azure-Samples/spring-petclinic-microservices-config.git and then select Validate.
:::image type="content" source="../../media/quickstart-deploy-microservice-apps/validate-config-server.png" alt-text="Screenshot of the Azure portal that shows the Config Server page with the Default URI and the Validate button highlighted." lightbox="../../media/quickstart-deploy-microservice-apps/validate-config-server.png":::
-
After validation, select Apply to finish the Config Server configuration.
Use the following steps to create the required resources:
-
Use the following command to sign in to Azure with OAuth2. Ignore this step if you already signed in.
azd auth login
The console outputs messages similar to the following example:
Logged in to Azure. -
Use the following command to package a deployable copy of your application, provision the template's infrastructure to Azure, and then deploy the application code to those newly provisioned resources:
azd provision
The following list describes the command interactions:
- Select an Azure Subscription to use: Use arrows to move, type to filter, then press Enter.
- Select an Azure location to use: Use arrows to move, type to filter, then press Enter.
The console outputs messages similar to the following example:
SUCCESS: Your application was provisioned in Azure in xx minutes xx seconds. You can view the resources created under the resource group rg-<your-environment-name> in Azure portal: https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview[!NOTE] This command may take a while to complete. You're shown a progress indicator as it provisions Azure resources.
You can now deploy the app to Azure Spring Apps.
Use the following steps to deploy the microservice applications using the Maven plugin for Azure Spring Apps:
-
Navigate to the sample project directory and then use the following command to configure the apps for Azure Spring Apps:
./mvnw -P spring-apps com.microsoft.azure:azure-spring-apps-maven-plugin:1.17.0:config
-
The following list describes the command interactions:
- Select child modules to configure(input numbers separated by comma, eg: [1-2,4,6], ENTER to select ALL): Press Enter to select all.
- OAuth2 login: Authorize the sign in to Azure based on the OAuth2 protocol.
- Select subscription: Select the subscription list number of the Azure Spring Apps instance you created, which defaults to the first subscription in the list. If you use the default number, press Enter directly.
- Select Azure Spring Apps for deployment: Select the list number of the Azure Spring Apps instance you created. If you use the default number, press Enter directly.
- Select apps to expose public access:(input numbers separated by comma, eg: [1-2,4,6], ENTER to select NONE): Enter 1,5 for
admin-serverandapi-gateway. - Confirm to save all the above configurations (Y/n): Press y. If you press n, the configuration isn't saved in the POM files.
-
Use the following command to build and deploy each application:
./mvnw azure-spring-apps:deploy
-
For the OAuth2 login prompt, authorize the login to Azure based on the OAuth2 protocol.
[!NOTE] Deployment to Azure Spring Apps can take up to 25 minutes.
After the command runs, a log displays output similar to the following example, which indicates that all deployments are successful:
[INFO] Deployment(default) is successfully updated.
[INFO] Deployment Status: Running
[INFO] InstanceName:admin-server-default-xx-xx-xxx Status:Running Reason:null DiscoverStatus:UP
[INFO] Getting public url of app(admin-server)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-admin-server.azuremicroservices.io
...
[INFO] Getting public url of app(api-gateway)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-api-gateway.azuremicroservices.io
Use the following steps to package the app, provision the Azure resources required by the web application, and then deploy to Azure Spring Apps:
-
Use the following command to package a deployable copy of your application:
azd package
The console outputs messages similar to the following example:
SUCCESS: Your application was packaged for Azure in xx minutes xx seconds. -
Use the following command to deploy the application code to those newly provisioned resources:
azd deploy
The console outputs messages similar to the following example:
Deploying services (azd deploy) (✓) Done: Deploying service admin-server - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-admin-server.azuremicroservices.io (✓) Done: Deploying service api-gateway - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-api-gateway.azuremicroservices.io (✓) Done: Deploying service customers-service - No endpoints were found (✓) Done: Deploying service vets-service - No endpoints were found (✓) Done: Deploying service visits-service - No endpoints were found SUCCESS: Your application was deployed to Azure in xx minutes xx seconds. You can view the resources created under the resource group rg-<your-environment-name> in Azure portal: https://portal.azure.com/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
Note
You can also use azd up to combine the previous three commands: azd package (packages a deployable copy of your application), azd provision (provisions Azure resources), and azd deploy (deploys application code). For more information, see Azure-Samples/spring-petclinic-microservices.