Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
A

azure-sdk-for-ruby

> 编程语言
Open source

Ruby SDK for Azure Resource Manager: build and manage your Azure cloud infrastructure (Compute, Virtual Networks, Storage, etc...) using Ruby.

279 stars0 likes1 views
WebsiteGitHub

About

Ruby SDK for Azure Resource Manager: build and manage your Azure cloud infrastructure (Compute, Virtual Networks, Storage, etc...) using Ruby.

[RETIRED] Microsoft Azure SDK for Ruby - Resource Management (preview)

This project provides a Ruby package for Azure Resource Management (ARM). If you're looking for Azure Service Management (ASM) please refer to this repo

Additional info on Azure deployment models https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-deployment-model

Important Announcement

As of February 2021, Azure Resource Management SDK for Ruby has entered a retirement phase and is no longer officially supported by Microsoft. Here is the complete list of packages that are affected by this. We are committed to making critical security and bug fixes for libraries in this repo until December 31, 2021. After that date, this repo will no longer be maintained.

For current users of the Azure Resource Management SDK for Ruby, we have prepared a migration guide that points outlines different alternative approaches you can take moving forward. Please check the guide here.

Thank you for your support so far. Should you have any question, please feel free to open an issue on GitHub.

Packages that are no longer supported

All resource management Azure Resource Management packages that contains “azure-mgmt” will be retired as well as a few client libraries.

Note that the Azure Storage SDK for Ruby is excluded from this retirement and continues to be maintained. The Azure Storage SDK for Ruby is available in its own preview gem and GitHub repository, which is still being maintained

Below is the list of the packages that are being retired

  • Authorization Azure Resource Manager role based authorization
  • Batch Azure Batch Management Account & Application operations management
  • CDN Azure Content Delivery Network
  • Cognitive Services Azure Cognitive Services Account management
  • Commerce Azure Commerce Usage aggregates & Rate card management
  • Compute Virtual Machines, Images, Extensions, Availability Sets, etc...
  • Consumption Usage details, Operations, etc...
  • Data Lake Analytics Azure Data Lake Analytics Account, Catalog and Job management
  • Data Lake Store Azure Data Lake Store Account and FileSystem management
  • DevTest Labs Azure DevTest Labs LabOperations, ArtifactSourceOperations, ArtifactOperations, CostOperations etc...
  • DNS Azure DNS Record Set and Zone management
  • Features Feature Exposure Controls
  • Graph Azure Active Directory Applications, Users, etc...
  • Monitor Azure Monitor management
  • IoTCentral Azure IoTCentral's Resource Management
  • IoTHub Azure IoTHub's Resource Management
  • Key Vault Azure Key Vault's vault management
  • Locks Management locks for Azure Resources
  • Logic Integration Accounts, AccountSchemas, AccountMaps, AccountPartners etc...
  • Machine Learning Azure Machine Learning web services management
  • Media Services Media Services resource management APIs
  • Mobile Engagement Azure Mobile Engagement's Apps, App Collections, Devices management APIs
  • Managed Service Identity Create, update, list user assigned identities.
  • Network Load Balancers, Network Gateways, Security Groups, etc...
  • Notification Hubs Notification Hubs management
  • Policy Policy Assignment & Policy definition operations
  • Power BI Embedded Azure Power BI Embedded Workspace & WorkspaceCollection management
  • Redis Redis resource management
  • Resources Resource Groups, Resource Providers, Template Deployments, Operations, etc...
  • Resource Graph Query Azure Resource Manager resources at scale
  • Scheduler Manage scheduled jobs in Azure
  • Search Manage Search resources
  • Server Management Azure Server Management Service like node, gateway, powershell etc..
  • SQL Manage Azure SQL resources
  • Storage Account Creation, Usage Operations, etc...
  • Stream Analytics Create, update, start, stop streaming jobs etc...
  • Subscriptions Manage Azure subscriptions
  • Traffic Manager Azure Traffic Manager's profile & endpoint management
  • WebApps Manage WebApps, formally known as WebSites

Azure Services

  • Service Bus
    • Relays
    • Topics
    • Queues

Supported Ruby Versions

  • Ruby 2+

Note: x64 Ruby for Windows is known to have some compatibility issues.

Getting Started with Azure Resource Manager Usage (Preview)

Install the rubygem packages

You can install the azure rubygem packages directly.

bash
gem install azure_mgmt_compute
gem install azure_mgmt_storage
gem install azure_mgmt_resources
gem install azure_mgmt_network

