https://github.com/manageiq/azure-armrest
Ruby interface for Azure using the new REST API
https://github.com/manageiq/azure-armrest
azure hacktoberfest ruby
Last synced: 7 months ago
JSON representation
Ruby interface for Azure using the new REST API
- Host: GitHub
- URL: https://github.com/manageiq/azure-armrest
- Owner: ManageIQ
- License: apache-2.0
- Created: 2015-05-14T15:51:27.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-08-18T22:08:10.000Z (8 months ago)
- Last Synced: 2025-10-02T08:23:35.658Z (7 months ago)
- Topics: azure, hacktoberfest, ruby
- Language: Ruby
- Size: 1.07 MB
- Stars: 16
- Watchers: 10
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
## Description
A Ruby interface for Azure using the new REST API.
[](http://badge.fury.io/rb/azure-armrest)
[](https://github.com/ManageIQ/azure-armrest/actions/workflows/ci.yaml)
[](https://codeclimate.com/github/ManageIQ/azure-armrest)
[](https://codeclimate.com/github/ManageIQ/azure-armrest/coverage)
[](https://gitter.im/ManageIQ/azure-armrest?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Synopsis
```ruby
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 = Azure::Armrest::Configuration.new(
:client_id => 'XXXXX',
:client_key => 'YYYYY',
:tenant_id => 'ZZZZZ',
:subscription_id => 'ABCDEFG'
)
# This will then use the configuration info set above.
vms = Azure::Armrest::VirtualMachineService.new(conf)
# You can add other options specific to the service to be created,
# such as the provider.
options = {:provider => 'Microsoft.ClassicCompute'}
vms = Azure::Armrest::VirtualMachineService.new(conf, options)
# List all virtual machines for a given resource group:
vms.list(some_group).each do |vm|
puts vm.name
puts vm.resource_group
puts vm.location
puts vm.properties.hardware_profile.vm_size
end
```
## Subscriptions
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.
## Notes
Currently only the client credentials strategy is supported. Support for other
strategies may be added over time.
## License
The gem is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
## Authors
* Daniel Berger
* Bronagh Sorota
* Bill Wei