Quickstart: Deploy your first application to Azure Spring Apps

• An Azure subscription. If you don't have an Azure subscription, create a trial account before you begin.

• An Azure subscription. If you don't have an Azure subscription, create a trial account before you begin.
• Git.
• Java Development Kit (JDK), version 17.

• An Azure subscription. If you don't have an Azure subscription, create a trial account before you begin.
• Git.
• Java Development Kit (JDK), version 17.
• Azure Developer CLI (AZD), version 1.2.0 or higher.

The Deploy to Azure button in the next section launches an Azure portal experience that downloads a JAR package from the spring-cloud-azure-tools releases page on GitHub. No local preparation steps are needed.

Use the following steps to prepare the project:

1. Use the following command to clone the Spring Boot sample project for Azure from GitHub.

   git clone https://github.com/spring-guides/gs-spring-boot-for-azure.git
   

2. Use the following command to move to the project folder:

   cd gs-spring-boot-for-azure/complete
   

3. Use the following Maven command to build the project:

   ./mvnw clean package
   

4. Run the sample project locally by using the following command:

   ./mvnw spring-boot:run
   

Use the following steps to initialize the application from the Azure Developer CLI templates.

1. Open a terminal, create an empty folder, and then change directory to it.

2. Use the following command to initialize the project:

   azd init --template spring-guides/gs-spring-boot-for-azure
   

   The following list describes the command interactions:

   • OAuth2 login: You need to authorize the sign in to Azure based on the OAuth2 protocol.
   • Please enter a new environment name: Provide an environment name, which is used as a suffix for the resource group 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)
   
   (✓) Done: Initialized git repository
   (✓) Done: Downloading template code to: <your-local-path>
   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 uses a Deploy to Azure button to launch a deployment experience in the Azure portal. This experience uses an ARM template to create Azure resources.

3.1. Sign in to the Azure portal

Go to the Azure portal and enter your credentials to sign in to the portal. The default view is your service dashboard.

3.2. Create Azure resources

Use the following steps to create all the Azure resources that the app depends on:

1. Select the following Deploy to Azure button to launch the deployment experience in the Azure portal:

   

2. Fill out the form on the Basics tab. Use the following table as a guide for completing the form:

   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 in 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.
   Region	The region closest to your users.	The region is used to create the resource group.

3. Select Review and Create to review your selections. Then, select Create to deploy the app to Azure Spring Apps.

4. On the toolbar, select the Notifications icon (a bell) to monitor the deployment process. After the deployment finishes, you can select Pin to dashboard, which creates a tile for this service on your Azure portal dashboard as a shortcut to the service's Overview page. Select Go to resource to open the service's Overview page.

   

3.1. Sign in to the Azure portal

Open your web browser and go to the Azure portal. Enter your credentials to sign in to the portal. The default view is your service dashboard.

3.2. Create an Azure Spring Apps instance

Use the following steps to create a service instance:

1. Select Create a resource in the corner of the Azure portal.

2. Select Compute > Azure Spring Apps.

3. Fill out the Basics form with the following information:

   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 in 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 service. 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 that determines the resource and cost associated with your instance.
   Region	The region closest to your users	The location that is closest to your users.
   Zone Redundant	Unselected	Indicates whether to create your Azure Spring Apps service in an Azure availability zone. This feature isn't currently supported in all regions.

4. Select Review and Create to review your selections. Select Create to provision the Azure Spring Apps instance.

5. On the toolbar, select the Notifications icon (a bell) to monitor the deployment process. After the deployment is done, you can select Pin to dashboard, which creates a tile for this service on your Azure portal dashboard as a shortcut to the service's Overview page.

   

6. Select Go to resource to go to the Azure Spring Apps Overview page.

Use the following steps to create the required resources:

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

2. Use the following command to set the template using the Standard plan:

   azd env set PLAN standard
   

