azure_mgmt_storage

Intro

This project provides a Ruby gem for easy access to the Azure ARM Storage API. With this gem you can create/update/list/delete storage accounts.

Supported Ruby Versions

• Ruby 2+

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

Getting started

Setting up the service principal

First of all to start interacting with the ARM resources you will need to setup a service principal. Service principal is an Azure application which allows you to authenticate to Azure and access Azure services. The detailed steps of how to setup a service principal can be found in this article: http://aka.ms/cli-service-principal. In the result of setting up service principal you will get tenant id, client id and client secret data.

Installation

install the appropriate gem:

gem install azure_mgmt_storage

and reference it in your code:

require 'azure_mgmt_storage'

After that you should be ready to start using SDK!

Creating a Client

Option 1 - Using the Storage Profiles

You can create a new storage accounts using the Storage profile.

# Include SDK modules to ease access to Storage classes.
include Azure::Storage::Profiles::Latest::Mgmt
include Azure::Storage::Profiles::Latest::Mgmt::Models

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
}

client = Client.new(options)

Option 2 - Using a specific version of Storage

You can create a new storage account using a specific version of Storage, say 2017-06-01.

# Include SDK modules to ease access to resources classes.
include Azure::Storage::Mgmt::V2017_06_01
include Azure::Storage::Mgmt::V2017_06_01::Models

# Note: The tenant_id, client_id, client_secret and subscription_id
# must be set using the env variables.

provider = MsRestAzure::ApplicationTokenProvider.new(
       ENV['AZURE_TENANT_ID'],
       ENV['AZURE_CLIENT_ID'],
       ENV['AZURE_CLIENT_SECRET'])
credentials = MsRest::TokenCredentials.new(provider)

client = ResourceManagementClient.new(credentials)
client.subscription_id = ENV['AZURE_SUBSCRIPTION_ID']

Using the client

Once the client is initialized, we could create the storage account.

# Create a model for new storage account.
params = StorageAccountCreateParameters.new
params.location = 'westus'
sku = Sku.new
sku.name = 'Standard_LRS'
params.sku = sku
params.kind = Kind::Storage

promise = client.storage_accounts.create_async('some_existing_resource_group', 'newstorageaccount', params)

The SDK method returns a promise which you can utilize depending on your needs. E.g. if you need to get result immediately via sync blocking call - do the following:

result = promise.value!

If you need to follow async flow - provide a block which will be executed in off main thread:

promise = promise.then do |result|
  # Handle the result
end

In both cases you're returned an instance of MsRestAzure::AzureOperationResponse which contains HTTP requests/response objects and response body. Response body is a deserialized object representing the received information. In case of code above - newly created storage account. To get data from it:

storage_account = result.body

p storage_account.location
p storage_account.sku.name

Congrats, you've create new storage account. We encourage you to try more stuff and let us know your feedback! For advanced SDK usage please reference to the spec file storage_management_spec.rb.