Azure Management Libraries for Java

This README is based on the released stable version (1.3.0). If you are looking for other releases, see More Information.

The Azure Management Libraries for Java is a higher-level, object-oriented API for managing Azure resources. If you are looking for Java client libraries for Azure services, please see Azure libraries for Java - this page will be maintained regularly to ensure that it is up to date.

Note: This page will be maintained regularly to ensure that it is up to date.

Feature Availability and Road Map as of Version 1.3.0

Service | feature	Available as GA	Available as Preview	Coming soon
Compute	Virtual machines and VM extensions Virtual machine scale sets Managed disks	Azure container service + registry + instances Availability Zones	More Azure container registry features
Storage	Storage accounts	Encryption
SQL Database	Databases Firewalls Elastic pools		More features
Networking	Virtual networks Network interfaces IP addresses Routing table Network security groups Application gateways DNS Traffic managers	Load balancers Network peering Virtual Network Gateway Network watchers	VPN More application gateway features
More services	Resource Manager Key Vault Redis CDN Batch	Web apps Function Apps Service bus Graph RBAC Cosmos DB Search	Monitor Data Lake
Fundamentals	Authentication - core Async methods Managed Service Identity

Preview features are marked with the @Beta annotation at the class or interface or method level in libraries. These features are subject to change. They can be modified in any way, or even removed, in the future.

Azure Authentication

The Azure class is the simplest entry point for creating and interacting with Azure resources.

Azure azure = Azure.authenticate(credFile).withDefaultSubscription();

Create a Cosmos DB with CosmosDB Programming Model

You can create a Cosmos DB account by using a define() … create() method chain.

CosmosAccount cosmosDBAccount = azure.cosmosDBs().define(cosmosDBName)
	.withRegion(Region.US_EAST)
	.withNewResourceGroup(rgName)
	.withKind(DatabaseAccountKind.GLOBAL_DOCUMENT_DB)
	.withSessionConsistency()
	.withWriteReplication(Region.US_WEST)
	.withReadReplication(Region.US_CENTRAL)
	.create()

Create a Virtual Machine

You can create a virtual machine instance by using a define() … create() method chain.

System.out.println("Creating a Linux VM");

VirtualMachine linuxVM = azure.virtualMachines().define("myLinuxVM")
	.withRegion(Region.US_EAST)
	.withNewResourceGroup(rgName)
	.withNewPrimaryNetwork("10.0.0.0/28")
	.withPrimaryPrivateIPAddressDynamic()
	.withNewPrimaryPublicIPAddress("mylinuxvmdns")
	.withPopularLinuxImage(KnownLinuxVirtualMachineImage.UBUNTU_SERVER_16_04_LTS)
	.withRootUsername("tirekicker")
	.withSsh(sshKey)
	.withSize(VirtualMachineSizeTypes.STANDARD_D3_V2)
	.create();
	
System.out.println("Created a Linux VM: " + linuxVM.id());

Update a Virtual Machine

You can update a virtual machine instance by using an update() … apply() method chain.

linuxVM.update()
	.withNewDataDisk(20,  lun,  CachingTypes.READ_WRITE)
	.apply();

Create a Virtual Machine Scale Set

You can create a virtual machine scale set instance by using another define() … create() method chain.

 VirtualMachineScaleSet virtualMachineScaleSet = azure.virtualMachineScaleSets()
     .define(vmssName)
     .withRegion(Region.US_EAST)
     .withExistingResourceGroup(rgName)
     .withSku(VirtualMachineScaleSetSkuTypes.STANDARD_D3_V2)
     .withExistingPrimaryNetworkSubnet(network, "Front-end")
     .withPrimaryInternetFacingLoadBalancer(loadBalancer1)
     .withPrimaryInternetFacingLoadBalancerBackends(backendPoolName1, backendPoolName2)
     .withPrimaryInternetFacingLoadBalancerInboundNatPools(natPool50XXto22, natPool60XXto23)
     .withoutPrimaryInternalLoadBalancer()
     .withPopularLinuxImage(KnownLinuxVirtualMachineImage.UBUNTU_SERVER_16_04_LTS)
     .withRootUsername(userName)
     .withSsh(sshKey)
     .withNewDataDisk(100)
     .withNewDataDisk(100, 1, CachingTypes.READ_WRITE)
     .withNewDataDisk(100, 2, CachingTypes.READ_WRITE, StorageAccountTypes.STANDARD_LRS)
     .withCapacity(3)
     .create();

Create a Network Security Group

You can create a network security group instance by using another define() … create() method chain.

