joshfree/azure-libraries-for-java

Azure Management Libraries for Java

Azure Management Libraries for Java

This README is based on the released stable version (1.22.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, that is optimized for ease of use, succinctness and consistency.

If you are looking for Java client libraries for consuming (rather than managing) individual Azure services (e.g. storage blob upload, JDBC, messaging, etc), please see https://docs.microsoft.com/en-us/java/azure/java-sdk-azure-install.

Table of contents

• Feature availability and road map
• Code snippets and samples
  • Virtual machines
  • Networking
  • Application services
  • Databases and storage
  • Others...
• Download
• Prerequisites
• Updgrading from older versions
• Help and issues
• Contribute code
• More information

Feature Availability and Road Map

🚩 as of Version 1.22.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 (AKS) + registry + instances Availability Zones	More Availability Zones and MSI features
Storage	Storage accounts Encryption (deprecated)	Encryption (Blob) Encryption (File)
SQL Database	Databases Firewalls and virtual network Elastic pools Import, export, recover and restore dbs Failover groups and replication links DNS aliasing and metrics Sync groups Encryption protectors		More features
Networking	Virtual networks Network interfaces IP addresses Routing table Network security groups Load balancers Application gateways DNS Traffic managers	Network peering Virtual Network Gateway Network watchers Express Route Application Security Groups	More application gateway features
More services	Resource Manager Key Vault Redis CDN Batch Service bus Graph RBAC	Web apps Function Apps Cosmos DB Monitor Batch AI Search Event Hub	Data Lake More Monitor features Logic Apps Event Grid
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.

Code snippets and samples

Azure Authentication

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

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

To learn more about authentication in the Azure Libraries for Java, see AUTH.md.

Virtual Machines

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 a 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();

Ready-to-run code samples for virtual machines

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 system assigned managed service identity (MSI) Manage Azure resources from a virtual machine with managed service identity (MSI) credentials Manage Azure resources from a virtual machine with system assigned managed service identity (MSI) Manage virtual machines in availability zones Manage virtual machine scale sets in availability zones List compute SKUs
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 Create multiple virtual machines in parallel and track related resources
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

Networking

Create a virtual network

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

Network network = networks.define("mynetwork")
	.withRegion(Region.US_EAST)
	.withNewResourceGroup()
	.withAddressSpace("10.0.0.0/28")
	.withSubnet("subnet1", "10.0.0.0/29")
	.withSubnet("subnet2", "10.0.0.8/29")
	.create();

Create a network security group

You can create a network security group instance by using a 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 a 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();

Ready-to-run code samples for networking

Service	Management Scenario
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 Manage client to virtual network VPN connection
DNS	Host and manage domains
Traffic Manager	Manage traffic manager profiles
Application Gateway	Manage application gateways Manage application gateways with backend pools
Express Route	Create and configure Express Route

Application Services

Create a Web App

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

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

Ready-to-run code samples for Application Services

Service	Management Scenario
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 Safegaurd Web app secrets in Key Vault Safegaurd Web app secrets in Key Vault using convenience API
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 Get function logs

Databases and Storage

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.cosmosDBAccounts().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 SQL Database

You can create a SQL server instance by using a 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 a define() … create() method chain.

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

Ready-to-run code samples for databases

Service	Management Scenario
Storage	Manage storage accounts Manage storage accounts asynchronously Manage network rules of a storage account
SQL Database	Manage SQL databases Manage SQL databases in elastic pools Manage firewalls for SQL databases Manage SQL databases across regions Import and export SQL databases Restore and recover SQL databases Get SQL Database metrics Manage SQL Database Failover Groups Manage SQL Server DNL aliases Manage SQL secrets (Server Keys) in Azure Key Vault Manage SQL Virtual Network Rules
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

Other code samples

Service	Management Scenario
Active Directory	Manage service principals using Java Manage users and groups and manage their roles Manage passwords Manage Azure resources from a managed service identity (MSI) enabled virtual machine that belongs to an Azure Active Directory (AAD) security group
Container Service Container Registry and Container Instances	Manage container registry Manage container registry with Web hooks Manage Kubernetes cluster (AKS) Deploy an image from container registry to Kubernetes cluster (AKS) Deploy an image from container registry to ACS with Kubernetes orchestrator 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
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 Manage resource locks 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
Monitor	Get metrics and activity logs for a resource Stream Azure Service Logs and Metrics for consumption through Event Hub Configuring activity log alerts to be triggered on potential security breaches or risks. Configuring metric alerts to be triggered on potential performance downgrade. Configuring autoscale settings to scale out based on webapp request count statistic.
CDN	Manage CDNs
Batch	Manage batch accounts
Batch AI	Create Batch AI cluster and execute AI job
Search	Manage Azure search
Event Hub	Manage event hub and associated resources Manage event hub geo-disaster recovery Stream Azure Service Logs and Metrics for consumption through Event Hub

Download

Latest stable release

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

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure</artifactId>
    <version>1.22.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.22.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-client-runtime</artifactId>
    <version>1.6.5-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-client-authentication</artifactId>
    <version>1.6.5-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.microsoft.rest</groupId>
    <artifactId>client-runtime</artifactId>
    <version>1.6.5-SNAPSHOT</version>
</dependency>

Prerequisites

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

Upgrading from older versions

If you are migrating your code from 1.21.0 to 1.22.0, you can use these release notes for preparing your code for 1.22.0 from 1.21.0.

In general, Azure Libraries for Java follow semantic versioning, so user code should continue working in a compatible fashion between minor versions of the same major version release train, with the following caveats:

• methods and types annotated with @Beta are not considered "generally available" and their design and functionality may change arbitrarily (including removal) in any future minor release of the libraries. To help identify such @Beta breaking changes from one minor release to the next and see how to mitigate them, see the above mentioned release notes for each release.

• occasionally the naming and structure of "fluent" interface definitions (i.e. the ones whose names start with With*) may change between minor versions, as long as that change does not affect the fluent "flow" (the chaining of the methods in a definition or update chain).

• the *Inner types and their methods may occasionally change their naming and structure between minor versions in breaking ways. User code should generally avoid making a reference to those types though, unless their functionality is not yet exposed by the "fluent" API.

Help and Issues

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.21.0	1.21.0	Tagged release for 1.21.0 version of Azure management libraries
1.20.1	1.20.1	Tagged release for 1.20.1 version of Azure management libraries
1.20.0	1.20.0	Tagged release for 1.20.0 version of Azure management libraries
1.19.0	1.19.0	Tagged release for 1.19.0 version of Azure management libraries
1.18.0	1.18.0	Tagged release for 1.18.0 version of Azure management libraries
1.17.0	1.17.0	Tagged release for 1.17.0 version of Azure management libraries
1.16.0	1.16.0	Tagged release for 1.16.0 version of Azure management libraries
1.15.1	1.15.1	Tagged release for 1.15.1 version of Azure management libraries
1.15.0	1.15.0	Tagged release for 1.15.0 version of Azure management libraries
1.14.0	1.14.0	Tagged release for 1.14.0 version of Azure management libraries
1.13.0	1.13.0	Tagged release for 1.13.0 version of Azure management libraries
1.12.0	1.12.0	Tagged release for 1.12.0 version of Azure management libraries
1.11.0	1.11.0	Tagged release for 1.11.0 version of Azure management libraries
1.10.0	1.10.0	Tagged release for 1.10.0 version of Azure management libraries
1.9.0	1.9.0	Tagged release for 1.9.0 version of Azure management libraries
1.8.0	1.8.0	Tagged release for 1.8.0 version of Azure management libraries
1.7.0	1.7.0	Tagged release for 1.7.0 version of Azure management libraries
1.6.0	1.6.0	Tagged release for 1.6.0 version of Azure management libraries
1.5.1	1.5.1	Tagged release for 1.5.1 version of Azure management libraries
1.4.0	1.4.0	Tagged release for 1.4.0 version of Azure management libraries
1.3.0	1.3.0	Tagged release for 1.3.0 version of Azure management libraries
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 opencode@microsoft.com with any additional questions or comments.