azure-armrest 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb476a69524cfa20ac1f7c335d51769690c70bf
-  data.tar.gz: 7a510d8b6bde252f48c7093a5792b803e2f85c1e
+  metadata.gz: 39ae852a7c1d574a83dde09cd448745e2e881388
+  data.tar.gz: 48c5a7219743e3b5aea2c0ca8270c7a26d9c1be2
 SHA512:
-  metadata.gz: aef27b70c4520effac1e4749557f00ddda5e49d799d3465a134a073e68e99a991449bc4859bc2eda0a417f5c74e27f6e6edcf01fb786833f41130a3cec81a29a
-  data.tar.gz: 82350ce82f0663e53b5fe002274b662a0e6b009500c367ea2dec679e6d17f61e8b8f707257f05d996caa6651af9d681474e696c2a0889316b3cf61176fe50173
+  metadata.gz: b368e813ee681505fa2d3e5bf7d53fc86a14a410d72b00208645886e3b6c98c903d67ea5669ea96ef73dc574aa2c42ea349474eaee2e25cb482e16eb72e93884
+  data.tar.gz: 56abea12095d06f948eda3c6fae8bf778bede353ecdfa4df2d331d34b64e3a9b275c767bad45f7788b1c237edc44cafbd76aae837d0f881549a470c65fbd0cdf

data/CHANGES

@@ -1,3 +1,9 @@
+= 0.7.2 - 26-Apr-2017
+* Added the Storage::DiskService#get_blob_raw method. This is similar to the
+  StorageAccount#get_blob_raw method, but works for managed disks.
+* Added the :managed_disk?, :size (alias :flavor) and :operating_system
+  (alias :os) methods to the VirtualMachine model for convenience.
+
 = 0.7.1 - 11-Apr-2017
 * Fixed a bug in the BaseModel#to_json method. It now handles arrays of
   model objects properly.

data/lib/azure/armrest/model/base_model.rb

@@ -196,6 +196,8 @@ module Azure
       class Usage < BaseModel; end
     end
 
+    class ResponseBody < BaseModel; end
+
     class ResponseHeaders < BaseModel
       undef_method :response_headers
     end
@@ -261,3 +263,4 @@ module Azure
 end
 
 require_relative 'storage_account'
+require_relative 'virtual_machine'

data/lib/azure/armrest/model/virtual_machine.rb

@@ -0,0 +1,39 @@
+module Azure
+  module Armrest
+    class VirtualMachine < BaseModel
+      # Indicates whether the VM is backed by a managed disk or a regular
+      # storage account.
+      #
+      def managed_disk?
+        check_for_model_view('managed_disk?')
+        properties.storage_profile.os_disk.try(:managed_disk) ? true : false
+      end
+
+      # Returns the size (aka series) for the VM, e.g. "Standard_A0".
+      #
+      def size
+        check_for_model_view('size')
+        properties.hardware_profile.vm_size
+      end
+
+      alias flavor size
+
+      # The operating system for the image, e.g. "Linux" or "Windows".
+      #
+      def operating_system
+        check_for_model_view('operating_sytem')
+        properties.storage_profile.os_disk.os_type
+      end
+
+      alias os operating_system
+
+      private
+
+      def check_for_model_view(method_name)
+        unless respond_to?(:properties)
+          raise NoMethodError, "The method '#{method_name}' is only valid for model view objects."
+        end
+      end
+    end
+  end
+end

data/lib/azure/armrest/storage/disk_service.rb

@@ -11,6 +11,114 @@ module Azure
         def initialize(configuration, options = {})
           super(configuration, 'disks', 'Microsoft.Compute', options)
         end
