Class: Azure::ARM::Compute::VirtualMachineImages

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/azure_mgmt_compute/virtual_machine_images.rb

Overview

The Compute Management Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualMachineImages

Creates and initializes a new instance of the VirtualMachineImages class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the ComputeManagementClient.

Returns:

  • reference to the ComputeManagementClient



23
24
25
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 23

def client
  @client
end

Instance Method Details

#get(location, publisher_name, offer, skus, version, custom_headers = nil) ⇒ VirtualMachineImage

Gets a virtual machine image.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • version (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:



38
39
40
41
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 38

def get(location, publisher_name, offer, skus, version, custom_headers = nil)
  response = get_async(location, publisher_name, offer, skus, version, custom_headers).value!
  response.body unless response.nil?
end

#get_async(location, publisher_name, offer, skus, version, custom_headers = nil) ⇒ Concurrent::Promise

Gets a virtual machine image.

to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • version (String)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 73

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 = {}

  # 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}'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = VirtualMachineImage.deserialize_object(parsed_response)
        end
        result.body = 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

#get_with_http_info(location, publisher_name, offer, skus, version, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a virtual machine image.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • version (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 56

def get_with_http_info(location, publisher_name, offer, skus, version, custom_headers = nil)
  get_async(location, publisher_name, offer, skus, version, custom_headers).value!
end

#list(location, publisher_name, offer, skus, filter = nil, top = nil, orderby = nil, custom_headers = nil) ⇒ Array

Gets a list of virtual machine images.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

  • top (Integer) (defaults to: nil)
  • orderby (String) (defaults to: nil)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



146
147
148
149
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 146

def list(location, publisher_name, offer, skus, filter = nil, top = nil, orderby = nil, custom_headers = nil)
  response = list_async(location, publisher_name, offer, skus, filter, top, orderby, custom_headers).value!
  response.body unless response.nil?
end

#list_async(location, publisher_name, offer, skus, filter = nil, top = nil, orderby = nil, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of virtual machine images.

to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

  • top (Integer) (defaults to: nil)
  • orderby (String) (defaults to: nil)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 185

def list_async(location, publisher_name, offer, skus, filter = 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 = {}

  # 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'
  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: {'$filter' => filter,'$top' => top,'$orderby' => orderby,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          deserialized_array = []
          parsed_response.each do |element|
            unless element.nil?
              element = VirtualMachineImageResource.deserialize_object(element)
            end
            deserialized_array.push(element)
          end
          parsed_response = deserialized_array
        end
        result.body = 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

#list_offers(location, publisher_name, custom_headers = nil) ⇒ Array

Gets a list of virtual machine image offers.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



259
260
261
262
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 259

def list_offers(location, publisher_name, custom_headers = nil)
  response = list_offers_async(location, publisher_name, custom_headers).value!
  response.body unless response.nil?
end

#list_offers_async(location, publisher_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of virtual machine image offers.

to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 288

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 = {}

  # 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'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          deserialized_array = []
          parsed_response.each do |element|
            unless element.nil?
              element = VirtualMachineImageResource.deserialize_object(element)
            end
            deserialized_array.push(element)
          end
          parsed_response = deserialized_array
        end
        result.body = 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

#list_offers_with_http_info(location, publisher_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of virtual machine image offers.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



274
275
276
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 274

def list_offers_with_http_info(location, publisher_name, custom_headers = nil)
  list_offers_async(location, publisher_name, custom_headers).value!
end

#list_publishers(location, custom_headers = nil) ⇒ Array

Gets a list of virtual machine image publishers.

will be added to the HTTP request.

Parameters:

  • location (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



359
360
361
362
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 359

def list_publishers(location, custom_headers = nil)
  response = list_publishers_async(location, custom_headers).value!
  response.body unless response.nil?
end

#list_publishers_async(location, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of virtual machine image publishers.

to the HTTP request.

Parameters:

  • location (String)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 386

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 = {}

  # 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'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          deserialized_array = []
          parsed_response.each do |element|
            unless element.nil?
              element = VirtualMachineImageResource.deserialize_object(element)
            end
            deserialized_array.push(element)
          end
          parsed_response = deserialized_array
        end
        result.body = 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

#list_publishers_with_http_info(location, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of virtual machine image publishers.

will be added to the HTTP request.

Parameters:

  • location (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



373
374
375
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 373

def list_publishers_with_http_info(location, custom_headers = nil)
  list_publishers_async(location, custom_headers).value!
end

#list_skus(location, publisher_name, offer, custom_headers = nil) ⇒ Array

Gets a list of virtual machine image skus.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



458
459
460
461
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 458

def list_skus(location, publisher_name, offer, custom_headers = nil)
  response = list_skus_async(location, publisher_name, offer, custom_headers).value!
  response.body unless response.nil?
end

#list_skus_async(location, publisher_name, offer, custom_headers = nil) ⇒ Concurrent::Promise

Gets a list of virtual machine image skus.

to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 489

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 = {}

  # 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'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          deserialized_array = []
          parsed_response.each do |element|
            unless element.nil?
              element = VirtualMachineImageResource.deserialize_object(element)
            end
            deserialized_array.push(element)
          end
          parsed_response = deserialized_array
        end
        result.body = 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

#list_skus_with_http_info(location, publisher_name, offer, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of virtual machine image skus.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



474
475
476
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 474

def list_skus_with_http_info(location, publisher_name, offer, custom_headers = nil)
  list_skus_async(location, publisher_name, offer, custom_headers).value!
end

#list_with_http_info(location, publisher_name, offer, skus, filter = nil, top = nil, orderby = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of virtual machine images.

will be added to the HTTP request.

Parameters:

  • location (String)
  • publisher_name (String)
  • offer (String)
  • skus (String)
  • filter (String) (defaults to: nil) —

    The filter to apply on the operation.

  • top (Integer) (defaults to: nil)
  • orderby (String) (defaults to: nil)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



166
167
168
 
# File 'lib/azure_mgmt_compute/virtual_machine_images.rb', line 166

def list_with_http_info(location, publisher_name, offer, skus, filter = nil, top = nil, orderby = nil, custom_headers = nil)
  list_async(location, publisher_name, offer, skus, filter, top, orderby, custom_headers).value!
end