Class: Azure::StorageManagement::StorageManagementService

Inherits:
BaseManagement::BaseManagementService show all
Defined in:
lib/azure/storage_management/storage_management_service.rb

Overview

Provides Storage Management API

Instance Attribute Summary

Attributes inherited from BaseManagement::BaseManagementService

#client

Instance Method Summary collapse

Methods inherited from BaseManagement::BaseManagementService

#create_affinity_group, #delete_affinity_group, #get_affinity_group, #initialize, #list_affinity_groups, #list_locations, #list_role_sizes, #update_affinity_group, #validate_configuration!

Constructor Details

This class inherits a constructor from Azure::BaseManagement::BaseManagementService

Instance Method Details

#create_storage_account(name, options = {}) ⇒ Object

Public: Create a new storage account in Microsoft Azure.

Attributes

  • name - String. The name of the storage service.

  • options - Hash. Optional parameters.

Options

Accepted key/value pairs in options parameter are:

  • :label - String. The label for this storage account. The name will

be used as label if none specified. (optional)

  • :location - String. The location where the storage

service will be created. Reqruied if no affinity_group_name specified.

  • :description - String. A description for the storage

service. (optional)

  • :affinity_group_name - String. The name of an existing affinity group

in the specified subscription. Required if no location specified.

  • :geo_replication_enabled - String. A flag indicating wheter to

turn Geo replication on or off. Values other than ‘true’/‘false’ will result in an error from the REST API. (optional)

  • :extended_properties - Hash. Key/Value pairs of extended

properties to add to the storage account. The key is used as the property name and the value as its value. (optional)

  • :account_type - String. Specifies the type of storage account

See msdn.microsoft.com/en-us/library/azure/hh264518.aspx

Returns None



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 88

def (name, options = {})
  raise 'Name not specified' if !name || name.class != String || name.empty?
  options[:account_type] ||= 'Standard_GRS'
  if (name)
    Azure::Loggerx.warn "Storage Account #{name} already exists. Skipped..."
  else
    Azure::Loggerx.info "Creating Storage Account #{name}."
    body = Serialization.storage_services_to_xml(name, options)
    request_path = '/services/storageservices'
    request = client.management_request(:post, request_path, body: body)
    request.call
  end
end

#delete_storage_account(name) ⇒ Object

Public: Deletes the specified storage account of given subscription id from Microsoft Azure.

Attributes

  • name - String. Storage account name.

See msdn.microsoft.com/en-us/library/azure/hh264517.aspx

Returns: None



151
152
153
154
155
156
157
158
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 151

def (name)
  Azure::Loggerx.info "Deleting Storage Account #{name}."
  request_path = "/services/storageservices/#{name}"
  request = client.management_request(:delete, request_path)
  request.call
rescue => e
  e.message
end

#get_storage_account(name) ⇒ Object

Public: Checks to see if the specified storage account is available

Attributes

  • name - String. Storage account name.

Returns an Azure::StorageManagement::StorageAccount instance



39
40
41
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 39

def (name)
  list_storage_accounts.select { |x| x.name.casecmp(name.to_s) == 0 }.first
end

#get_storage_account_keys(name) ⇒ Object

Public: Gets the primary and secondary access keys for the specified storage account.

Attributes

  • name - String. Storage account name.

Returns an Azure::StorageManagement::StorageAccountKeys instance.

See: msdn.microsoft.com/en-us/library/azure/ee460785.aspx



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 193

def (name)
  if  name
    path = "/services/storageservices/#{name}/keys"
    request = client.management_request(:get, path)
    response = request.call
    Serialization.(response)
  else
    Azure::Loggerx.warn "Storage Account '#{name}' does not exist."
  end
end

#get_storage_account_properties(name) ⇒ Object

Public: Gets the properties of the storage account specified.

Attributes

  • name - String. The name of the storage account. Required.

See msdn.microsoft.com/en-us/library/azure/ee460802.aspx

Returns the storage account



52
53
54
55
56
57
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 52

def (name)
  request_path = "/services/storageservices/#{name}"
  request = client.management_request(:get, request_path)
  response = request.call
  Serialization.storage_services_from_xml(response).first
end

#list_storage_accounts ⇒ Object

Public: Gets a list of storage accounts available under the current subscription.

Returns an array of Azure::StorageManagement::StorageAccount objects



25
26
27
28
29
30
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 25

def list_storage_accounts
  request_path = '/services/storageservices'
  request = client.management_request(:get, request_path)
  response = request.call
  Serialization.storage_services_from_xml(response)
end

#regenerate_storage_account_keys(name, key_type = 'primary') ⇒ Object

Public: Regenerates the primary or secondary access key for the specified storage account

Attributes

  • name - String. Storage account name.

  • key_type - String. Specifies which key(primary or secondary) to regenerate

Returns an Azure::StorageManagement::StorageAccountKeys instance.

See: msdn.microsoft.com/en-us/library/azure/ee460795.aspx



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 171

def (name, key_type = 'primary')
  if  name
    path = "/services/storageservices/#{name}/keys?action=regenerate"
    body = Serialization. key_type
    request = client.management_request(:post, path, body)
    response = request.call
    Serialization.(response)
  else
    Azure::Loggerx.warn "Storage Account '#{name}' does not exist."
  end
end

#update_storage_account(name, options) ⇒ Object

Public: Updates an existing storage account in Microsoft Azure

Attributes

  • name - String. The name of the storage service.

  • options - Hash. parameters.

Options

Accepted key/value pairs in options parameter are:

  • :label - String. A label for the storage service. Required if no

description is provided. If both label and description are provided, only the label will get updated.

  • :description - String. A description for the storage service.

Required if no label is provided. If both label and description are provided, only the label will get updated.

  • :geo_replication_enabled - Boolean (TrueClass/FalseClass). Boolean

flag indicating whether to turn Geo replication on or off. (optional)

  • :extended_properties - Hash. Key/Value pairs of extended

properties to add to the storage account. The key is used as the property name and the value as its value. (optional)

  • :account_type - String. Specifies the type of storage account

See msdn.microsoft.com/en-us/library/azure/hh264516.aspx

Returns None Fails with RuntimeError if invalid options specified



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/azure/storage_management/storage_management_service.rb', line 129

def (name, options)
  if  name
    Azure::Loggerx.info "Account '#{name}' exists, updating..."
    body = Serialization.storage_update_to_xml options
    request_path = "/services/storageservices/#{name}"
    request = client.management_request(:put, request_path, body)
    request.call
  else
    Azure::Loggerx.warn "Storage Account '#{name}' does not exist. Skipped..."
  end
end