azure-armrest 0.0.3 → 0.0.4

data/lib/azure/armrest/storage_account_service.rb

@@ -1,7 +1,9 @@
+require 'azure-signature'
+
 module Azure
   module Armrest
     # Class for managing storage accounts.
-    class StorageAccountService < ArmrestService
+    class StorageAccountService < ResourceGroupBasedService
 
       # Valid account types for the create or update method.
       VALID_ACCOUNT_TYPES = %w[
@@ -18,86 +20,24 @@ module Azure
         @provider = options[:provider] || 'Microsoft.Storage'
         #set_service_api_version(options, 'storageAccounts')
         @api_version = '2015-05-01-preview' # Must hard code for now
+        @service_name = 'storageAccounts'
       end
 
-      # Return information for the given storage account name for the
-      # provided +group+. If no group is specified, it will use the
-      # group set in the constructor.
-      #
-      # If the +include_keys+ option is set to true, then the keys for that
-      # storage account will be included in the output as well.
-      #
-      # Example:
-      #
-      #   sas.get('portalvhds1234', 'Default-Storage-CentralUS')
-      #
-      def get(account_name, group = armrest_configuration.resource_group, include_keys = false)
-        raise ArgumentError, "must specify resource group" unless group
-
-        url = build_url(group, account_name)
-        results = JSON.parse(rest_get(url))
-        results['properties'].merge!(list_account_keys(account_name, group)) if include_keys
-
-        results
-      end
-
-      # Returns a list of available storage accounts for the given subscription
-      # for the provided +group+, or all resource groups if none is provided.
-      #
-      def list(group = nil)
-        if group
-          url = build_url(group)
-          JSON.parse(rest_get(url))['value']
-        else
-          array = []
-          threads = []
-          mutex = Mutex.new
-
-          resource_groups.each do |rg|
-            threads << Thread.new(rg['name']) do |group|
-              url = build_url(group)
-              response = rest_get(url)
-              results = JSON.parse(response)['value']
-              if results && !results.empty?
-                mutex.synchronize{
-                  results.each{ |hash| hash['resourceGroup'] = group }
-                  array << results
-                }
-              end
-            end
-          end
-
-          threads.each(&:join)
-
-          array.flatten
-        end
-      end
-
-      # List all storage accounts for the current subscription. This does not
-      # include storage account key information.
-      #
-      def list_all_for_subscription
-        sub_id = armrest_configuration.subscription_id
-        url = File.join(Azure::Armrest::COMMON_URI, sub_id, 'providers', @provider, 'storageAccounts')
-        url << "?api-version=#{@api_version}"
-        JSON.parse(rest_get(url))
-      end
-
-      alias list_all list_all_for_subscription
-
       # Creates a new storage account, or updates an existing account with the
-      # specified parameters. The possible parameters are:
+      # specified parameters.
       #
-      # - :name
-      #   Required. The name of the storage account within the specified
-      #   resource stack. Must be 3-24 alphanumeric lowercase characters.
+      # Note that the name of the storage account within the specified
+      # must be 3-24 alphanumeric lowercase characters.
+      #
+      # The options available are as follows:
       #
       # - :validating
       #   Optional. Set to 'nameAvailability' to indicate that the account
       #   name must be checked for global availability.
       #
-      # - :type
-      #   The type of storage account. The default is "Standard_GRS".
+      # - :properties
+      #   - :accountType
+      #     The type of storage account, e.g. "Standard_GRS".
       #
       # - :location
       #   Required: One of the Azure geo regions, e.g. 'West US'.
@@ -111,60 +51,28 @@ module Azure
       #
       #   sas = Azure::Armrest::StorageAccountService(config)
       #
-      #   sas.create(
-      #     :name     => "yourstorageaccount1",
-      #     :location => "West US",
-      #     :type     => "Standard_ZRS",
-      #     :tags     => {:YourCompany => true}
+      #   sas.create("yourstorageaccount1",
+      #     {
+      #       :location   => "West US",
+      #       :properties => {:accountType => "Standard_ZRS"},
+      #       :tags       => {:YourCompany => true}
+      #     },
+      #     "yourresourcegroup"
       #   )
       #
-      # For convenience you may also specify the :resource_group as an option.
-      #
-      def create(options = {}, rgroup = armrest_configuration.resource_group)
-        rgroup ||= options[:resource_group]
-        raise ArgumentError, "No resource group specified" if rgroup.nil?
-
-        # Mandatory options
-        name = options.fetch(:name)
-        location = options.fetch(:location)
-
-        # Optional
-        tags = options[:tags]
-        type = options[:type] || "Standard_GRS"
-
-        properties = {:accountType => type}
-
-        validate_account_type(type)
-        validate_account_name(name)
+      def create(account_name, rgroup = armrest_configuration.resource_group, options)
+        validating = options.delete(:validating)
+        validate_account_type(options[:properties][:accountType])
+        validate_account_name(account_name)
 
-        url = build_url(rgroup, name)
-        url << "&validating=" << options[:validating] if options[:validating]
-
-        body = {
-          :name       => name,
-          :location   => location,
-          :tags       => tags,
-          :properties => properties
-        }.to_json
-
-        response = rest_put(url, body)
-        response.return!
+        super(account_name, rgroup, options) do |url|
+          url << "&validating=" << validating if validating
+        end
       end
 
-      alias update create
-
-      # Delete the given storage account name.
-      #
-      def delete(account_name, group = armrest_configuration.resource_group)
-        raise ArgumentError, "must specify resource group" unless group
-
-        url = build_url(group, account_name)
-        response = rest_delete(url)
-        response.return!
-      end
 
       # Returns the primary and secondary access keys for the given
-      # storage account.
+      # storage account as a hash.
       #
       def list_account_keys(account_name, group = armrest_configuration.resource_group)
         raise ArgumentError, "must specify resource group" unless group
@@ -177,12 +85,17 @@ module Azure
       # Regenerates the primary and secondary access keys for the given
       # storage account.
       #
-      def regenerate_storage_account_keys(account_name)
+      # options have only one key with two possible values:
+      #   {
+      #     "keyName": "key1|key2"
+      #   }
+      #
+      def regenerate_storage_account_keys(account_name, group = armrest_configuration.resource_group, options)
         raise ArgumentError, "must specify resource group" unless group
 
         url = build_url(group, account_name, 'regenerateKey')
-        response = rest_post(url)
-        response.return!
+        response = rest_post(url, options.to_json)
+        JSON.parse(response)
       end
 
       private
@@ -198,23 +111,6 @@ module Azure
           raise ArgumentError, "name must be 3-24 alpha-numeric characters only"
         end
       end
-
-      # Builds a URL based on subscription_id an resource_group and any other
-      # arguments provided, and appends it with the api-version.
-      def build_url(resource_group, *args)
-        url = File.join(
-          Azure::Armrest::COMMON_URI,
-          armrest_configuration.subscription_id,
-          'resourceGroups',
-          resource_group,
-          'providers',
-          @provider,
-          'storageAccounts',
-        )
-
-        url = File.join(url, *args) unless args.empty?
-        url << "?api-version=#{@api_version}"
-      end
     end
   end
 end

data/lib/azure/armrest/template_deployment_service.rb

@@ -1,97 +1,44 @@
 module Azure::Armrest
-# Base class for managing templates and deployments
-class TemplateDeploymentService < ArmrestService
-
-  def initialize(_armrest_configuration, _options = {})
-    super
-
-    # has to be hard coded for now
-    set_service_api_version({'api_version' => '2014-04-01-preview'}, '')
-  end
-
-  # Get names of all deployments in a resource group
-  def list_names(resource_group = armrest_configuration.resource_group)
-    list(resource_group).map {|e| e['name']}
-  end
-
-  # Get all deployments in a resource group
-  # If the resource group is nil, then return deployments in all groups
-  def list(resource_group = armrest_configuration.resource_group)
-    if resource_group
-      url = build_deployment_url(resource_group)
-      JSON.parse(rest_get(url))['value']
-    else
-      threads = []
-      array = []
-      mutex = Mutex.new
-
-      resource_groups.each do |rg|
-        threads << Thread.new(rg['name']) do |group|
-          url = build_deployment_url(group)
-          results = JSON.parse(rest_get(url))['value']
-          if results && !results.empty?
-            mutex.synchronize {
-              results.each { |hash| hash['resourceGroup'] = group }
-              array << results
-            }
-          end
-        end
-      end
-
-      threads.each(&:join)
-      array.flatten
+  # Base class for managing templates and deployments
+  class TemplateDeploymentService < ResourceGroupBasedService
+
+    def initialize(_armrest_configuration, options = {})
+      super
+      @provider = options[:provider] || 'Microsoft.Resources'
+      # Has to be hard coded for now
+      set_service_api_version({'api_version' => '2014-04-01-preview'}, '')
+      @service_name = 'deployments'
     end
-  end
-
-  # Get the deployment in a resource group
-  def get(deploy_name, resource_group = armrest_configuration.resource_group)
-    url = build_deployment_url(resource_group, deploy_name)
-    JSON.parse(rest_get(url))
-  end
 
-  # Get all operations of a deployment in a resource group
-  def list_deployment_operations(deploy_name, resource_group = armrest_configuration.resource_group)
-    url = build_deployment_url(resource_group, deploy_name, 'operations')
-    JSON.parse(rest_get(url))['value']
-  end
-
-  # Get the operation of a deployment in a resource group
-  def get_deployment_operation(deploy_name, op_id, resource_group = armrest_configuration.resource_group)
-    url = build_deployment_url(resource_group, deploy_name, 'operations', op_id)
-    JSON.parse(rest_get(url))
-  end
-
-  # Create a template deployment
-  # The template and parameters should be provided through the options hash
-  def create(deploy_name, options, resource_group = armrest_configuration.resource_group)
-    url = build_deployment_url(resource_group, deploy_name)
-    body = options.has_key?('properties') ? options.to_json : {'properties' => options}.to_json
-    JSON.parse(rest_put(url, body))
-  end
+    # Get names of all deployments in a resource group
+    def list_names(resource_group = armrest_configuration.resource_group)
+      list(resource_group).map(&:name)
+    end
 
-  # Delete a deployment
-  def delete(deploy_name, resource_group = armrest_configuration.resource_group)
-    url = build_deployment_url(resource_group, deploy_name)
-    rest_delete(url)
-  end
+    # Get all deployments for the current subscription
+    def list_all
+      list_in_all_groups
+    end
 
-  private
+    # Get all operations of a deployment in a resource group
+    def list_deployment_operations(deploy_name, resource_group = armrest_configuration.resource_group)
+      raise ArgumentError, "must specify resource group" unless resource_group
+      raise ArgumentError, "must specify name of the resource" unless deploy_name
 
+      url = build_url(resource_group, deploy_name, 'operations')
+      response = rest_get(url)
+      JSON.parse(response)['value'].map{ |hash| TemplateDeploymentOperation.new(hash) }
+    end
 
-  # Builds a URL based on subscription_id an resource_group and any other
-  # arguments provided, and appends it with the api_version.
-  #
-  def build_deployment_url(resource_group, *args)
-    url = File.join(
-      Azure::Armrest::COMMON_URI,
-      armrest_configuration.subscription_id,
-      'resourceGroups',
-      resource_group,
-      'deployments',
-    )
+    # Get the operation of a deployment in a resource group
+    def get_deployment_operation(op_id, deploy_name, resource_group = armrest_configuration.resource_group)
+      raise ArgumentError, "must specify resource group" unless resource_group
+      raise ArgumentError, "must specify name of the resource" unless deploy_name
+      raise ArgumentError, "must specify operation id" unless op_id
 
-    url = File.join(url, *args) unless args.empty?
-    url << "?api-version=#{@api_version}"
+      url = build_url(resource_group, deploy_name, 'operations', op_id)
+      response = rest_get(url)
+      TemplateDeploymentOperation.new(response)
+    end
   end
 end
-end

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/azure/armrest/virtual_machine_extension_service.rb

@@ -5,58 +5,132 @@ module Azure
     # Base class for managing virtual machine extensions
     class VirtualMachineExtensionService < VirtualMachineService
 
-      def initialize(_armrest_configuration, _options = {})
+      # Creates and returns a new VirtualMachineExtensionService object.
+      #
+      def initialize(_armrest_configuration, options = {})
         super
+        @provider = options[:provider] || 'Microsoft.Compute'
+        set_service_api_version(options, 'virtualMachines/extensions')
       end
 
-      # Creates a new virtual machine extension for +vmname+ with the given
-      # +extension_name+, and the given +options+. Possible options are:
+      # Creates a new extension for the provided VM with the given +options+.
+      # The possible options are:
+      #
+      # - :location - The location for the extension. Mandatory.
+      # - :type - The type of compute resource. The default is "Microsoft.Compute/virtualMachines/extensions".
+      # - :tags - A list of key value pairs. Max 10 pairs. Optional.
+      # - :properties
+      #   - :type - The type of extension. Required.
+      #   - :publisher - Name of extension publisher. Default is the provider.
+      #   - :typeHandlerVersion - Optional. Specifies the extension version. Default is "1.*".
+      #   - :settings - Public configuration that does not require encryption. Optional.
+      #     - :fileUris - The script file path.
+      #     - :commandToExecute - The command used to execute the script.
       #
-      #   :tags - Optional. A list of key value pairs. Max 10 pairs.
-      #   :publisher - Required. Name of extension publisher.
-      #   :type - Required. The type of extension.
-      #   :type_handler_version - Required. Specifies the extension version.
-      #   :settings - Optional. Public configuration that does not require encryption.
-      #   :protected_settings - Optional. Private configuration that is encrypted.
+      # For convenience, you may also specify a :resource_group as an option.
       #
-      def create(vmname, extension_name, options = {})
-        #publisher = options.fetch(:publisher)
-        #type = options.fetch(:type)
-        #type_handler_version = options.fetch(:type_handler_version)
+      def create(vm_name, ext_name, options = {}, rgroup = nil)
+        rgroup ||= options.delete(:resource_group) || armrest_configuration.resource_group
+
+        raise ArgumentError, "no resource group provided" unless rgroup
 
-        url = @uri + "/#{vmname}/extensions/#{extension_name}?#{@api_version}"
-        url
+        # Optional params with defaults
+        options[:type] ||= "Microsoft.Compute/virtualMachines/extensions"
+        options[:name] ||= ext_name
+        options[:properties][:publisher] ||= @provider
+        options[:properties][:typeHandlerVersion] ||= "1.*"
+
+        url = build_url(rgroup, vm_name, ext_name)
+        body = options.to_json
+
+        response = rest_put(url, body)
+        response.return!
       end
 
       alias update create
 
-      # Delete the given +extension_name+ for +vmname+.
-      #--
-      # DELETE
+      # Delete the given extension for the provided VM and resource group.
       #
-      def delete(vmname, extension_name)
-        url = @uri + "/#{vmname}/extensions/#{extension_name}?#{@api_version}"
-        url
+      def delete(vm_name, ext_name, rgroup = armrest_configuration.resource_group)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        url = build_url(rgroup, vm_name, ext_name)
+        response = rest_delete(url)
+        response.return!
+      end
+
+      # Retrieves the settings of an extension for the provided VM.
+      # If the +instance_view+ option is true, it will retrieve instance
+      # view information instead.
+      #
+      def get(vm_name, ext_name, rgroup = armrest_configuration.resource_group, instance_view = false)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        url = build_url(rgroup, vm_name, ext_name)
+        url << "&expand=instanceView" if instance_view
+        response = rest_get(url)
+        Azure::Armrest::VirtualMachineExtension.new(response)
+      end
+
+      # Shortcut to get an extension in model view.
+      def get_model_view(vm_name, ext_name, rgroup = armrest_configuration.resource_group)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        get(vm_name, ext_name, rgroup, false)
       end
 
-      # Retrieves the settings of an extension. If the +instance_view+ option
-      # is true, it will retrieve instance view information instead.
+      # Shortcut to get an extension in instance view.
+      def get_instance_view(vm_name, ext_name, rgroup = armrest_configuration.resource_group)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        get(vm_name, ext_name, rgroup, true)
+      end
+
+      # Retrieves a list of extensions on the VM in the provided resource group.
+      # If the +instance_view+ option is true, it will retrieve a list of instance
+      # view information instead.
+      #
+      # NOTE: As of August 2015, this is not currently supported because the
+      # MS SDK does not support it.
       #--
-      # GET
+      # BUG: https://github.com/Azure/azure-xplat-cli/issues/1826
       #
-      def get(vmname, instance_view = false)
-        url = @uri + "/#{vmname}/extensions/#{extension_name}?"
-        url += "$expand=instanceView," if instance_view
-        url += "#{@api_version}"
-        url
+      def list(vm_name, rgroup = armrest_configuration.resource_group, instance_view = false)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        url = build_url(rgroup, vm_name)
+        url << "&expand=instanceView" if instance_view
+        response = rest_get(url)
+        JSON.parse(response)['value'].map{ |hash| Azure::Armrest::VirtualMachineExtension.new(hash) }
+      end
+
+      # Shortcut to get a list in model view.
+      def list_model_view(vmname, rgroup = armrest_configuration.resource_group)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        list(vmname, false, rgroup)
       end
 
-      # Retrieves a list of extensions on the VM.
-      def list(vmname, instance_view = false)
-        url = @uri + "/#{vmname}/extensions"
-        url += "$expand=instanceView," if instance_view
-        url += "#{@api_version}"
-        url
+      # Shortcut to get a list in instance view.
+      def list_instance_view(vmname, rgroup = armrest_configuration.resource_group)
+        raise ArgumentError, "no resource group provided" unless rgroup
+        list(vmname, true, rgroup)
+      end
+
+      private
+
+      # Builds a URL based on subscription_id an resource_group and any other
+      # arguments provided, and appends it with the api_version.
+      #
+      def build_url(resource_group, vm, *args)
+        url = File.join(
+          Azure::Armrest::COMMON_URI,
+          armrest_configuration.subscription_id,
+          'resourceGroups',
+          resource_group,
+          'providers',
+          @provider,
+          'virtualMachines',
+          vm,
+          'extensions'
+        )
+
+        url = File.join(url, *args) unless args.empty?
+        url << "?api-version=#{@api_version}"
       end
     end
   end