azure_mgmt_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fac47453e3ad6d2b881f6ac27930b5a53832740
+  data.tar.gz: 07be1c8903032f44238c1c3b2252ea4732143fd7
+SHA512:
+  metadata.gz: 37f50b4ed61e1ee3e409e746a0dcf136eb18f8177fe12734f14cb0402fd5dee7d6d728a77a4ca0480a5b8ac4ecc1d32e86b7b13e5ee11e914f2b9436a86778eb
+  data.tar.gz: c452b1be10063ee007196547deb70cdce72dc4eeebe7a920d88334b5992338457b8a662c434e8e071a6ce104e89429d7b5cf3b2b20fd1ee0f974ba97d153cc51

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/resource_management/azure_mgmt_storage/spec/reports/
+/tmp/
+/.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'azure_mgmt_resources', path: '../azure_mgmt_resources'
+end
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# 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. Usage operation aren't supported yet.
+
+# 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:
+
+```Ruby
+require 'azure_mgmt_storage'
+```
+
+After that you should be ready to start using SDK!
+
+## Authentication
+
+```Ruby
+# Create authentication objects
+token_provider = MsRestAzure::ApplicationTokenProvider.new(tenant_id, client_id, secret)
+credentials = MsRest::TokenCredentials.new(token_provider)
+```
+
+To get tenant_id, client_id and secret for your Azure application visit Azure portal or copy them from the powershell script from the article mentioned above.
+
+## Creating storage account
+
+```Ruby
+# Create a client - a point of access to the API and set the subscription id
+client = Azure::ARM::Storage::StorageManagementClient.new(credentials)
+client.subscription_id = subscription_id
+
+# Create a model for new storage account.
+properties = Azure::ARM::Storage::Models::StorageAccountPropertiesCreateParameters.new
+properties.account_type = 'Standard_LRS'
+
+params = Azure::ARM::Storage::Models::StorageAccountCreateParameters.new
+params.properties = properties
+params.location = 'westus'
+
+promise = client.storage_accounts.create('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:
+
+```Ruby
+result = promise.value!
+```
+
+If you need to follow async flow - provide a block which will be executed in off main thread:
+
+```Ruby
+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:
+
+```Ruby
+storage_account = result.body
+
+p storage_account.location
+p storage_account.properties.account_type
+```
+
+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.
+
+# Running tests
+
+## Adding env variables
+
+To run the tests you would need to set the following environment variables with your real Azure data:
+
+* azure_tenant_id
+* azure_client_id
+* azure_client_secret
+* subscription_id
+
+* run_long_tasks - set this to '1' only if you would like to run time consuming tests like VM creation.
+
+## Starting tests
+
+Just run 'rspec' command from the current gem folder.
+
+# Contribution
+
+All the SDK code was generated by tool 'AutoRest' - https://github.com/Azure/autorest
+So if you have found a bug or have an idea for a new feature - suggest, discuss and contribute it into the AutoRest repository. After that SDK maintainers will update the sources and the gem.
+
+# Provide feedback
+
+Send email to the azsdkteam@microsoft.com or file new issue in this repository.

data/Rakefile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+require "bundler/gem_tasks"

data/azure_mgmt_storage.gemspec

@@ -0,0 +1,39 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'azure_mgmt_storage/module_definition'
+require 'azure_mgmt_storage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'azure_mgmt_storage'
+  spec.version       = Azure::ARM::Storage::VERSION
+  spec.authors       = 'Microsoft Corporation'
+  spec.email         = 'azsdkteam@microsoft.com'
+  spec.description   = 'Microsoft Azure Storage Management Client Library for Ruby'
+  spec.summary       = 'Official ruby client library to consume Microsoft Azure Storage Management services.'
+  spec.homepage      = 'http://github.com/azure/azure-sdk-for-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'dotenv', '~> 2'
+  spec.add_development_dependency 'azure_mgmt_resources', '~> 0.1'
+
+  spec.add_runtime_dependency 'json', '~> 1.8'
+  spec.add_runtime_dependency 'concurrent-ruby', ['>= 1.0.0.pre1', '<2']
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0.6'
+  spec.add_runtime_dependency 'ms_rest_azure', '~> 0.1'
+end