NetworkSecurityGroup frontEndNSG = azure.networkSecurityGroups().define(frontEndNSGName)
    .withRegion(Region.US_EAST)
    .withNewResourceGroup(rgName)
    .defineRule("ALLOW-SSH")
        .allowInbound()
        .fromAnyAddress()
        .fromAnyPort()
        .toAnyAddress()
        .toPort(22)
        .withProtocol(SecurityRuleProtocol.TCP)
        .withPriority(100)
        .withDescription("Allow SSH")
        .attach()
    .defineRule("ALLOW-HTTP")
        .allowInbound()
        .fromAnyAddress()
        .fromAnyPort()
        .toAnyAddress()
        .toPort(80)
        .withProtocol(SecurityRuleProtocol.TCP)
        .withPriority(101)
        .withDescription("Allow HTTP")
        .attach()
    .create();

Create an Application Gateway

You can create a application gateway instance by using another define() … create() method chain.

ApplicationGateway applicationGateway = azure.applicationGateways().define("myFirstAppGateway")
    .withRegion(Region.US_EAST)
    .withExistingResourceGroup(resourceGroup)
    // Request routing rule for HTTP from public 80 to public 8080
    .defineRequestRoutingRule("HTTP-80-to-8080")
        .fromPublicFrontend()
        .fromFrontendHttpPort(80)
        .toBackendHttpPort(8080)
        .toBackendIPAddress("11.1.1.1")
        .toBackendIPAddress("11.1.1.2")
        .toBackendIPAddress("11.1.1.3")
        .toBackendIPAddress("11.1.1.4")
        .attach()
    .withExistingPublicIPAddress(publicIpAddress)
    .create();

Create a Web App

You can create a Web App instance by using another define() … create() method chain.

WebApp webApp = azure.webApps()
    .define(appName)
    .withRegion(Region.US_WEST)
    .withNewResourceGroup(rgName)
    .withNewWindowsPlan(PricingTier.STANDARD_S1)
    .create();

Create a SQL Database

You can create a SQL server instance by using another define() … create() method chain.

SqlServer sqlServer = azure.sqlServers().define(sqlServerName)
    .withRegion(Region.US_EAST)
    .withNewResourceGroup(rgName)
    .withAdministratorLogin("adminlogin123")
    .withAdministratorPassword("myS3cureP@ssword")
    .withNewFirewallRule("10.0.0.1")
    .withNewFirewallRule("10.2.0.1", "10.2.0.10")
    .create();

Then, you can create a SQL database instance by using another define() … create() method chain.

SqlDatabase database = sqlServer.databases().define("myNewDatabase")
    .create();

Sample Code

You can find plenty of sample code that illustrates management scenarios (95+ end-to-end scenarios) for Azure Virtual Machines, Virtual Machine Scale Sets, Managed Disks, Active Directory Azure Container Service and Registry, Storage, Networking, Resource Manager, SQL Database, Cosmos DB, App Service (Web Apps on Windows and Linux), Functions, Service Bus, Key Vault, Redis, CDN and Batch …

