Quickstart: Create a service connection in Azure Spring Apps with the Azure CLI

This quickstart shows you how to connect Azure Spring Apps to other Cloud resources using the Azure CLI and Service Connector.

Service Connector lets you quickly connect compute services to cloud services, while managing your connection's authentication and networking settings.

Prerequisites

  • Version 2.37.0 or higher of the Azure CLI must be installed. To upgrade to the latest version, run az upgrade. If using Azure Cloud Shell, the latest version is already installed.

  • The Azure Spring Apps extension must be installed in the Azure CLI or the Cloud Shell. To install it, run az extension add --name spring.

Prepare to create a connection

  1. If you're using Service Connector for the first time, start by running the command az provider register to register the Service Connector resource provider.

    az provider register -n Microsoft.ServiceLinker
    
  2. Run the command az spring connection to get a list of supported target services for Azure Spring Apps.

    az spring connection list-support-types --output table
    

    Tip

    If the az spring command isn't recognized by the system, check that you have installed the required extension by running az extension add --name spring.

Create a service connection

You can create a connection from Azure Spring Apps using an access key or a managed identity.

  1. Run the az spring connection create command to create a service connection between Azure Spring Apps and an Azure Blob Storage with an access key.

    az spring connection create storage-blob --secret
    
  2. Provide the following information at the CLI or Cloud Shell's request:

    Setting Description
    The resource group which contains the spring-cloud The name of the resource group that contains app hosted by Azure Spring Apps.
    Name of the spring-cloud service The name of the Azure Spring Apps resource.
    Name of the spring-cloud app The name of the application hosted by Azure Spring Apps that connects to the target service.
    The resource group which contains the storage account The name of the resource group with the storage account.
    Name of the storage account The name of the storage account you want to connect to. In this guide, we're using a Blob Storage.

Tip

If you don't have a Blob Storage, you can run az spring connection create storage-blob --new --secret to provision a new Blob Storage and directly connect it to your application hosted by Azure Spring Apps using a connection string.

View connections

Run az spring connection list command to list all of your Azure Spring Apps' provisioned connections.

Replace the placeholders <azure-spring-apps-resource-group>, <azure-spring-apps-name>, and <app-name> from the command below with the name of your Azure Spring Apps resource group, the name of your Azure Spring Apps resource, and the name of your application. You can also remove the --output table option to view more information about your connections.

az spring connection list --resource-group <azure-spring-apps-resource-group> --service <azure-spring-apps-name> --app <app-name>--output table

The output also displays the provisioning state of your connections: failed or succeeded.

Next steps

Check the guides below for more information about Service Connector and Azure Spring Apps: