| title | description | keywords | author | ms.date | ms.topic | ms.service | ms.assetid | ms.custom |
|---|---|---|---|---|---|---|---|---|
Get started with the Azure SDK for Java |
Learn how to create Azure cloud resources and connect and use them in your Java applications. |
Azure, Java, SDK, API, authenticate, get-started |
rloutlaw |
04/16/2017 |
article |
multiple |
b1e10b79-f75e-4605-aecd-eed64873e2d3 |
seo-java-august2019 |
This guide walks you through setting up a development environment for Azure development in Java. You'll then create some Azure resources and connect them to to perform some basic tasks, like uploading a file or deploying a web application. When you're done, you'll be ready to start using Azure services in your own Java applications.
[!INCLUDE chrome-note]
- An Azure account. If you don't have one, get a free trial
- Azure Cloud Shell or Azure CLI 2.0.
- Java 8 (included in Azure Cloud Shell)
- Maven 3 (included in Azure Cloud Shell)
Your Java application needs read and create permissions in your Azure subscription to run the sample code in this tutorial. Create a service principal and configure your application to run with its credentials. Service principals provide a way to create a non-interactive account associated with your identity to which you grant only the privileges your app needs to run.
Create a service principal using the Azure CLI 2.0 and capture the output. Provide a secure password in the password argument instead of MY_SECURE_PASSWORD. Your password must be 8 to 16 characters and match at least 3 out of the 4 following criteria:
- Include lowercase characters
- Include uppercase characters
- Include numbers
- Include one of the following symbols: @ # $ % ^ & * - _ ! + = [ ] { } | \ : ‘ , . ? / ` ~ “ ( ) ;
az ad sp create-for-rbac --name AzureJavaTest --password "MY_SECURE_PASSWORD"
Which gives you a reply in the following format:
{
"appId": "a487e0c1-82af-47d9-9a0b-af184eb87646d",
"displayName": "AzureJavaTest",
"name": "http://AzureJavaTest",
"password": password,
"tenant": "tttttttt-tttt-tttt-tttt-tttttttttttt"
}Next, copy the following into a text file on your system:
# sample management library properties file
subscription=ssssssss-ssss-ssss-ssss-ssssssssssss
client=cccccccc-cccc-cccc-cccc-cccccccccccc
key=kkkkkkkkkkkkkkkk
tenant=tttttttt-tttt-tttt-tttt-tttttttttttt
managementURI=https\://management.core.windows.net/
baseURL=https\://management.azure.com/
authURL=https\://login.windows.net/
graphURL=https\://graph.windows.net/
Replace the top four values with the following:
- subscription: use the id value from
az account showin the Azure CLI 2.0. - client: use the appId value from the output taken from a service principal output.
- key: use the password value from the service principal output.
- tenant: use the tenant value from the service principal output.
Save this file in a secure location on your system where your code can read it. You may use this file for future code so it's recommended to store it somewhere external to the application in this article.
Set an environment variable AZURE_AUTH_LOCATION with the full path to the authentication file in your shell.
export AZURE_AUTH_LOCATION=/Users/raisa/azureauth.propertiesIf you're working in a windows environment, add the variable to your system properties. Open a PowerShell window with administrator privledges and, after replacing the second variable with the path to your file, enter the following command:
setx AZURE_AUTH_LOCATION "C:\<fullpath>\azureauth.properties" /mNote
This guide uses Maven build tool to build and run the sample code, but other build tools such as Gradle also work with the Azure libraries for Java.
Create a Maven project from the command line in a new directory on your system:
mkdir java-azure-test
cd java-azure-test
mvn archetype:generate -DgroupId=com.fabrikam -DartifactId=AzureApp \
-DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=falseThis creates a basic Maven project under the testAzureApp folder. Add the following entries into the project pom.xml to import the libraries used in the sample code in this tutorial.
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-storage</artifactId>
<version>5.0.0</version>
</dependency>
<dependency>
<groupId>com.microsoft.sqlserver</groupId>
<artifactId>mssql-jdbc</artifactId>
<version>6.2.1.jre8</version>
</dependency>Add a build entry under the top-level project element to use the maven-exec-plugin to run the samples:
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<configuration>
<mainClass>com.fabrikam.AzureApp</mainClass>
</configuration>
</plugin>
</plugins>
</build>The Azure toolkit is necessary if you're going to be deploying web apps or APIs programmatically but is not currently used for any other kinds of development. The following is a summary of the installation process. For a quickstart, visit Azure Toolkit for IntelliJ quickstart.
-
Select the File menu and then select Settings....
-
Select Browse repositories... and then search "Azure" and install the Azure toolkit for Intellij.
-
Restart Intellij.
The Azure toolkit is necessary if you're going to be deploying web apps or APIs programmatically but is not currently used for any other kinds of development. The following is a summary of the installation process. For a quickstart, visit Azure Toolkit for Eclipse quickstart.
-
Select the Help menu and then select Install New software.
-
In the Work with: field enter
http://dl.microsoft.com/eclipseand press enter. -
Then, select the checkbox next to Azure toolkit for Java and uncheck the checkbox for Contact all update sites during install to find required software. Then select next.
Create a new file named AzureApp.java in the project's src/main/java/com/fabirkam directory and paste in the following block of code. Update the userName and sshKey variables with real values for your machine. The code creates a new Linux VM with name testLinuxVM in a resource group sampleResourceGroup running in the US East Azure region.
package com.fabrikam;
import com.microsoft.azure.management.Azure;
import com.microsoft.azure.management.compute.VirtualMachine;
import com.microsoft.azure.management.compute.KnownLinuxVirtualMachineImage;
import com.microsoft.azure.management.compute.VirtualMachineSizeTypes;
import com.microsoft.azure.management.appservice.WebApp;
import com.microsoft.azure.management.storage.StorageAccount;
import com.microsoft.azure.management.storage.SkuName;
import com.microsoft.azure.management.storage.StorageAccountKey;
import com.microsoft.azure.management.sql.SqlDatabase;
import com.microsoft.azure.management.sql.SqlServer;
import com.microsoft.azure.management.resources.fluentcore.arm.Region;
import com.microsoft.azure.management.resources.fluentcore.utils.SdkContext;
import com.microsoft.rest.LogLevel;
import com.microsoft.azure.storage.*;
import com.microsoft.azure.storage.blob.*;
import java.io.File;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;
public class AzureApp {
public static void main(String[] args) {
final String userName = "YOUR_VM_USERNAME";
final String sshKey = "YOUR_PUBLIC_SSH_KEY";
try {
// use the properties file with the service principal information to authenticate
// change the name of the environment variable if you used a different name in the previous step
final File credFile = new File(System.getenv("AZURE_AUTH_LOCATION"));
Azure azure = Azure.configure()
.withLogLevel(LogLevel.BASIC)
.authenticate(credFile)
.withDefaultSubscription();
// create a Ubuntu virtual machine in a new resource group
VirtualMachine linuxVM = azure.virtualMachines().define("testLinuxVM")
.withRegion(Region.US_EAST)
.withNewResourceGroup("sampleVmResourceGroup")
.withNewPrimaryNetwork("10.0.0.0/24")
.withPrimaryPrivateIPAddressDynamic()
.withoutPrimaryPublicIPAddress()
.withPopularLinuxImage(KnownLinuxVirtualMachineImage.UBUNTU_SERVER_16_04_LTS)
.withRootUsername(userName)
.withSsh(sshKey)
.withUnmanagedDisks()
.withSize(VirtualMachineSizeTypes.STANDARD_D3_V2)
.create();
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace();
}
}
}Run the sample from the command line:
mvn compile exec:javaYou'll see some REST requests and responses in the console as the SDK makes the underlying calls to the Azure REST API to configure the virtual machine and its resources. When the program finishes, verify the virtual machine in your subscription with the Azure CLI 2.0:
az vm list --resource-group sampleVmResourceGroup
Once you've verified that the code worked, use the CLI to delete the VM and its resources.
az group delete --name sampleVmResourceGroup
Replace the main method in AzureApp.java with the one below, updating the appName variable to a unique value before running the code. This code deploys a web application from the master branch in a public GitHub repo into a new Azure App Service Web App running in the free pricing tier.
public static void main(String[] args) {
try {
final File credFile = new File(System.getenv("AZURE_AUTH_LOCATION"));
final String appName = "YOUR_APP_NAME";
Azure azure = Azure.configure()
.withLogLevel(LogLevel.BASIC)
.authenticate(credFile)
.withDefaultSubscription();
WebApp app = azure.webApps().define(appName)
.withRegion(Region.US_WEST2)
.withNewResourceGroup("sampleWebResourceGroup")
.withNewWindowsPlan(PricingTier.FREE_F1)
.defineSourceControl()
.withPublicGitRepository(
"https://github.com/Azure-Samples/app-service-web-java-get-started")
.withBranch("master")
.attach()
.create();
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace();
}
}Run the code as before using Maven:
mvn clean compile exec:javaOpen a browser pointed to the application using the CLI:
az appservice web browse --resource-group sampleWebResourceGroup --name YOUR_APP_NAME
Remove the web app and plan from your subscription once you've verified the deployment.
az group delete --name sampleWebResourceGroup
Replace the current main method in AzureApp.java with the code below, setting a real value for the dbPassword variable.
This code creates a new SQL database with a firewall rule allowing remote access, and then connects to it using the SQL Database JBDC driver.
public static void main(String args[])
{
// create the db using the management libraries
try {
final File credFile = new File(System.getenv("AZURE_AUTH_LOCATION"));
Azure azure = Azure.configure()
.withLogLevel(LogLevel.BASIC)
.authenticate(credFile)
.withDefaultSubscription();
final String adminUser = SdkContext.randomResourceName("db",8);
final String sqlServerName = SdkContext.randomResourceName("sql",10);
final String sqlDbName = SdkContext.randomResourceName("dbname",8);
final String dbPassword = "YOUR_PASSWORD_HERE";
SqlServer sampleSQLServer = azure.sqlServers().define(sqlServerName)
.withRegion(Region.US_EAST)
.withNewResourceGroup("sampleSqlResourceGroup")
.withAdministratorLogin(adminUser)
.withAdministratorPassword(dbPassword)
.withNewFirewallRule("0.0.0.0","255.255.255.255")
.create();
SqlDatabase sampleSQLDb = sampleSQLServer.databases().define(sqlDbName).create();
// assemble the connection string to the database
final String domain = sampleSQLServer.fullyQualifiedDomainName();
String url = "jdbc:sqlserver://"+ domain + ":1433;" +
"database=" + sqlDbName +";" +
"user=" + adminUser+ "@" + sqlServerName + ";" +
"password=" + dbPassword + ";" +
"encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;";
// connect to the database, create a table and insert a entry into it
Connection conn = DriverManager.getConnection(url);
String createTable = "CREATE TABLE CLOUD ( name varchar(255), code int);";
String insertValues = "INSERT INTO CLOUD (name, code ) VALUES ('Azure', 1);";
String selectValues = "SELECT * FROM CLOUD";
Statement createStatement = conn.createStatement();
createStatement.execute(createTable);
Statement insertStatement = conn.createStatement();
insertStatement.execute(insertValues);
Statement selectStatement = conn.createStatement();
ResultSet rst = selectStatement.executeQuery(selectValues);
while (rst.next()) {
System.out.println(rst.getString(1) + " "
+ rst.getString(2));
}
} catch (Exception e) {
System.out.println(e.getMessage());
System.out.println(e.getStackTrace().toString());
}
}Run the sample from the command line:
mvn clean compile exec:javaThen clean up the resources using the CLI:
az group delete --name sampleSqlResourceGroup
Replace the current main method in AzureApp.java with the code below. This code creates an Azure storage account and then uses the Azure Storage libraries for Java to create a new text file in the cloud.
public static void main(String[] args) {
try {
// use the properties file with the service principal information to authenticate
// change the name of the environment variable if you used a different name in the previous step
final File credFile = new File(System.getenv("AZURE_AUTH_LOCATION"));
Azure azure = Azure.configure()
.withLogLevel(LogLevel.BASIC)
.authenticate(credFile)
.withDefaultSubscription();
// create a new storage account
String storageAccountName = SdkContext.randomResourceName("st",8);
StorageAccount storage = azure.storageAccounts().define(storageAccountName)
.withRegion(Region.US_WEST2)
.withNewResourceGroup("sampleStorageResourceGroup")
.create();
// create a storage container to hold the file
List<StorageAccountKey> keys = storage.getKeys();
final String storageConnection = "DefaultEndpointsProtocol=https;"
+ "AccountName=" + storage.name()
+ ";AccountKey=" + keys.get(0).value()
+ ";EndpointSuffix=core.windows.net";
CloudStorageAccount account = CloudStorageAccount.parse(storageConnection);
CloudBlobClient serviceClient = account.createCloudBlobClient();
// Container name must be lower case.
CloudBlobContainer container = serviceClient.getContainerReference("helloazure");
container.createIfNotExists();
// Make the container public
BlobContainerPermissions containerPermissions = new BlobContainerPermissions();
containerPermissions.setPublicAccess(BlobContainerPublicAccessType.CONTAINER);
container.uploadPermissions(containerPermissions);
// write a blob to the container
CloudBlockBlob blob = container.getBlockBlobReference("helloazure.txt");
blob.uploadText("hello Azure");
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace();
}
}
}Run the sample from the command line:
mvn clean compile exec:javaYou can browse for the helloazure.txt file in your storage account through the Azure portal or with Azure Storage Explorer.
Clean up the storage account using the CLI:
az group delete --name sampleStorageResourceGroup
To learn more about how to use the Azure management libraries for Java to manage resources and automate tasks, see our sample code for virtual machines, web apps and SQL database.
A reference is available for all packages.
Post questions to the community on Stack Overflow. Report bugs and open issues against the Azure libraries for Java on the project GitHub.