data/lib/azure_mgmt_storage.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator 0.11.0.0
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+
+require 'uri'
+require 'cgi'
+require 'date'
+require 'json'
+require 'base64'
+require 'erb'
+require 'securerandom'
+require 'time'
+require 'timeliness'
+require 'faraday'
+require 'faraday-cookie_jar'
+require 'concurrent'
+require 'ms_rest'
+require 'ms_rest_azure'
+
+require 'azure_mgmt_storage/module_definition'
+require 'azure_mgmt_storage/version'
+
+module Azure::ARM::Storage
+  autoload :StorageAccounts,                                    'azure_mgmt_storage/storage_accounts.rb'
+  autoload :UsageOperations,                                    'azure_mgmt_storage/usage_operations.rb'
+  autoload :StorageManagementClient,                            'azure_mgmt_storage/storage_management_client.rb'
+
+  module Models
+    autoload :StorageAccountCheckNameAvailabilityParameters,      'azure_mgmt_storage/models/storage_account_check_name_availability_parameters.rb'
+    autoload :CheckNameAvailabilityResult,                        'azure_mgmt_storage/models/check_name_availability_result.rb'
+    autoload :StorageAccountPropertiesCreateParameters,           'azure_mgmt_storage/models/storage_account_properties_create_parameters.rb'
+    autoload :Endpoints,                                          'azure_mgmt_storage/models/endpoints.rb'
+    autoload :CustomDomain,                                       'azure_mgmt_storage/models/custom_domain.rb'
+    autoload :StorageAccountProperties,                           'azure_mgmt_storage/models/storage_account_properties.rb'
+    autoload :StorageAccountKeys,                                 'azure_mgmt_storage/models/storage_account_keys.rb'
+    autoload :StorageAccountListResult,                           'azure_mgmt_storage/models/storage_account_list_result.rb'
+    autoload :StorageAccountPropertiesUpdateParameters,           'azure_mgmt_storage/models/storage_account_properties_update_parameters.rb'
+    autoload :StorageAccountRegenerateKeyParameters,              'azure_mgmt_storage/models/storage_account_regenerate_key_parameters.rb'
+    autoload :UsageName,                                          'azure_mgmt_storage/models/usage_name.rb'
+    autoload :Usage,                                              'azure_mgmt_storage/models/usage.rb'
+    autoload :UsageListResult,                                    'azure_mgmt_storage/models/usage_list_result.rb'
+    autoload :StorageAccountCreateParameters,                     'azure_mgmt_storage/models/storage_account_create_parameters.rb'
+    autoload :StorageAccount,                                     'azure_mgmt_storage/models/storage_account.rb'
+    autoload :StorageAccountUpdateParameters,                     'azure_mgmt_storage/models/storage_account_update_parameters.rb'
+    autoload :Reason,                                             'azure_mgmt_storage/models/reason.rb'
+    autoload :AccountType,                                        'azure_mgmt_storage/models/account_type.rb'
+    autoload :ProvisioningState,                                  'azure_mgmt_storage/models/provisioning_state.rb'
+    autoload :AccountStatus,                                      'azure_mgmt_storage/models/account_status.rb'
+    autoload :KeyName,                                            'azure_mgmt_storage/models/key_name.rb'
+    autoload :UsageUnit,                                          'azure_mgmt_storage/models/usage_unit.rb'
+  end
+end

data/lib/azure_mgmt_storage/models/account_status.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator 0.11.0.0
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::ARM::Storage
+  module Models
+    #
+    # Defines values for AccountStatus
+    #
+    module AccountStatus
+      Available = "Available"
+      Unavailable = "Unavailable"
+    end
+  end
+end

data/lib/azure_mgmt_storage/models/account_type.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator 0.11.0.0
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::ARM::Storage
+  module Models
+    #
+    # Defines values for AccountType
+    #
+    module AccountType
+      StandardLRS = "Standard_LRS"
+      StandardZRS = "Standard_ZRS"
+      StandardGRS = "Standard_GRS"
+      StandardRAGRS = "Standard_RAGRS"
+      PremiumLRS = "Premium_LRS"
+    end
+  end
+end

