class Azure::Compute::Mgmt::V2020_12_01::VirtualMachineImages
Compute
Client
Attributes
@return [ComputeManagementClient] reference to the ComputeManagementClient
Private Class Methods
Creates and initializes a new instance of the VirtualMachineImages
class. @param client service class for accessing basic functionality.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 17 def initialize(client) @client = client end
Private Instance Methods
Gets a virtual machine image.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param version [String] A valid image SKU version. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [VirtualMachineImage] operation results.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 37 def get(location, publisher_name, offer, skus, version, custom_headers:nil) response = get_async(location, publisher_name, offer, skus, version, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a virtual machine image.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param version [String] A valid image SKU version. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 72 def get_async(location, publisher_name, offer, skus, version, custom_headers:nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, 'publisher_name is nil' if publisher_name.nil? fail ArgumentError, 'offer is nil' if offer.nil? fail ArgumentError, 'skus is nil' if skus.nil? fail ArgumentError, 'version is nil' if version.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'location' => location,'publisherName' => publisher_name,'offer' => offer,'skus' => skus,'version' => version,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Compute::Mgmt::V2020_12_01::Models::VirtualMachineImage.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets a virtual machine image.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param version [String] A valid image SKU version. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 55 def get_with_http_info(location, publisher_name, offer, skus, version, custom_headers:nil) get_async(location, publisher_name, offer, skus, version, custom_headers:custom_headers).value! end
Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param expand [String] The expand expression to apply on the operation. @param top [Integer] @param orderby [String] @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array] operation results.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 146 def list(location, publisher_name, offer, skus, expand:nil, top:nil, orderby:nil, custom_headers:nil) response = list_async(location, publisher_name, offer, skus, expand:expand, top:top, orderby:orderby, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param expand [String] The expand expression to apply on the operation. @param top [Integer] @param orderby [String] @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 187 def list_async(location, publisher_name, offer, skus, expand:nil, top:nil, orderby:nil, custom_headers:nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, 'publisher_name is nil' if publisher_name.nil? fail ArgumentError, 'offer is nil' if offer.nil? fail ArgumentError, 'skus is nil' if skus.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'location' => location,'publisherName' => publisher_name,'offer' => offer,'skus' => skus,'subscriptionId' => @client.subscription_id}, query_params: {'$expand' => expand,'$top' => top,'$orderby' => orderby,'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'VirtualMachineImageResourceElementType', type: { name: 'Composite', class_name: 'VirtualMachineImageResource' } } } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets a list of virtual machine image offers for the specified location and publisher.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array] operation results.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 271 def list_offers(location, publisher_name, custom_headers:nil) response = list_offers_async(location, publisher_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a list of virtual machine image offers for the specified location and publisher.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 302 def list_offers_async(location, publisher_name, custom_headers:nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, 'publisher_name is nil' if publisher_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'location' => location,'publisherName' => publisher_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'VirtualMachineImageResourceElementType', type: { name: 'Composite', class_name: 'VirtualMachineImageResource' } } } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets a list of virtual machine image offers for the specified location and publisher.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 287 def list_offers_with_http_info(location, publisher_name, custom_headers:nil) list_offers_async(location, publisher_name, custom_headers:custom_headers).value! end
Gets a list of virtual machine image publishers for the specified Azure
location.
@param location [String] The name of a supported Azure
region. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array] operation results.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 383 def list_publishers(location, custom_headers:nil) response = list_publishers_async(location, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a list of virtual machine image publishers for the specified Azure
location.
@param location [String] The name of a supported Azure
region. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 412 def list_publishers_async(location, custom_headers:nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'location' => location,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'VirtualMachineImageResourceElementType', type: { name: 'Composite', class_name: 'VirtualMachineImageResource' } } } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets a list of virtual machine image publishers for the specified Azure
location.
@param location [String] The name of a supported Azure
region. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 398 def list_publishers_with_http_info(location, custom_headers:nil) list_publishers_async(location, custom_headers:custom_headers).value! end
Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array] operation results.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 494 def list_skus(location, publisher_name, offer, custom_headers:nil) response = list_skus_async(location, publisher_name, offer, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 527 def list_skus_async(location, publisher_name, offer, custom_headers:nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, 'publisher_name is nil' if publisher_name.nil? fail ArgumentError, 'offer is nil' if offer.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? request_headers = {} request_headers['Content-Type'] = 'application/json; charset=utf-8' # Set Headers request_headers['x-ms-client-request-id'] = SecureRandom.uuid request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'location' => location,'publisherName' => publisher_name,'offer' => offer,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = { client_side_validation: true, required: false, serialized_name: 'parsed_response', type: { name: 'Sequence', element: { client_side_validation: true, required: false, serialized_name: 'VirtualMachineImageResourceElementType', type: { name: 'Composite', class_name: 'VirtualMachineImageResource' } } } } result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result) end end result end promise.execute end
Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 511 def list_skus_with_http_info(location, publisher_name, offer, custom_headers:nil) list_skus_async(location, publisher_name, offer, custom_headers:custom_headers).value! end
Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
@param location [String] The name of a supported Azure
region. @param publisher_name [String] A valid image publisher. @param offer [String] A valid image publisher offer. @param skus [String] A valid image SKU. @param expand [String] The expand expression to apply on the operation. @param top [Integer] @param orderby [String] @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2020-12-01/generated/azure_mgmt_compute/virtual_machine_images.rb, line 167 def list_with_http_info(location, publisher_name, offer, skus, expand:nil, top:nil, orderby:nil, custom_headers:nil) list_async(location, publisher_name, offer, skus, expand:expand, top:top, orderby:orderby, custom_headers:custom_headers).value! end