Migration Guide

azure_sdk_upgrade_guide.md

Migration Guide

Assumption

• Project is Maven.
• Java code is on JDK 8 or above.

Migrate pom.xml

It is recommended to use azure-sdk-bom (version higher than 1.3.0).

Example of pom.xml

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.azure</groupId>
                <artifactId>azure-sdk-bom</artifactId>
                <version>1.3.3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-identity</artifactId>
        </dependency>
        <dependency>
            <groupId>com.azure.resourcemanager</groupId>
            <artifactId>azure-resourcemanager</artifactId>
        </dependency>
    </dependencies>

Migrate Java Code

• Reference for update Java code
• Make a list of Java files that contains com.microsoft.azure package. Migrate each of them.
• Do not modify package name in file.
• Keep Azure resource and operation exactly same. The property on the Azure resource should not be changed, for "improvement" or "modernization". The focus here is to use the new libaray to create the exactly same Azure resource, apply the exactly same operation on it.
• If there is test in the project, Java code there also need to be updated.

Validation

Make sure the migrated project compile pass.