Class: Azure::DevTestLabs::Mgmt::V2016_05_15::Schedules

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

Overview

The DevTest Labs Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Schedules

Creates and initializes a new instance of the Schedules class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.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/schedules.rb', line 22

def client
  @client
end

Instance Method Details

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

Execute a schedule. 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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that



694
695
696
697
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 694

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

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

Execute a schedule. 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.

  • name (String) —

    The name of the schedule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 725

def begin_execute_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}/schedules/{name}/execute'

  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(:post, 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 == 202
      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_execute_with_http_info(resource_group_name, lab_name, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Execute a schedule. 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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



710
711
712
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 710

def begin_execute_with_http_info(resource_group_name, lab_name, name, custom_headers:nil)
  begin_execute_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, lab_name, name, schedule, custom_headers: nil) ⇒ Schedule

Create or replace an existing schedule.

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.

  • name (String) —

    The name of the schedule.

  • schedule (Schedule) —

    A schedule.

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

    A hash of custom headers that

Returns:

  • (Schedule) —

    operation results.



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

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

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

Create or replace an existing schedule.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

  • schedule (Schedule) —

    A schedule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



284
285
286
287
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
349
350
351
352
353
354
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 284

def create_or_update_async(resource_group_name, lab_name, name, schedule, 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, 'schedule is nil' if schedule.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::Schedule.mapper()
  request_content = @client.serialize(request_mapper,  schedule)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{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::Schedule.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::Schedule.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

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

Create or replace an existing schedule.

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.

  • name (String) —

    The name of the schedule.

  • schedule (Schedule) —

    A schedule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



268
269
270
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 268

def create_or_update_with_http_info(resource_group_name, lab_name, name, schedule, custom_headers:nil)
  create_or_update_async(resource_group_name, lab_name, name, schedule, custom_headers:custom_headers).value!
end

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

Delete schedule.

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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that



366
367
368
369
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 366

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

Delete schedule.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def 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}/schedules/{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 == 200 || 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

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

Delete schedule.

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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



382
383
384
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 382

def delete_with_http_info(resource_group_name, lab_name, name, custom_headers:nil)
  delete_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
end

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

Execute a schedule. 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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that



557
558
559
560
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 557

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

#execute_async(resource_group_name, lab_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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 572

def execute_async(resource_group_name, lab_name, name, custom_headers:nil)
  # Send request
  promise = begin_execute_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) ⇒ Schedule

Get schedule.

‘properties($select=status)’ 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.

  • name (String) —

    The name of the schedule.

  • 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:

  • (Schedule) —

    operation results.



150
151
152
153
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.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 schedule.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

  • 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.



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/schedules.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}/schedules/{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::Schedule.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 schedule.

‘properties($select=status)’ 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.

  • name (String) —

    The name of the schedule.

  • 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.



168
169
170
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.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<Schedule>

List schedules in a given lab.

‘properties($select=status)’ 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.

  • 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<Schedule>) —

    operation results.



41
42
43
44
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.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_applicable(resource_group_name, lab_name, name, custom_headers: nil) ⇒ Array<Schedule>

Lists all applicable schedules

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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (Array<Schedule>) —

    operation results.



599
600
601
602
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 599

def list_applicable(resource_group_name, lab_name, name, custom_headers:nil)
  first_page = list_applicable_as_lazy(resource_group_name, lab_name, name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_applicable_as_lazy(resource_group_name, lab_name, name, custom_headers: nil) ⇒ ResponseWithContinuationSchedule

Lists all applicable schedules

will be added to the HTTP request.

of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (ResponseWithContinuationSchedule) —

    which provide lazy access to pages



986
987
988
989
990
991
992
993
994
995
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 986

def list_applicable_as_lazy(resource_group_name, lab_name, name, custom_headers:nil)
  response = list_applicable_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_applicable_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Lists all applicable schedules

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 630

def list_applicable_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}/schedules/{name}/listApplicable'

  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(:post, 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::ResponseWithContinuationSchedule.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_applicable_next(next_page_link, custom_headers: nil) ⇒ ResponseWithContinuationSchedule

Lists all applicable schedules

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:

  • (ResponseWithContinuationSchedule) —

    operation results.



867
868
869
870
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 867

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

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

Lists all applicable schedules

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.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 896

def list_applicable_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(:post, 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::ResponseWithContinuationSchedule.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_applicable_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all applicable schedules

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.



882
883
884
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 882

def list_applicable_next_with_http_info(next_page_link, custom_headers:nil)
  list_applicable_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Lists all applicable schedules

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.

  • name (String) —

    The name of the schedule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



615
616
617
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 615

def list_applicable_with_http_info(resource_group_name, lab_name, name, custom_headers:nil)
  list_applicable_async(resource_group_name, lab_name, name, custom_headers:custom_headers).value!
end

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

List schedules in a given lab.

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

of the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • 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:

  • (ResponseWithContinuationSchedule) —

    which provide lazy access to pages



963
964
965
966
967
968
969
970
971
972
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 963

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 schedules in a given lab.

‘properties($select=status)’ 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.

  • 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.



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/schedules.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}/schedules'

  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::ResponseWithContinuationSchedule.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) ⇒ ResponseWithContinuationSchedule

List schedules in a given lab.

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:

  • (ResponseWithContinuationSchedule) —

    operation results.



779
780
781
782
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 779

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 schedules in a given lab.

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.



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 808

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::ResponseWithContinuationSchedule.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 schedules in a given lab.

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.



794
795
796
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 794

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 schedules in a given lab.

‘properties($select=status)’ 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.

  • 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.



63
64
65
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.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

#update(resource_group_name, lab_name, name, schedule, custom_headers: nil) ⇒ Schedule

Modify properties of schedules.

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.

  • name (String) —

    The name of the schedule.

  • schedule (ScheduleFragment) —

    A schedule.

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

    A hash of custom headers that

Returns:

  • (Schedule) —

    operation results.



453
454
455
456
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 453

def update(resource_group_name, lab_name, name, schedule, custom_headers:nil)
  response = update_async(resource_group_name, lab_name, name, schedule, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Modify properties of schedules.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • lab_name (String) —

    The name of the lab.

  • name (String) —

    The name of the schedule.

  • schedule (ScheduleFragment) —

    A schedule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



486
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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 486

def update_async(resource_group_name, lab_name, name, schedule, 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, 'schedule is nil' if schedule.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::ScheduleFragment.mapper()
  request_content = @client.serialize(request_mapper,  schedule)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{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(:patch, 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::Schedule.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

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

Modify properties of schedules.

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.

  • name (String) —

    The name of the schedule.

  • schedule (ScheduleFragment) —

    A schedule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



470
471
472
 
# File 'lib/2016-05-15/generated/azure_mgmt_devtestlabs/schedules.rb', line 470

def update_with_http_info(resource_group_name, lab_name, name, schedule, custom_headers:nil)
  update_async(resource_group_name, lab_name, name, schedule, custom_headers:custom_headers).value!
end