azure-armrest 0.3.11 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 374a82fa5abab25e86c1d55475f91cbcd51f0606
-  data.tar.gz: 8fb3f44d22dbe3f8d4697c74205d671e04c7be96
+  metadata.gz: 5022f64bbe2cfc12d269a9b1ef34eda423076aff
+  data.tar.gz: 86f456d2c2e7eb2724599da6d2239f3dc1839e7b
 SHA512:
-  metadata.gz: 67130daca26bbfc9b629dd256f65a92412eaebe7b59a832a4f80b032ae0622052c4979640631458609fb466aac204e1f0f678184d5ed13e2e45a69085b885b9d
-  data.tar.gz: 2539f429201b3d24ad4703bab06b4e7112125dba85aa29a047ab6c1d0843a9a13eaf2ff229b9850ff34695d6b7412c694d3d63bf36d2f493dcff7c4b7ccada96
+  metadata.gz: 516af488cfffe832df8e468c19201ab59253130023d0eddc1c0bba2dbe6ddb269b51ff781f5218c6090a37450d8d057f5ccf0083b737941c2830e67988a32f2b
+  data.tar.gz: 2ef615e16a7809c5418becdcf17439c9303a3f05119c2a26925319ba16194f028e7599537fb4c940b6a29d0b3833e24a89e05d2aff67fb09f11ae58c978fd16e

data/CHANGES

@@ -1,3 +1,12 @@
+= 0.3.12 - 15-Nov-2016
+* Added the Insights::DiagnosticService class.
+* Added the get_from_vm and get_os_disk methods to StorageAccountService.
+* Added the delete_associated_resources method to VirtualMachineService.
+* The output of StorageAccount#blob_properties method now includes the blob
+  name and the container name.
+* Added a service_name accessor to the ArmrestService base class.
+* The list_all method in StorageAccountService now supports a filter.
+
 = 0.3.11 - 8-Nov-2016
 * Fixed the regex for the internal method parse_id_string, making the
   get_associated_resource method more robust.

data/lib/azure/armrest.rb

@@ -39,6 +39,7 @@ require 'azure/armrest/resource_service'
 require 'azure/armrest/resource_group_service'
 require 'azure/armrest/resource_provider_service'
 require 'azure/armrest/insights/alert_service'
+require 'azure/armrest/insights/diagnostic_service'
 require 'azure/armrest/insights/event_service'
 require 'azure/armrest/insights/metrics_service'
 require 'azure/armrest/network/load_balancer_service'

data/lib/azure/armrest/armrest_service.rb

@@ -18,6 +18,9 @@ module Azure
       # Provider for service specific API calls
       attr_accessor :provider
 
+      # The service name for the Service class
+      attr_accessor :service_name
+
       # The api-version string for this particular service
       attr_accessor :api_version
 

data/lib/azure/armrest/insights/diagnostic_service.rb

