Spring Cloud Azure offers a convenient way to interact with Azure provided services using well-known Spring idioms and APIs for Spring developers.

• Reference doc.
• Migration guide for 4.0.
• Spring Boot Support Status

To check out the project and build it from source, do the following:

git clone git@github.com:Azure/azure-sdk-for-java.git
cd azure-sdk-for-java
mvn clean package -f sdk/spring/pom.xml -P dev

You can use the following command to install jars into your local repository quickly:

mvn clean install \
  -Dcheckstyle.skip=true \
  -Dcodesnippet.skip \
  -Denforcer.skip \
  -Djacoco.skip=true \
  -Dmaven.javadoc.skip=true \
  -Drevapi.skip=true \
  -DskipTests \
  -Dspotbugs.skip=true \
  -Pdev \
  -T 4 \
  -ntp \
  -f sdk/spring/pom.xml

If you are using PowerShell, please use the following command instead:

mvn clean install `
 "-Dcheckstyle.skip" `
 "-Dcodesnippet.skip" `
 "-Denforcer.skip" `
 "-Djacoco.skip" `
 "-Dmaven.javadoc.skip" `
 "-Drevapi.skip" `
 "-DskipTests" `
 "-Dspotbugs.skip" `
 -Pdev `
 -T 4 `
 -ntp `
 -f sdk/spring/pom.xml

There are several modules in Spring Cloud Azure. Here is a quick review:

Auto-configuration attempts to deduce which beans a user might need. For example, if Cosmos DB is on the classpath, and the user has not configured any Cosmos DB clients, then they probably want an Cosmos DB client to be defined. Auto-configuration will always back away as the user starts to define their own beans.

This module contains the auto-configuration code for Azure services.

Spring Cloud Azure Starters are a set of convenient dependency descriptors to include in your application. It boosts your Spring Boot application developement with Azure services. For example, if you want to get started using Spring and Azure Cosmos DB for data persistence, include the spring-cloud-azure-starter-cosmos dependency in your project.

The following application starters are provided by Spring Cloud Azure under the com.azure.spring group:

In addition to the application starters, the following starters can be used to add production ready features:

Actuator endpoints let you monitor and interact with your application. Spring Boot Actuator provides the infrastructure required for actuator endpoints.

This module extends the Spring Boot Actuator module and provides the actuating support for Azure services.

This provides auto-configuration for actuator endpoints based on the content of the classpath and a set of properties.

Spring Integration Extension for Azure provides Spring Integration adapters for the various services provided by the Azure SDK for Java. Below is a list of supported adapters:

• spring-integration-azure-eventhbus
• spring-integration-azure-servicebus
• spring-integration-azure-storage-queue

Spring Cloud Stream is a framework for building highly scalable event-driven microservices connected with shared messaging systems.

The framework provides a flexible programming model built on already established and familiar Spring idioms and best practices, including support for persistent pub/sub semantics, consumer groups, and stateful partitions.

Current binder implementations include:

• spring-cloud-azure-stream-binder-eventhubs
• spring-cloud-azure-stream-binder-servicebus

If you’re a Maven user, add our BOM to your pom.xml <dependencyManagement> section. This will allow you to not specify versions for any of the Maven dependencies and instead delegate versioning to the BOM.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure.spring</groupId>
            <artifactId>spring-cloud-azure-dependencies</artifactId>
            <version>5.16.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

With Gradle, you can import the spring-cloud-azure-dependencies BOM in two ways.

You can use the Gradle’s native BOM support by adding dependencies:

import org.springframework.boot.gradle.plugin.SpringBootPlugin

plugins {
  id("java")
  id("org.springframework.boot") version "3.2.O"
}

dependencies {
    implementation(platform(SpringBootPlugin.BOM_COORDINATES))
    implementation(platform("com.azure.spring:spring-cloud-azure-dependencies:{version}"))
}

You can also use the io.spring.dependency-management plugin and import the BOM in dependencyManagement:

plugins {
    id("io.spring.dependency-management") version "1.1.0"
}

dependencyManagement {
    imports { 
        mavenBom("com.azure.spring:spring-cloud-azure-dependencies:{version}")
    }
}

The source code of Spring Cloud Azure for Spring Boot 3.x can be found on the feature/spring-boot-3 branch.

Azure SDK JARs are signed. Spring Boot 3 does not support today signed JARs when you run your application with AOT mode on a JVM or you build a native image.

You can disable the JAR signature verification in the following way for GraalVM Native Build Tools:

• Maven

<plugin>
    <groupId>org.graalvm.buildtools</groupId>
    <artifactId>native-maven-plugin</artifactId>
    <configuration>
        <buildArgs>
            <arg>-Djava.security.properties=src/main/resources/custom.security</arg>
        </buildArgs>
    </configuration>
</plugin>

• Gradle:

graalvmNative {
  binaries {
    main {
      buildArgs('-Djava.security.properties=' + file("$rootDir/custom.security").absolutePath)
    }
  }
}

You have to create a custom.security file in src/main/resources with the following content:

jdk.jar.disabledAlgorithms=MD2, MD5, RSA, DSA

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

Please follow instructions here to build from source or contribute.

If you encounter any bug, please file an issue here.

To suggest a new feature or changes that could be made, file an issue the same way you would for a bug.

You can participate community driven

Pull requests are welcome. To open your own pull request, click here. When creating a pull request, make sure you are pointing to the fork and branch that your changes were made in.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

This project collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more.