data/lib/azure_mgmt_storage/models/check_name_availability_result.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator 0.11.0.0
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::ARM::Storage
+  module Models
+    #
+    # The CheckNameAvailability operation response.
+    #
+    class CheckNameAvailabilityResult
+
+      include MsRestAzure
+
+      # @return [Boolean] Gets a boolean value that indicates whether the name
+      # is available for you to use. If true, the name is available. If
+      # false, the name has already been taken or invalid and cannot be used.
+      attr_accessor :name_available
+
+      # @return [Reason] Gets the reason that a storage account name could not
+      # be used. The Reason element is only returned if NameAvailable is
+      # false. Possible values for this property include:
+      # 'AccountNameInvalid', 'AlreadyExists'.
+      attr_accessor :reason
+
+      # @return [String] Gets an error message explaining the Reason value in
+      # more detail.
+      attr_accessor :message
+
+      #
+      # Validate the object. Throws ValidationError if validation fails.
+      #
+      def validate
+      end
+
+      #
+      # Serializes given Model object into Ruby Hash.
+      # @param object Model object to serialize.
+      # @return [Hash] Serialized object in form of Ruby Hash.
+      #
+      def self.serialize_object(object)
+        object.validate
+        output_object = {}
+
+        serialized_property = object.name_available
+        output_object['nameAvailable'] = serialized_property unless serialized_property.nil?
+
+        serialized_property = object.reason
+        output_object['reason'] = serialized_property unless serialized_property.nil?
+
+        serialized_property = object.message
+        output_object['message'] = serialized_property unless serialized_property.nil?
+
+        output_object
+      end
+
+      #
+      # Deserializes given Ruby Hash into Model object.
+      # @param object [Hash] Ruby Hash object to deserialize.
+      # @return [CheckNameAvailabilityResult] Deserialized object.
+      #
+      def self.deserialize_object(object)
+        return if object.nil?
+        output_object = CheckNameAvailabilityResult.new
+
+        deserialized_property = object['nameAvailable']
+        output_object.name_available = deserialized_property
+
+        deserialized_property = object['reason']
+        if (!deserialized_property.nil? && !deserialized_property.empty?)
+          enum_is_valid = Reason.constants.any? { |e| Reason.const_get(e).to_s.downcase == deserialized_property.downcase }
+          fail MsRest::DeserializationError.new('Error occured while deserializing the enum', nil, nil, nil) unless enum_is_valid
+        end
+        output_object.reason = deserialized_property
+
+        deserialized_property = object['message']
+        output_object.message = deserialized_property
+
+        output_object.validate
+
+        output_object
+      end
+    end
+  end
+end

data/lib/azure_mgmt_storage/models/custom_domain.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator 0.11.0.0
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::ARM::Storage
+  module Models
+    #
+    # The custom domain assigned to this storage account. This can be set via
+    # Update.
+    #
+    class CustomDomain
+
+      include MsRestAzure
+
+      # @return [String] Gets or sets the custom domain name. Name is the
+      # CNAME source.
+      attr_accessor :name
+
+      # @return [Boolean] Indicates whether indirect CName validation is
+      # enabled. Default value is false. This should only be set on updates
+      attr_accessor :use_sub_domain
+
+      #
+      # Validate the object. Throws ValidationError if validation fails.
+      #
+      def validate
+        # Nothing to validate
+      end
+
+      #
+      # Serializes given Model object into Ruby Hash.
+      # @param object Model object to serialize.
+      # @return [Hash] Serialized object in form of Ruby Hash.
+      #
+      def self.serialize_object(object)
+        object.validate
+        output_object = {}
+
+        serialized_property = object.name
+        output_object['name'] = serialized_property unless serialized_property.nil?
+
+        serialized_property = object.use_sub_domain
+        output_object['useSubDomain'] = serialized_property unless serialized_property.nil?
+
+        output_object
+      end
+
+      #
+      # Deserializes given Ruby Hash into Model object.
+      # @param object [Hash] Ruby Hash object to deserialize.
+      # @return [CustomDomain] Deserialized object.
+      #
+      def self.deserialize_object(object)
+        return if object.nil?
+        output_object = CustomDomain.new
+
+        deserialized_property = object['name']
+        output_object.name = deserialized_property
+
+        deserialized_property = object['useSubDomain']
+        output_object.use_sub_domain = deserialized_property
+
+        output_object.validate
+
+        output_object
+      end
+    end
+  end
+end