+
+        # Get the raw blob information for a managed disk. This is similar to
+        # the StorageAccount#get_blob_raw method, but applies only to a managed
+        # disk, whereas that method applies only to an individual storage
+        # account.
+        #
+        # As with the Storage#get_blob_raw method, you should pass a :range,
+        # :start_byte, :end_byte or :length option. If you want the entire
+        # image you must pass the :entire_image option, though this is generally
+        # not recommended. Unlike the Storage#get_blob_raw method, this method
+        # does not support the :date parameter.
+        #
+        # The +options+ are as follows:
+        #
+        #   :range        => A range of bytes you want, e.g. 0..1023 to get first 1k bytes
+        #   :start_byte   => The starting byte number that you want to collect bytes for. Use
+        #                    this in conjunction with :length or :end_byte.
+        #   :end_byte     => The ending byte that you want to collect bytes for. Use this
+        #                    in conjunction with :start_byte.
+        #   :length       => If given a :start_byte, specifies the number of bytes from the
+        #                    the :start_byte that you wish to collect.
+        #   :entire_image => If set, returns the entire image in bytes. This will be a long
+        #                    running request that returns a large number of bytes.
+        #
+        # You may also pass a :duration parameter, which indicates how long, in
+        # seconds, that the privately generated SAS token should last. This token
+        # is used internally by requests that are used to access the requested
+        # information. By default it lasts for 1 hour.
+        #
+        # Get the information you need using:
+        #
+        # * response.body    - blob data (the raw bytes).
+        # * response.headers - blob metadata (a hash).
+        #
+        # Example:
+        #
+        #   vms = Azure::Armrest::VirtualMachineService.new(conf)
+        #   sds = Azure::Armrest::Storage::DiskService.new(conf)
+        #
+        #   vm = vms.get(vm_name, vm_resource_group)
+        #   os_disk = vm.properties.storage_profile.os_disk
+        #
+        #   disk_id = os_disk.managed_disk.id
+        #   disk = sds.get_by_id(disk_id)
+        #
+        #   # Get the first 1024 bytes
+        #   data = sds.get_blob_raw(disk.name, disk.resource_group, :range => 0..1023)
+        #
+        #   p data.headers
+        #   File.open('vm.vhd', 'a'){ |fh| fh.write(data.body) }
+        #
+        def get_blob_raw(disk_name, resource_group = configuration.resource_group, options = {})
+          validate_resource_group(resource_group)
+
+          post_options = {
+            :access            => 'read',                    # Must be 'read'
+            :durationInSeconds => options[:duration] || 3600 # 1 hour default
+          }
+
+          # This call will give us an operations URL in the headers.
+          initial_url = build_url(resource_group, disk_name, 'BeginGetAccess')
+          response = rest_post(initial_url, post_options.to_json)
+          headers = ResponseHeaders.new(response.headers)
+
+          # Using the URL returned from the above call, make another call that
+          # will return the URL + SAS token.
+          op_url = headers.try(:azure_asyncoperation) || headers.location
+
+          unless op_url
+            msg = "Unable to find an operations URL for #{disk_name}/#{resource_group}"
+            raise Azure::Armrest::NotFoundException.new(response.code, msg, response.body)
+          end
+
+          # Dig the URL + SAS token URL out of the response
+          response = rest_get(op_url)
+          body = ResponseBody.new(response.body)
+          sas_url = body.try(:properties).try(:output).try(:access_sas)
+
+          unless sas_url
+            msg = "Unable to find an SAS URL for #{disk_name}/#{resource_group}"
+            raise Azure::Armrest::NotFoundException.new(response.code, msg, response.body)
+          end
+
+          # The same restrictions that apply to the StorageAccont method also apply here.
+          range = options[:range] if options[:range]
+          range ||= options[:start_byte]..options[:end_byte] if options[:start_byte] && options[:end_byte]
+          range ||= options[:start_byte]..options[:length]-1 if options[:start_byte] && options[:length]
+
+          range_str = range ? "bytes=#{range.min}-#{range.max}" : nil
+
+          unless range_str || options[:entire_image]
+            raise ArgumentError, "must specify byte range or :entire_image flag"
+          end
+
+          headers = {}
+          headers['x-ms-range'] = range_str if range_str
+
+          # Need to make a raw call since we need to explicitly pass headers,
+          # but without encoding the URL or passing our configuration token.
+          RestClient::Request.execute(
+            :method      => :get,
+            :url         => sas_url,
+            :headers     => headers,
+            :proxy       => configuration.proxy,
+            :ssl_version => configuration.ssl_version,
+            :ssl_verify  => configuration.ssl_verify
+          )
+        end
       end # DiskService
     end # Storage
   end # Armrest

data/lib/azure/armrest/version.rb

@@ -1,6 +1,6 @@
 module Azure
   module Armrest
     # The version of the azure-armrest library.
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.7.2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -248,6 +248,7 @@ files:
 - lib/azure/armrest/insights/metrics_service.rb
 - lib/azure/armrest/model/base_model.rb
 - lib/azure/armrest/model/storage_account.rb
+- lib/azure/armrest/model/virtual_machine.rb
 - lib/azure/armrest/network/inbound_nat_service.rb
 - lib/azure/armrest/network/ip_address_service.rb
 - lib/azure/armrest/network/load_balancer_service.rb
@@ -298,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API