A Ruby interface for Azure using the new REST API.

Gem Version CI Code Climate Test Coverage

Join the chat at


require 'azure/armrest'

# Create a configuration object. All service objects will then use the
# information you set here.
# A token will be retrieved based on the information you provided

conf =
  :client_id       => 'XXXXX',
  :client_key      => 'YYYYY',
  :tenant_id       => 'ZZZZZ',
  :subscription_id => 'ABCDEFG'

# This will then use the configuration info set above.
vms =

# You can add other options specific to the service to be created,
# such as the provider.

options = {:provider => 'Microsoft.ClassicCompute'}
vms =, options)

# List all virtual machines for a given resource group:
vms.list(some_group).each do |vm|
  puts vm.resource_group
  puts vm.location


As of version 0.4.0 you a subscription ID is not longer strictly necessary in the Configuration constructor, but almost all service classes require it in their own constructor. Only the SubscriptionService class does not.

In version 0.3.x the subscription ID was mandatory. Prior to 0.3.x, if you did not provide a subscription ID in your configuration object, then the first subscription ID returned from a REST call would be used.


Currently only the client credentials strategy is supported. Support for other strategies may be added over time.


The gem is available as open source under the terms of the Apache License 2.0.


  • Daniel Berger
  • Bronagh Sorota
  • Bill Wei