@@ -0,0 +1,96 @@
+module Azure
+  module Armrest
+    module Insights
+      # Base class for managing diagnostics
+      class DiagnosticService < ArmrestService
+        def initialize(armrest_configuration, options = {})
+          super(armrest_configuration, 'diagnosticSettings', 'Microsoft.Insights', options)
+        end
+
+        # Get diagnostic information for the given +resource_id+. Note that
+        # this information is only available for a limited subset of resources.
+        #
+        # Example:
+        #
+        # ids = Azure::Armrest::Insights::DiagnosticService.new(config)
+        # nsg = Azure::Armrest::Network::NetworkSecurityGroupService.new(config)
+        #
+        # sgrp = nsg.get(your_security_group, your_resource_group)
+        # p ids.get(sgrp.id)
+        #
+        def get(resource_id)
+          url = build_url(resource_id)
+          response = rest_get(url)
+          Diagnostic.new(JSON.parse(response))
+        end
+
+        # Create or update a diagnostic setting for the given +resource_id+.
+        #
+        # Example:
+        #
+        # # Update network security group log settings
+        # ids = Azure::Armrest::Insights::DiagnosticService.new(config)
+        # sas = Azure::Armrest::StorageAccountService.new(config)
+        # nsg = Azure::Armrest::Network::NetworkSecurityGroupService.new(config)
+        #
+        # acct = sas.get(your_storage, your_resource_group)
+        # sgrp = nsg.get(your_network_security_group, your_resource_group)
+        #
+        # options = {
+        #   :properties => {
+        #     :storageAccountId => acct.id,
+        #     :logs => [
+        #       {
+        #         :category => "NetworkSecurityGroupEvent",
+        #         :enabled  => true,
+        #         :retentionPolicy => {
+        #           :enabled => true,
+        #           :days    => 3
+        #         }
+        #       },
+        #       {
+        #         :category => "NetworkSecurityGroupRuleCounter",
+        #         :enabled  => true,
+        #         :retentionPolicy => {
+        #           :enabled => true,
+        #           :days    => 3
+        #         }
+        #       }
+        #     ]
+        #   }
+        # }
+        #
+        # ids.set(sgrp.id, options)
+        #
+        def create(resource_id, options = {})
+          url = build_url(resource_id)
+          body = options.merge(:id => resource_id).to_json
+          response = rest_put(url, body)
+
+          headers = Azure::Armrest::ResponseHeaders.new(response.headers)
+          headers.response_code = response.code
+
+          headers
+        end
+
+        alias update create
+        alias set create
+
+        private
+
+        def build_url(resource_id)
+          url = File.join(
+            Azure::Armrest::RESOURCE,
+            resource_id,
+            'providers',
+            provider,
+            'diagnosticSettings',
+            'service'
+          )
+
+          url + "?api-version=#{api_version}"
+        end
+      end
+    end
+  end
+end

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

@@ -218,6 +218,7 @@ module Azure
 
     module Insights
       class Alert < BaseModel; end
+      class Diagnostic < BaseModel; end
       class Event < BaseModel; end
       class Metric < BaseModel; end
     end

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

@@ -214,7 +214,7 @@ module Azure
           :ssl_verify  => ssl_verify
         )
 
-        BlobProperty.new(response.headers)
+        BlobProperty.new(response.headers.merge(:container => container, :name => blob))
       end
 
       # Return a list of blobs for the given +container+ using the given +key+

data/lib/azure/armrest/storage_account_service.rb

@@ -32,8 +32,8 @@ module Azure
 
       # Same as other resource based list_all methods, but also sets the proxy on each model object.
       #
-      def list_all
-        super.each do |m|
+      def list_all(filter = {})
+        super(filter).each do |m|
           m.proxy       = configuration.proxy
           m.ssl_version = configuration.ssl_version
           m.ssl_verify  = configuration.ssl_verify
@@ -203,6 +203,43 @@ module Azure
         get_private_images(storage_accounts)
       end
 
+      # Return the storage account for the virtual machine model +vm+.
+      #
+      def get_from_vm(vm)
+        uri = Addressable::URI.parse(vm.properties.storage_profile.os_disk.vhd.uri)
+
+        # The uri looks like https://foo123.blob.core.windows.net/vhds/something123.vhd
+        name = uri.host.split('.').first # storage name, e.g. 'foo123'
+
+        # Look for the storage account in the VM's resource group first. If
+        # it's not found, look through all the storage accounts.
+        begin
+          acct = get(name, vm.resource_group)
+        rescue Azure::Armrest::NotFoundException => err
+          acct = list_all(:name => name).first
+          raise err unless acct
+        end
+
+        acct
+      end
+
+      # Get information for the underlying VHD file based on the properties
+      # of the virtual machine model +vm+.
+      #
+      def get_os_disk(vm)
+        uri = Addressable::URI.parse(vm.properties.storage_profile.os_disk.vhd.uri)
+
+        # The uri looks like https://foo123.blob.core.windows.net/vhds/something123.vhd
+        disk = File.basename(uri.to_s)       # disk name, e.g. 'something123.vhd'
+        path = File.dirname(uri.path)[1..-1] # container, e.g. 'vhds'
+
+        acct = get_from_vm(vm)
+        keys = list_account_keys(acct.name, acct.resource_group)
+        key  = keys['key1'] || keys['key2']
+
+        acct.blob_properties(path, disk, key)
+      end
+
       def accounts_by_name
         @accounts_by_name ||= list_all.each_with_object({}) { |sa, sah| sah[sa.name] = sa }
       end

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = '0.3.11'.freeze
+    VERSION = '0.3.12'.freeze
   end
 end