Or use them in your Gemfile.

ruby
gem 'azure_mgmt_storage'
gem 'azure_mgmt_compute'
gem 'azure_mgmt_resources'
gem 'azure_mgmt_network'

Be aware the Azure Resource Manager Ruby SDK is in preview and will likely have breaking interface changes in upcoming releases. An increased number in Minor version may indicate breaking changes.

Authentication

The first step to using the SDK is authentication and permissions. For people unfamilar with Azure this may be one of the more difficult concepts. For a reference on setting up a service principal from the command line see Authenticating a service principal with Azure Resource Manager or Unattended Authentication. For a more robust explanation of authentication in Azure, see Developer’s guide to auth with Azure Resource Manager API.

After creating the service principal, you should have three pieces of information, a client id (GUID), client secret (string) and tenant id (GUID) or domain name (string).

Prerequisite

In order to use the Azure SDK, you must supply the following values to the Azure SDK:

  • Tenant Id
  • Client Id
  • Subscription Id
  • Client Secret

You could pass the above values in the following ways:

Option 1 - Environment Variables

You can set the (above) values using the following environment variables:

  • AZURE_TENANT_ID
  • AZURE_CLIENT_ID
  • AZURE_SUBSCRIPTION_ID
  • AZURE_CLIENT_SECRET

To set the environment variables, in Windows, you could use the command such as:

set AZURE_TENANT_ID=

In Unix based systems, you could use the command such as:

bash
export AZURE_TENANT_ID=

Option 2 - Options Hash

The initialization of profile clients take an options hash as a parameter. This options hash consists of tenant_id, client_id, client_secret, subscription_id, active_directory_settings and credentials. Among these, the active_directory_settings and credentials are optional.

You can set the (above) values using the options hash:

ruby
options = {
  tenant_id: 'YOUR TENANT ID',
  client_id: 'YOUR CLIENT ID',
  client_secret: 'YOUR CLIENT SECRET',
  subscription_id: 'YOUR SUBSCRIPTION ID'
}

If you would like to pass in the credentials object, you could use the the following code:

ruby
provider = MsRestAzure::ApplicationTokenProvider.new(
       'YOUR TENANT ID',
       'YOUR CLIENT ID',
       'YOUR CLIENT SECRET')
credentials = MsRest::TokenCredentials.new(provider)

options = {
  tenant_id: 'YOUR TENANT ID',
  client_id: 'YOUR CLIENT ID',
  client_secret: 'YOUR CLIENT SECRET',
  subscription_id: 'YOUR SUBSCRIPTION ID',
  credentials: credentials
}

Option 3 - Combination of Environment Variables & Options Hash

You can set the (above) values using a combination of environment variables and options hash. The values mentioned in the options hash will take precedence over the environment variables.

Azure Multiple API versions & Profiles

With 0.15.0 of Azure SDK, multiple API versions and profiles are introduced. With these changes, each individual gem has multiple versions of the services and several profiles. The azure_sdk rollup gem also consists of several profiles. The following section provides details on the usage of multiple API versions and profiles.

Why Multiple API versions?

Versions 0.14.0 and older, would have access to the latest versions of Azure services at the time of release. Each release up to 0.14.0, would include the latest available api-version of the services. There wasn't an option to use an older api-version of the service (except for using an older version of the sdk gem). With the introduction of multiple API versions per gem, any api-version available for the service can be explicitly targeted.

What is a Profile?

A profile is a combination of different resource types with different versions from different services. Using a profile, will help you mix and match between various resource types.

What to use?

  • If you would like to use the latest versions of all the services, then the recommendation is to use the Latest profile of the Azure SDK rollup gem.

  • If you would like to use the services compatible with the Azure Stack, then the recommendation is to use the V2017_03_09 profile of the Azure SDK rollup gem.

  • If you would like to use the latest api-version of a service, then the recommendation is to use the Latest profile of the specific gem. For example, if you would like to use the latest api-version of compute service alone, use the Latest profile of compute gem.

  • If you would like to use specific api-version of a service, then the recommendation is to use the specific API versions defined inside that gem.

Note: All the above options could be combined within the same application.

Usage of azure_sdk gem

azure_sdk gem is a rollup of all the supported gems in the Ruby SDK. This gem consists of a Latest profile which supports the latest version of all services. it introduces a versioned profile V2017_03_09 profile which is b

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Rubyazure-resource-managerazure-resourcesazure-sdkazure-sdk-for-ruby

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 18, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言