3. 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 ones in 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>-<random-string>> in Azure Portal:
   https://portal.azure.cn/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

   Note

   This may take a while to complete. You see a progress indicator as it provisions Azure resources.

The Deploy to Azure button in the previous section launches an Azure portal experience that includes application deployment, so nothing else is needed.

Use the following steps to deploy using the Maven plugin for Azure Spring Apps:

1. Navigate to the complete directory, and then run the following command to configure the app in Azure Spring Apps:

   ./mvnw com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config
   

   The following list describes the command interactions:

   • OAuth2 login: You need to 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.
   • Use existing Azure Spring Apps in Azure: Press y to use the existing Azure Spring Apps instance.
   • 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.
   • Use existing app in Azure Spring Apps <your-instance-name>: Press n to create a new app.
   • Input the app name (demo): Provide an app name. If you use the default project artifact ID, press Enter directly.
   • Expose public access for this app (boot-for-azure): Press y.
   • Confirm to save all the above configurations: Press y. If you press n, the configuration isn't saved in the POM files.

2. Use the following command to deploy the app:

   ./mvnw azure-spring-apps:deploy
   

   The following list describes the command interaction:

   • OAuth2 login: You need to authorize the sign in to Azure based on the OAuth2 protocol.

   After the command is executed, you can see from the following log messages that the deployment was successful:

   [INFO] Deployment(default) is successfully created
   [INFO] Starting Spring App after deploying artifacts...
   [INFO] Deployment Status: Running
   [INFO]   InstanceName:demo-default-x-xxxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:UNREGISTERED
   [INFO]   InstanceName:demo-default-x-xxxxxxxxx-xxxxx  Status:Terminating Reason:null       DiscoverStatus:UNREGISTERED
   [INFO] Getting public url of app(demo)...
   [INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-demo.microservices.azure.cn
   

Use the following steps to package the app, provision the Azure resources required by the web application, and then deploy to Azure Spring Apps:

1. 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 seconds.
   

2. Use the following command to deploy the application code to those newly provisioned resources:

   azd deploy
   

   The console outputs messages similar to the ones in the following example:

   Deploying services (azd deploy)
   
   (✓) Done: Deploying service demo
   - Endpoint: https://<your-Azure-Spring-Apps-instance-name>-demo.microservices.azure.cn/
   
   
   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.cn/#@/resource/subscriptions/<your-subscription-id>/resourceGroups/rg-<your-environment-name>/overview
   

After the deployment finishes, use the following steps to find the application URL from the deployment outputs:

1. Access the application URL from the Outputs page of the Deployment. When you open the app, you get the response Hello World.

   

2. Check the details for each resource deployment, which are useful for investigating any deployment issues.

After the deployment finishes, use the following steps to check the app's logs to investigate any deployment issue:

1. Access the application URL from the Outputs page of the Deployment. When you open the app, you get the response Hello World.

   

2. From the navigation pane of the Azure Spring Apps instance overview page, select Logs to check the app's logs.

   

After the deployment finishes, access the application with the output endpoint. When you open the app, you get the response Hello World.

Use the following steps to delete the entire resource group, including the newly created service instance:

1. Locate your resource group in the Azure portal. On the navigation menu, select Resource groups, and then select the name of your resource group.

2. On the Resource group page, select Delete. Enter the name of your resource group in the text box to confirm deletion, then select Delete.

Use the following steps to delete the entire resource group, including the newly created service instance:

1. Locate your resource group in the Azure portal. On the navigation menu, select Resource groups, and then select the name of your resource group.

2. On the Resource group page, select Delete. Enter the name of your resource group in the text box to confirm deletion, then select Delete.

Use the following command to delete all the Azure resources used in this sample application:

azd down

The following list describes the command interaction:

• Total resources to delete: <your-resources-total>, are you sure you want to continue?: Press y.

The console outputs messages similar to the following example:

SUCCESS: Your application was removed from Azure in xx minutes xx seconds.