Class: Azure::DevTestLabs::Mgmt::V2016_05_15::CustomImages

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb

Overview

The DevTest Labs Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CustomImages

Creates and initializes a new instance of the CustomImages class.



17
18
19
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DevTestLabsClient (readonly) 



22
23
24
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers: nil) ⇒ CustomImage

Create or replace an existing custom image. This operation can take a while to complete.

will be added to the HTTP request.



339
340
341
342
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 339

def begin_create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers: nil) ⇒ Concurrent::Promise

Create or replace an existing custom image. This operation can take a while to complete.

to the HTTP request.



374
375
376
377
378
379
380
381
382
383
384
385
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
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 374

def begin_create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'custom_image is nil' if custom_image.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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?

  # Serialize Request
  request_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::CustomImage.mapper()
  request_content = @client.serialize(request_mapper,  custom_image)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name,'name' => name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 201
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::CustomImage.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::CustomImage.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

#begin_create_or_update_with_http_info(resource_group_name, lab_name, name, custom_image, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or replace an existing custom image. This operation can take a while to complete.

will be added to the HTTP request.



357
358
359
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 357

def begin_create_or_update_with_http_info(resource_group_name, lab_name, name, custom_image, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, lab_name, name, custom_headers: nil) ⇒ Object

Delete custom image. This operation can take a while to complete.

will be added to the HTTP request.



456
457
458
459
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 456

def begin_delete(resource_group_name, lab_name, name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, lab_name, name, custom_headers: nil) ⇒ Concurrent::Promise

Delete custom image. This operation can take a while to complete.

to the HTTP request.



487
488
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
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 487

def begin_delete_async(resource_group_name, lab_name, name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name,'name' => name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 == 202 || status_code == 204
      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
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, lab_name, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete custom image. This operation can take a while to complete.

will be added to the HTTP request.



472
473
474
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 472

def begin_delete_with_http_info(resource_group_name, lab_name, name, custom_headers:nil)
  begin_delete_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers: nil) ⇒ CustomImage

Create or replace an existing custom image. This operation can take a while to complete.

will be added to the HTTP request.



252
253
254
255
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 252

def create_or_update(resource_group_name, lab_name, name, custom_image, custom_headers:nil)
  response = create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 268

def create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, lab_name, name, custom_image, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::CustomImage.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, lab_name, name, custom_headers: nil) ⇒ Object

Delete custom image. This operation can take a while to complete.

will be added to the HTTP request.



295
296
297
298
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 295

def delete(resource_group_name, lab_name, name, custom_headers:nil)
  response = delete_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, lab_name, name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 310

def delete_async(resource_group_name, lab_name, name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, lab_name, name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, lab_name, name, expand: nil, custom_headers: nil) ⇒ CustomImage

Get custom image.

‘properties($select=vm)’ will be added to the HTTP request.



150
151
152
153
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 150

def get(resource_group_name, lab_name, name, expand:nil, custom_headers:nil)
  response = get_async(resource_group_name, lab_name, name, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, lab_name, name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get custom image.

‘properties($select=vm)’ to the HTTP request.



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
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 185

def get_async(resource_group_name, lab_name, name, expand:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name,'name' => name},
      query_params: {'$expand' => expand,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::CustomImage.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

#get_with_http_info(resource_group_name, lab_name, name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get custom image.

‘properties($select=vm)’ will be added to the HTTP request.



168
169
170
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 168

def get_with_http_info(resource_group_name, lab_name, name, expand:nil, custom_headers:nil)
  get_async(resource_group_name, lab_name, name, expand:expand, custom_headers:custom_headers).value!
end

#list(resource_group_name, lab_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ Array<CustomImage>

List custom images in a given lab.

‘properties($select=vm)’ operation. notation. will be added to the HTTP request.



41
42
43
44
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 41

def list(resource_group_name, lab_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, lab_name, expand:expand, filter:filter, top:top, orderby:orderby, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, lab_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ ResponseWithContinuationCustomImage

List custom images in a given lab.

‘properties($select=vm)’ operation. notation. will be added to the HTTP request.

pages of the response.



637
638
639
640
641
642
643
644
645
646
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 637

def list_as_lazy(resource_group_name, lab_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  response = list_async(resource_group_name, lab_name, expand:expand, filter:filter, top:top, orderby:orderby, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, lab_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ Concurrent::Promise

List custom images in a given lab.

‘properties($select=vm)’ operation. notation. to the HTTP request.



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
130
131
132
133
134
135
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 84

def list_async(resource_group_name, lab_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'lab_name is nil' if lab_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'labName' => lab_name},
      query_params: {'$expand' => expand,'$filter' => filter,'$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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::ResponseWithContinuationCustomImage.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

#list_next(next_page_link, custom_headers: nil) ⇒ ResponseWithContinuationCustomImage

List custom images in a given lab.

to List operation. will be added to the HTTP request.



541
542
543
544
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 541

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List custom images in a given lab.

to List operation. to the HTTP request.



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 570

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DevTestLabs::Mgmt::V2016_05_15::Models::ResponseWithContinuationCustomImage.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

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List custom images in a given lab.

to List operation. will be added to the HTTP request.



556
557
558
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 556

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, lab_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List custom images in a given lab.

‘properties($select=vm)’ operation. notation. will be added to the HTTP request.



63
64
65
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/custom_images.rb', line 63

def list_with_http_info(resource_group_name, lab_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  list_async(resource_group_name, lab_name, expand:expand, filter:filter, top:top, orderby:orderby, custom_headers:custom_headers).value!
end