azure_mgmt_storage2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9653e8d8268ed66854eef804b640ed9a4502d6fa8319b6b71d49944c0d317fce
+  data.tar.gz: 8554e4822b5266386c40d06ad621266a146a0a8b17c7619f845f35ecae31cc03
+SHA512:
+  metadata.gz: 1aea25de00270e98c7008a9f3bfec597580f53138eb61476207a9b6f6a5bf6bc4c3bca402386a3bfa602ca957a5b17bfa9c2dbc3b8e942e3b991adac54601471
+  data.tar.gz: b0d81c4f6849e4bc6ca6d837f8a2123369451f4576148db88bd1d565ef451983c5e9b0d3d04c6deb9c1aab1883a8e2a384435a96e1195eb57bd47eab346993c6

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,118 @@
+# 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_storage2
+```
+
+and reference it in your code:
+
+```Ruby
+require 'azure_mgmt_storage2'
+```
+
+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.
+
+```ruby
+# Include SDK modules to ease access to Storage classes.
+include Azure::Storage2::Profiles::Latest::Mgmt
+include Azure::Storage2::Profiles::Latest::Mgmt::Models
+
+provider = MsRestAzure2::ApplicationTokenProvider.new(
+       'YOUR TENANT ID',
+       'YOUR CLIENT ID',
+       'YOUR CLIENT SECRET')
+credentials = MsRest2::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.
+
+```ruby
+# Include SDK modules to ease access to resources classes.
+include Azure::Storage2::Mgmt::V2017_06_01
+include Azure::Storage2::Mgmt::V2017_06_01::Models
+
+# Note: The tenant_id, client_id, client_secret and subscription_id
+# must be set using the env variables.
+
+provider = MsRestAzure2::ApplicationTokenProvider.new(
+       ENV['AZURE_TENANT_ID'],
+       ENV['AZURE_CLIENT_ID'],
+       ENV['AZURE_CLIENT_SECRET'])
+credentials = MsRest2::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.
+
+```ruby
+# 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::Storage2
+
+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:
+
+```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 MsRestAzure2::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.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.

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/account_status.rb

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

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/account_type.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  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/2015-05-01-preview/generated/azure_mgmt_storage2/models/check_name_availability_result.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # The CheckNameAvailability operation response.
+    #
+    class CheckNameAvailabilityResult
+
+      include MsRestAzure2
+
+      # @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 include: 'AccountNameInvalid', 'AlreadyExists'
+      attr_accessor :reason
+
+      # @return [String] Gets an error message explaining the Reason value in
+      # more detail.
+      attr_accessor :message
+
+
+      #
+      # Mapper for CheckNameAvailabilityResult class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'CheckNameAvailabilityResult',
+          type: {
+            name: 'Composite',
+            class_name: 'CheckNameAvailabilityResult',
+            model_properties: {
+              name_available: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'nameAvailable',
+                type: {
+                  name: 'Boolean'
+                }
+              },
+              reason: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'reason',
+                type: {
+                  name: 'Enum',
+                  module: 'Reason'
+                }
+              },
+              message: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'message',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/custom_domain.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # The custom domain assigned to this storage account. This can be set via
+    # Update.
+    #
+    class CustomDomain
+
+      include MsRestAzure2
+
+      # @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_name
+
+
+      #
+      # Mapper for CustomDomain class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'CustomDomain',
+          type: {
+            name: 'Composite',
+            class_name: 'CustomDomain',
+            model_properties: {
+              name: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              use_sub_domain_name: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'useSubDomainName',
+                type: {
+                  name: 'Boolean'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/endpoints.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # The URIs that are used to perform a retrieval of a public blob, queue or
+    # table object.
+    #
+    class Endpoints
+
+      include MsRestAzure2
+
+      # @return [String] Gets the blob endpoint.
+      attr_accessor :blob
+
+      # @return [String] Gets the queue endpoint.
+      attr_accessor :queue
+
+      # @return [String] Gets the table endpoint.
+      attr_accessor :table
+
+
+      #
+      # Mapper for Endpoints class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Endpoints',
+          type: {
+            name: 'Composite',
+            class_name: 'Endpoints',
+            model_properties: {
+              blob: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'blob',
+                type: {
+                  name: 'String'
+                }
+              },
+              queue: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'queue',
+                type: {
+                  name: 'String'
+                }
+              },
+              table: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'table',
+                type: {
+                  name: 'String'
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/key_name.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # Defines values for KeyName
+    #
+    module KeyName
+      Key1 = "key1"
+      Key2 = "key2"
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/provisioning_state.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # Defines values for ProvisioningState
+    #
+    module ProvisioningState
+      Creating = "Creating"
+      ResolvingDNS = "ResolvingDNS"
+      Succeeded = "Succeeded"
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/reason.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # Defines values for Reason
+    #
+    module Reason
+      AccountNameInvalid = "AccountNameInvalid"
+      AlreadyExists = "AlreadyExists"
+    end
+  end
+end

data/lib/2015-05-01-preview/generated/azure_mgmt_storage2/models/resource.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Azure::Storage2::Mgmt::V2015_05_01_preview
+  module Models
+    #
+    # Model object.
+    #
+    #
+    class Resource
+
+      include MsRestAzure2
+
+      # @return [String] Resource Id
+      attr_accessor :id
+
+      # @return [String] Resource name
+      attr_accessor :name
+
+      # @return [String] Resource type
+      attr_accessor :type
+
+      # @return [String] Resource location
+      attr_accessor :location
+
+      # @return [Hash{String => String}] Resource tags
+      attr_accessor :tags
+
+
+      # @return [String] the name of the resource group of the resource.
+      def resource_group
+        unless self.id.nil?
+          groups = self.id.match(/.+\/resourceGroups\/([^\/]+)\/.+/)
+          groups.captures[0].strip if groups
+        end
+      end
+
+
+      #
+      # Mapper for Resource class as Ruby Hash.
+      # This will be used for serialization/deserialization.
+      #
+      def self.mapper()
+        {
+          client_side_validation: true,
+          required: false,
+          serialized_name: 'Resource',
+          type: {
+            name: 'Composite',
+            class_name: 'Resource',
+            model_properties: {
+              id: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'id',
+                type: {
+                  name: 'String'
+                }
+              },
+              name: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'name',
+                type: {
+                  name: 'String'
+                }
+              },
+              type: {
+                client_side_validation: true,
+                required: false,
+                read_only: true,
+                serialized_name: 'type',
+                type: {
+                  name: 'String'
+                }
+              },
+              location: {
+                client_side_validation: true,
+                required: true,
+                serialized_name: 'location',
+                type: {
+                  name: 'String'
+                }
+              },
+              tags: {
+                client_side_validation: true,
+                required: false,
+                serialized_name: 'tags',
+                type: {
+                  name: 'Dictionary',
+                  value: {
+                      client_side_validation: true,
+                      required: false,
+                      serialized_name: 'StringElementType',
+                      type: {
+                        name: 'String'
+                      }
+                  }
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end