data/lib/azure/armrest/virtual_machine_service.rb

@@ -121,12 +121,173 @@ module Azure
         vm_operate('powerOff', vmname, group)
       end
 
+      # Delete the VM and associated resources. By default, this will
+      # delete the VM, its NIC, the associated IP address, and the
+      # image files (.vhd and .status) for the VM.
+      #
+      # If you want to delete other associated resources, such as any
+      # attached disks, the VM's underlying storage account, or associated
+      # network security groups you must explicitly specify them as an option.
+      #
+      # An attempt to delete a resource that cannot be deleted because it's
+      # still associated with some other resource will be logged and skipped.
+      #
+      # If the :verbose option is set to true, then additional messages are
+      # sent to your configuration log, or stdout if no log was specified.
+      #
+      # Note that if all of your related resources are in a self-contained
+      # resource group, you do not necessarily need this method. You could
+      # just delete the resource group itself, which would automatically
+      # delete all of its resources.
+      #
+      def delete_associated_resources(vmname, vmgroup, options = {})
+        options = {
+          :network_interfaces      => true,
+          :ip_addresses            => true,
+          :os_disk                 => true,
+          :network_security_groups => false,
+          :storage_account         => false,
+          :verbose                 => false
+        }.merge(options)
+
+        Azure::Armrest::Configuration.log ||= STDOUT if options[:verbose]
+
+        vm = get(vmname, vmgroup)
+
+        delete_and_wait(self, vmname, vmgroup, options)
+
+        # Must delete network interfaces first if you want to delete
+        # IP addresses or network security groups.
+        if options[:network_interfaces] || options[:ip_addresses] || options[:network_security_groups]
+          delete_associated_nics(vm, options)
+        end
+
+        if options[:os_disk] || options[:storage_account]
+          delete_associated_disk(vm, options)
+        end
+      end
+
       def model_class
         VirtualMachineModel
       end
 
       private
 
