Class: Azure::MobileEngagement::Mgmt::V2014_12_01::ExportTasks

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb

Overview

Microsoft Azure Mobile Engagement REST APIs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ExportTasks

Creates and initializes a new instance of the ExportTasks class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ EngagementManagementClient (readonly)

Returns reference to the EngagementManagementClient.

Returns:



22
23
24
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 22

def client
  @client
end

Instance Method Details

#create_activities_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export activities.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



286
287
288
289
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 286

def create_activities_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_activities_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_activities_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export activities.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 319

def create_activities_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/activities'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_activities_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export activities.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



303
304
305
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 303

def create_activities_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_activities_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_crashes_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export crashes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



393
394
395
396
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 393

def create_crashes_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_crashes_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_crashes_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export crashes.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 426

def create_crashes_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/crashes'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_crashes_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export crashes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



410
411
412
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 410

def create_crashes_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_crashes_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_errors_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export errors.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



500
501
502
503
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 500

def create_errors_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_errors_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_errors_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export errors.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 533

def create_errors_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/errors'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_errors_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export errors.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



517
518
519
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 517

def create_errors_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_errors_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_events_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export events.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



607
608
609
610
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 607

def create_events_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_events_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_events_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export events.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 640

def create_events_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/events'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_events_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export events.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



624
625
626
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 624

