Class: Azure::DevTestLabs::Mgmt::V2016_05_15::Environments

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

Overview

The DevTest Labs Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Environments

Creates and initializes a new instance of the Environments class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DevTestLabsClient (readonly)

Returns reference to the DevTestLabsClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers: nil) ⇒ DtlEnvironment

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

an ARM template deployment. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • dtl_environment (DtlEnvironment) —

    An environment, which is essentially

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

    A hash of custom headers that

Returns:

  • (DtlEnvironment) —

    operation results.



355
356
357
358
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 355

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

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

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

an ARM template deployment. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • dtl_environment (DtlEnvironment) —

    An environment, which is essentially

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 394

def begin_create_or_update_async(resource_group_name, lab_name, user_name, name, dtl_environment, 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, 'user_name is nil' if user_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, 'dtl_environment is nil' if dtl_environment.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::DtlEnvironment.mapper()
  request_content = @client.serialize(request_mapper,  dtl_environment)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{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,'userName' => user_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::DtlEnvironment.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::DtlEnvironment.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, user_name, name, dtl_environment, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

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

an ARM template deployment. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • dtl_environment (DtlEnvironment) —

    An environment, which is essentially

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



375
376
377
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 375

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

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

Delete environment. This operation can take a while to complete.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

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

    A hash of custom headers that



478
479
480
481
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 478

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

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

Delete environment. This operation can take a while to complete.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
551
552
553
554
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 511

def begin_delete_async(resource_group_name, lab_name, user_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, 'user_name is nil' if user_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}/users/{userName}/environments/{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,'userName' => user_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, user_name, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete environment. This operation can take a while to complete.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



495
496
497
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 495

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

#create_or_update(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers: nil) ⇒ DtlEnvironment

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

an ARM template deployment. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • dtl_environment (DtlEnvironment) —

    An environment, which is essentially

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

    A hash of custom headers that

Returns:

  • (DtlEnvironment) —

    operation results.



262
263
264
265
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 262

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

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

an ARM template deployment. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • dtl_environment (DtlEnvironment) —

    An environment, which is essentially

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 280

def create_or_update_async(resource_group_name, lab_name, user_name, name, dtl_environment, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, lab_name, user_name, name, dtl_environment, 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::DtlEnvironment.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, user_name, name, custom_headers: nil) ⇒ Object

Delete environment. This operation can take a while to complete.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

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

    A hash of custom headers that



308
309
310
311
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 308

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

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 324

def delete_async(resource_group_name, lab_name, user_name, name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, lab_name, user_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, user_name, name, expand: nil, custom_headers: nil) ⇒ DtlEnvironment

Get environment.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

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

    A hash of custom headers that

Returns:

  • (DtlEnvironment) —

    operation results.



155
156
157
158
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 155

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

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

Get environment.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_async(resource_group_name, lab_name, user_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, 'user_name is nil' if user_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}/users/{userName}/environments/{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,'userName' => user_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::DtlEnvironment.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, user_name, name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get environment.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • name (String) —

    The name of the environment.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



174
175
176
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 174

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

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

List environments in a given user profile.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

  • orderby (String) (defaults to: nil) —

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (Array<DtlEnvironment>) —

    operation results.



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

def list(resource_group_name, lab_name, user_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, lab_name, user_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, user_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ ResponseWithContinuationDtlEnvironment

List environments in a given user profile.

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

pages of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

  • orderby (String) (defaults to: nil) —

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (ResponseWithContinuationDtlEnvironment) —

    which provide lazy access to



663
664
665
666
667
668
669
670
671
672
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 663

def list_as_lazy(resource_group_name, lab_name, user_name, expand:nil, filter:nil, top:nil, orderby:nil, custom_headers:nil)
  response = list_async(resource_group_name, lab_name, user_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, user_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ Concurrent::Promise

List environments in a given user profile.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

  • orderby (String) (defaults to: nil) —

    The ordering expression for the results, using OData

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
136
137
138
139
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 87

def list_async(resource_group_name, lab_name, user_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, 'user_name is nil' if user_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}/users/{userName}/environments'

  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,'userName' => user_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::ResponseWithContinuationDtlEnvironment.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) ⇒ ResponseWithContinuationDtlEnvironment

List environments in a given user profile.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ResponseWithContinuationDtlEnvironment) —

    operation results.



566
567
568
569
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 566

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 environments in a given user profile.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 595

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::ResponseWithContinuationDtlEnvironment.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 environments in a given user profile.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



581
582
583
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 581

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, user_name, expand: nil, filter: nil, top: nil, orderby: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List environments in a given user profile.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • user_name (String) —

    The name of the user profile.

  • expand (String) (defaults to: nil) —

    Specify the $expand query. Example:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • top (Integer) (defaults to: nil) —

    The maximum number of resources to return from the

  • orderby (String) (defaults to: nil) —

    The ordering expression for the results, using OData

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/environments.rb', line 65

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