+      # Deletes any NIC's associated with the VM, and optionally any public IP addresses
+      # and network security groups.
+      #
+      def delete_associated_nics(vm, options)
+        nis = Azure::Armrest::Network::NetworkInterfaceService.new(configuration)
+        nics = vm.properties.network_profile.network_interfaces.map(&:id)
+
+        if options[:ip_addresses]
+          ips = Azure::Armrest::Network::IpAddressService.new(configuration)
+        end
+
+        if options[:network_security_groups]
+          nsgs = Azure::Armrest::Network::NetworkSecurityGroupService.new(configuration)
+        end
+
+        nics.each do |nic_id_string|
+          nic = get_associated_resource(nic_id_string)
+          delete_and_wait(nis, nic.name, nic.resource_group, options)
+
+          if options[:ip_addresses]
+            nic.properties.ip_configurations.each do |ip|
+              ip = get_associated_resource(ip.properties.public_ip_address.id)
+              delete_and_wait(ips, ip.name, ip.resource_group, options)
+            end
+          end
+
+          if options[:network_security_groups]
+            nic.properties.network_security_group
+            nsg = get_associated_resource(nic.properties.network_security_group.id)
+            delete_and_wait(nsgs, nsg.name, nsg.resource_group, options)
+          end
+        end
+      end
+
+      # This deletes the OS disk from the storage account that's backing the
+      # virtual machine, along with the .status file. This does NOT delete
+      # copies of the disk.
+      #
+      # If the option to delete the entire storage account was selected, then
+      # it will not bother with deleting invidual files from the storage
+      # account first.
+      #
+      def delete_associated_disk(vm, options)
+        sas = Azure::Armrest::StorageAccountService.new(configuration)
+
+        storage_account = sas.get_from_vm(vm)
+
+        # Deleting the storage account does not require deleting the disks
+        # first, so skip that if deletion of the storage account was requested.
+        if options[:storage_account]
+          delete_and_wait(sas, storage_account.name, storage_account.resource_group, options)
+        else
+          keys = sas.list_account_keys(storage_account.name, storage_account.resource_group)
+          key  = keys['key1'] || keys['key2']
+          disk = sas.get_os_disk(vm)
+
+          # There's a short delay between deleting the VM and unlocking the underlying
+          # .vhd file by Azure. Therefore we sleep up to two minutes while checking.
+          if disk.x_ms_lease_status.casecmp('unlocked') != 0
+            sleep_time = 0
+
+            while sleep_time < 120
+              sleep 10
+              sleep_time += 10
+              disk = sas.get_os_disk(vm)
+              break if disk.x_ms_lease_status.casecmp('unlocked') != 0
+            end
+
+            # In the unlikely event it did not unlock, just log and skip.
+            if disk.x_ms_lease_status.casecmp('unlocked') != 0
+              log_message("Unable to delete disk #{disk.container}/#{disk.name}", 'warn')
+              return
+            end
+          end
+
+          storage_account.delete_blob(disk.container, disk.name, key)
+          log_message("Deleted blob #{disk.container}/#{disk.name}") if options[:verbose]
+
+          begin
+            status_file = File.basename(disk.name, '.vhd') + '.status'
+            storage_account.delete_blob(disk.container, status_file, key)
+          rescue Azure::Armrest::NotFoundException
+            # Ignore, does not always exist.
+          else
+            log_message("Deleted blob #{disk.container}/#{status_file}") if options[:verbose]
+          end
+        end
+      end
+
+      # Delete a +service+ type resource using its name and resource group,
+      # and wait for the operation to complete before returning.
+      #
+      # If the operation fails because a dependent resource is still attached,
+      # then the error is logged (in verbose mode) and ignored.
+      #
+      def delete_and_wait(service, name, group, options)
+        resource_type = service.class.to_s.sub('Service', '').split('::').last
+
+        log_message("Deleting #{resource_type} #{name}/#{group}") if options[:verbose]
+
+        headers = service.delete(name, group)
+
+        loop do
+          status = wait(headers)
+          break if status.downcase.start_with?('succ') # Succeeded, Success, etc.
+        end
+
+        log_message("Deleted #{resource_type} #{name}/#{group}") if options[:verbose]
+      rescue Azure::Armrest::BadRequestException, Azure::Armrest::PreconditionFailedException => err
+        if options[:verbose]
+          msg = "Unable to delete #{resource_type} #{name}/#{group}, skipping. Message: #{err.message}"
+          log_message(msg, 'warn')
+        end
+      end
+
       def vm_operate(action, vmname, group, options = {})
         raise ArgumentError, "must specify resource group" unless group
         raise ArgumentError, "must specify name of the vm" unless vmname
@@ -135,6 +296,15 @@ module Azure
         rest_post(url)
         nil
       end
+
+      # Simple log messager. Use the Configuration.log if defined.
+      def log_message(msg, level = 'info')
+        if Azure::Armrest::Configuration.log
+          Azure::Armrest::Configuration.log.send(level.to_sym, msg)
+        else
+          warn msg
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -240,6 +240,7 @@ files:
 - lib/azure/armrest/configuration.rb
 - lib/azure/armrest/exception.rb
 - lib/azure/armrest/insights/alert_service.rb
+- lib/azure/armrest/insights/diagnostic_service.rb
 - lib/azure/armrest/insights/event_service.rb
 - lib/azure/armrest/insights/metrics_service.rb
 - lib/azure/armrest/model/base_model.rb