def create_events_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_events_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_feedback_task_by_campaign(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export push campaign data for a set of campaigns.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



1249
1250
1251
1252
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1249

def create_feedback_task_by_campaign(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_feedback_task_by_campaign_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_feedback_task_by_campaign_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export push campaign data for a set of campaigns.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1282

def create_feedback_task_by_campaign_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::FeedbackByCampaignParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/feedbackByCampaign'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_feedback_task_by_campaign_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export push campaign data for a set of campaigns.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1266
1267
1268
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1266

def create_feedback_task_by_campaign_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_feedback_task_by_campaign_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_feedback_task_by_date_range(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export push campaign data for a date range.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



1142
1143
1144
1145
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1142

def create_feedback_task_by_date_range(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_feedback_task_by_date_range_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_feedback_task_by_date_range_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export push campaign data for a date range.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1175

def create_feedback_task_by_date_range_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::FeedbackByDateRangeParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/feedbackByDate'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_feedback_task_by_date_range_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export push campaign data for a date range.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1159
1160
1161
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1159

def create_feedback_task_by_date_range_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_feedback_task_by_date_range_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_jobs_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export jobs.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



714
715
716
717
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 714

def create_jobs_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_jobs_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_jobs_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export jobs.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 747

def create_jobs_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/jobs'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_jobs_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export jobs.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



731
732
733
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 731

def create_jobs_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_jobs_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_sessions_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export sessions.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



821
822
823
824
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 821

def create_sessions_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_sessions_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_sessions_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export sessions.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 854

def create_sessions_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::DateRangeExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/sessions'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_sessions_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export sessions.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



838
839
840
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 838

def create_sessions_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_sessions_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_tags_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export tags.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



928
929
930
931
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 928

def create_tags_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_tags_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_tags_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export tags.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 961

def create_tags_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/tags'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_tags_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export tags.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



945
946
947
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 945

def create_tags_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_tags_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#create_tokens_task(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ ExportTaskResult

Creates a task to export tags.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



1035
1036
1037
1038
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1035

def create_tokens_task(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  response = create_tokens_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_tokens_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a task to export tags.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1068

def create_tokens_task_async(resource_group_name, app_collection, app_name, parameters, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskParameter.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/tokens'

  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,'appCollection' => app_collection,'appName' => app_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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 == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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_tokens_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a task to export tags.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1052
1053
1054
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1052

def create_tokens_task_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers:nil)
  create_tokens_task_async(resource_group_name, app_collection, app_name, parameters, custom_headers:custom_headers).value!
end

#get(resource_group_name, app_collection, app_name, id, custom_headers: nil) ⇒ ExportTaskResult

Retrieves information about a previously created export task.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • id (String) —

    Export task identifier.

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

    A hash of custom headers that

Returns:

  • (ExportTaskResult) —

    operation results.



186
187
188
189
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 186

def get(resource_group_name, app_collection, app_name, id, custom_headers:nil)
  response = get_async(resource_group_name, app_collection, app_name, id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, app_collection, app_name, id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves information about a previously created export task.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • id (String) —

    Export task identifier.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 219

def get_async(resource_group_name, app_collection, app_name, id, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'id is nil' if id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks/{id}'

  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,'appCollection' => app_collection,'appName' => app_name,'id' => id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskResult.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, app_collection, app_name, id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves information about a previously created export task.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • id (String) —

    Export task identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



203
204
205
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 203

def get_with_http_info(resource_group_name, app_collection, app_name, id, custom_headers:nil)
  get_async(resource_group_name, app_collection, app_name, id, custom_headers:custom_headers).value!
end

#list(resource_group_name, app_collection, app_name, skip: 0, top: 20, orderby: nil, custom_headers: nil) ⇒ Array<ExportTaskResult>

Get the list of export tasks.

given offset, defaults to 0 (1st page of data). to return with each call. By default, it returns all export tasks with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=taskId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: taskId, errorDetails, dateCreated, taskStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • skip (Integer) (defaults to: 0) —

    Control paging of export tasks, start results at the

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

    Control paging of export tasks, number of export tasks

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

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (Array<ExportTaskResult>) —

    operation results.



52
53
54
55
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 52

def list(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, app_collection, app_name, skip:skip, top:top, orderby:orderby, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, app_collection, app_name, skip: 0, top: 20, orderby: nil, custom_headers: nil) ⇒ ExportTaskListResult

Get the list of export tasks.

given offset, defaults to 0 (1st page of data). to return with each call. By default, it returns all export tasks with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=taskId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: taskId, errorDetails, dateCreated, taskStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • skip (Integer) (defaults to: 0) —

    Control paging of export tasks, start results at the

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

    Control paging of export tasks, number of export tasks

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

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (ExportTaskListResult) —

    which provide lazy access to pages of the



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1461

def list_as_lazy(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil)
  response = list_async(resource_group_name, app_collection, app_name, skip:skip, 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, app_collection, app_name, skip: 0, top: 20, orderby: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get the list of export tasks.

given offset, defaults to 0 (1st page of data). to return with each call. By default, it returns all export tasks with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=taskId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: taskId, errorDetails, dateCreated, taskStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • skip (Integer) (defaults to: 0) —

    Control paging of export tasks, start results at the

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

    Control paging of export tasks, number of export tasks

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

    Sort results by an expression which looks like

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 117

def list_async(resource_group_name, app_collection, app_name, skip:0, top:20, 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, 'app_collection is nil' if app_collection.nil?
  fail ArgumentError, 'app_name is nil' if app_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMaximum': '40'" if !top.nil? && top > 40
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1


  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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/devices/exportTasks'

  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,'appCollection' => app_collection,'appName' => app_name},
      query_params: {'api-version' => @client.api_version,'$skip' => skip,'$top' => top,'$orderby' => orderby},
      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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskListResult.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) ⇒ ExportTaskListResult

Get the list of export tasks.

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:

  • (ExportTaskListResult) —

    operation results.



1354
1355
1356
1357
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1354

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

Get the list of export tasks.

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.



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1383

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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::ExportTaskListResult.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

Get the list of export tasks.

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.



1369
1370
1371
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 1369

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, app_collection, app_name, skip: 0, top: 20, orderby: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the list of export tasks.

given offset, defaults to 0 (1st page of data). to return with each call. By default, it returns all export tasks with a default paging of 20. The response contains a ‘nextLink` property describing the path to get the next page if there are more results. The maximum paging limit for $top is 40. `$orderby=taskId asc` (default when not specified). The syntax is orderby=property direction or just orderby=property. Properties that can be specified for sorting: taskId, errorDetails, dateCreated, taskStatus, and dateCreated. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one orderby property can be specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • app_collection (String) —

    Application collection.

  • app_name (String) —

    Application resource name.

  • skip (Integer) (defaults to: 0) —

    Control paging of export tasks, start results at the

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

    Control paging of export tasks, number of export tasks

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

    Sort results by an expression which looks like

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



85
86
87
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/export_tasks.rb', line 85

def list_with_http_info(resource_group_name, app_collection, app_name, skip:0, top:20, orderby:nil, custom_headers:nil)
  list_async(resource_group_name, app_collection, app_name, skip:skip, top:top, orderby:orderby, custom_headers:custom_headers).value!
end