Service	Management Scenario
Virtual Machines	Manage virtual machines Manage virtual machines asynchronously Manage availability set List virtual machine images Manage virtual machines using VM extensions List virtual machine extension images Create virtual machines from generalized image or specialized VHD Create virtual machine using custom image from virtual machine Create virtual machine using custom image from VHD Create virtual machine by importing a specialized operating system disk VHD Create virtual machine using specialized VHD from snapshot Convert virtual machines to use managed disks Manage virtual machine with unmanaged disks Manage Azure resources from a virtual machine with managed service identity (MSI) Manage virtual machines in availability zones Manage virtual machine scale sets in availability zones
Virtual Machines - parallel execution	Create multiple virtual machines in parallel Create multiple virtual machines with network in parallel Create multiple virtual machines across regions in parallel
Virtual Machine Scale Sets	Manage virtual machine scale sets (behind an Internet facing load balancer) Manage virtual machine scale sets (behind an Internet facing load balancer) asynchronously Manage virtual machine scale sets with unmanaged disks
Active Directory	Manage service principals using Java Manage users and groups and manage their roles Manage passwords
Container Service Container Registry and Container Instances	Manage container registry Deploy an image from container registry to Kubernetes cluster Manage container service Manage Azure Container Instances with new Azure File Share Manage Azure Container Instances with an existing Azure File Share Create Container Group with multiple instances and container images Create Container Group and scale up containers using Kubernetes in ACS
Storage	Manage storage accounts Manage storage accounts asynchronously
Networking	Manage virtual network Manage virtual network asynchronously Manage network interface Manage network security group Manage IP address Manage Internet facing load balancers Manage internal load balancers Create simple Internet facing load balancer Use net watcher Manage network peering between two virtual networks Use network watcher to check connectivity between virtual machines in peered networks Manage virtual network with site-to-site VPN connection Manage virtual network to virtual network VPN connection
Networking - DNS	Host and manage domains
Traffic Manager	Manage traffic manager profiles
Application Gateway	Manage application gateways Manage application gateways with backend pools
SQL Database	Manage SQL databases Manage SQL databases in elastic pools Manage firewalls for SQL databases Manage SQL databases across regions
App Service - Web Apps on Windows	Manage Web apps Manage Web apps with custom domains Configure deployment sources for Web apps Configure deployment sources for Web apps asynchronously Manage staging and production slots for Web apps Scale Web apps Manage storage connections for Web apps Manage data connections (such as SQL database and Redis cache) for Web apps Manage authentication for Web apps
App Service - Web Apps on Linux	Manage Web apps Deploy a container image from Azure Container Registry to Linux containers Manage Web apps with custom domains Configure deployment sources for Web apps Scale Web apps Manage storage connections for Web apps Manage data connections (such as SQL database and Redis cache) for Web apps
Functions	Manage functions Manage functions with custom domains Configure deployment sources for functions Manage authentication for functions
Cosmos DB	Create a CosmosDB and configure it for high availability Create a CosmosDB and configure it with eventual consistency Create a CosmosDB, configure it for high availability and create a firewall to limit access from an approved set of IP addresses Create a CosmosDB and get MongoDB connection string
Service Bus	Manage queues with basic features Manage publish-subscribe with basic features Manage queues and publish-subcribe with cliams based authorization Manage publish-subscribe with advanced features - sessions, dead-lettering, de-duplication and auto-deletion of idle entries Manage queues with advanced features - sessions, dead-lettering, de-duplication and auto-deletion of idle entries
Resource Groups	Manage resource groups Manage resources Deploy resources with ARM templates Deploy resources with ARM templates (with progress) Deploy a virtual machine with managed disks using an ARM template
Redis Cache	Manage Redis Cache
Key Vault	Manage key vaults
CDN	Manage CDNs
Batch	Manage batch accounts
Search	Manage Azure search

Download

1.3.0

If you are using released builds from 1.3.0, add the following to your POM file:

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure</artifactId>
    <version>1.3.0</version>
</dependency>

Latest snapshots

If you are using snapshots builds for this repo, add the following repository and dependency to your POM file:

  <repositories>
    <repository>
      <id>ossrh</id>
      <name>Sonatype Snapshots</name>
      <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
      <layout>default</layout>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>always</updatePolicy>
      </snapshots>
    </repository>
  </repositories>

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure</artifactId>
    <version>1.3.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-client-runtime</artifactId>
    <version>1.1.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-client-authentication</artifactId>
    <version>1.1.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.rest</groupId>
    <artifactId>client-runtime</artifactId>
    <version>1.1.1-SNAPSHOT</version>
</dependency>

Pre-requisites

• A Java Developer Kit (JDK), v 1.7 or later
• Maven
• Azure Service Principal - see how to create authentication info.

Help

If you are migrating your code to 1.3.0, you can use these notes for preparing your code for 1.3.0 from 1.2.0.

If you encounter any bugs with these libraries, please file issues via Issues or checkout StackOverflow for Azure Java SDK.

Contribute Code

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

More Information

• Javadoc
• http://azure.com/java
• If you don't have a Microsoft Azure subscription you can get a FREE trial account here

Previous Releases and Corresponding Repo Branches

Version	SHA1	Remarks
1.2.1	1.2.1	Tagged release for 1.2.1 version of Azure management libraries
1.1.0	1.1.0	Tagged release for 1.1.0 version of Azure management libraries
1.0.0	1.0.0	Tagged release for 1.0.0 version of Azure management libraries
1.0.0-beta5	1.0.0-beta5	Tagged release for 1.0.0-beta5 version of Azure management libraries
1.0.0-beta4.1	1.0.0-beta4.1	Tagged release for 1.0.0-beta4.1 version of Azure management libraries
1.0.0-beta3	1.0.0-beta3	Tagged release for 1.0.0-beta3 version of Azure management libraries
1.0.0-beta2	1.0.0-beta2	Tagged release for 1.0.0-beta2 version of Azure management libraries
1.0.0-beta1	1.0.0-beta1	Maintenance branch for AutoRest generated raw clients
1.0.0-beta1+fixes	1.0.0-beta1+fixes	Stable build for AutoRest generated raw clients
0.9.x-SNAPSHOTS	0.9	Maintenance branch for service management libraries
0.9.3	0.9.3	Latest release for service management libraries

---

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.