Class: Azure::MobileEngagement::Mgmt::V2014_12_01::Devices

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

Overview

Microsoft Azure Mobile Engagement REST APIs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Devices

Creates and initializes a new instance of the Devices class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.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/devices.rb', line 22

def client
  @client
end

Instance Method Details

#get_by_device_id(resource_group_name, app_collection, app_name, device_id, custom_headers = nil) ⇒ Device

Get the information associated to a device running an application.

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.

  • device_id (String) —

    Device identifier.

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

    A hash of custom headers that

Returns:

  • (Device) —

    operation results.



251
252
253
254
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 251

def get_by_device_id(resource_group_name, app_collection, app_name, device_id, custom_headers = nil)
  response = get_by_device_id_async(resource_group_name, app_collection, app_name, device_id, custom_headers).value!
  response.body unless response.nil?
end

#get_by_device_id_async(resource_group_name, app_collection, app_name, device_id, custom_headers = nil) ⇒ Concurrent::Promise

Get the information associated to a device running an application.

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.

  • device_id (String) —

    Device identifier.

  • 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
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 284

def get_by_device_id_async(resource_group_name, app_collection, app_name, device_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, 'device_id is nil' if device_id.nil?


  request_headers = {}

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

  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,'deviceId' => device_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::Device.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_by_device_id_with_http_info(resource_group_name, app_collection, app_name, device_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get the information associated to a device running an application.

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.

  • device_id (String) —

    Device identifier.

  • 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/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 268

def get_by_device_id_with_http_info(resource_group_name, app_collection, app_name, device_id, custom_headers = nil)
  get_by_device_id_async(resource_group_name, app_collection, app_name, device_id, custom_headers).value!
end

#get_by_user_id(resource_group_name, app_collection, app_name, user_id, custom_headers = nil) ⇒ Device

Get the information associated to a device running an application using the user identifier.

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.

  • user_id (String) —

    User identifier.

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

    A hash of custom headers that

Returns:

  • (Device) —

    operation results.



351
352
353
354
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 351

def get_by_user_id(resource_group_name, app_collection, app_name, user_id, custom_headers = nil)
  response = get_by_user_id_async(resource_group_name, app_collection, app_name, user_id, custom_headers).value!
  response.body unless response.nil?
end

#get_by_user_id_async(resource_group_name, app_collection, app_name, user_id, custom_headers = nil) ⇒ Concurrent::Promise

Get the information associated to a device running an application using the user identifier.

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.

  • user_id (String) —

    User identifier.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 386

def get_by_user_id_async(resource_group_name, app_collection, app_name, user_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, 'user_id is nil' if user_id.nil?


  request_headers = {}

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

  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,'userId' => user_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::Device.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_by_user_id_with_http_info(resource_group_name, app_collection, app_name, user_id, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get the information associated to a device running an application using the user identifier.

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.

  • user_id (String) —

    User identifier.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



369
370
371
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 369

def get_by_user_id_with_http_info(resource_group_name, app_collection, app_name, user_id, custom_headers = nil)
  get_by_user_id_async(resource_group_name, app_collection, app_name, user_id, custom_headers).value!
end

#list(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil) ⇒ Array<DeviceQueryResult>

Query the information associated to the devices running an application.

100 and cannot return more. Passing a greater value is ignored. The response contains a ‘nextLink` property describing the URI path to get the next page of results if not all results could be returned at once. returned, this property is used to restrict the output to the desired properties. It also excludes all devices from the output that have none of the selected properties. In other terms, only devices having at least one of the selected property being set is part of the results. Examples: - `$select=appInfo` : select all devices having at least 1 appInfo, return them all and don’t return any meta property. - `$select=meta` : return only meta properties in the output. - `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all `appInfo`, plus meta object containing only firstSeen and lastSeen properties. The format is thus a comma separated list of properties to select. Use `appInfo` to select all appInfo properties, `meta` to select all meta properties. Use `appInfo/key` and `meta/key` to select specific appInfo and meta properties. Filter is a boolean expression that can look like the following examples: * `$filter=deviceId gt ’abcdef0123456789abcdef0123456789’‘ * `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge ’abcdef0123456789abcdef0123456789’) and (deviceId lt ‘bacdef0123456789abcdef0123456789’) and (lastModified gt 1447284263690L)‘ The first example is used automatically for paging when returning the `nextLink` property. The filter expression is a combination of checks on some properties that can be compared to their value. The available operators are: * `gt` : greater than * `ge` : greater than or equals * `lt` : less than * `le` : less than or equals * `and` : to add multiple checks (all checks must pass), optional parentheses can be used. The properties that can be used in the expression are the following: * `deviceId operator ’deviceIdValue‘` : a lexicographical comparison is made on the deviceId value, use single quotes for the value. * `lastModified operator numberL` : returns only meta properties or appInfo properties whose last value modification timestamp compared to the specified value is matching (value is milliseconds since January 1st, 1970 UTC). Please note the `L` character after the number of milliseconds, its required when the number of milliseconds exceeds `2^31 - 1` (which is always the case for recent timestamps). Using `lastModified` excludes all devices from the output that have no property matching the timestamp criteria, like `$select`. Please note that the internal value of `lastModified` timestamp for a given property is never part of the results. 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.

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

    Number of devices to return with each call. Defaults to

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

    By default all ‘meta` and `appInfo` properties are

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

    Filter can be used to reduce the number of results.

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

    A hash of custom headers that

Returns:

  • (Array<DeviceQueryResult>) —

    operation results.



75
76
77
78
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 75

def list(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil)
  first_page = list_as_lazy(resource_group_name, app_collection, app_name, top, select, filter, custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil) ⇒ DevicesQueryResult

Query the information associated to the devices running an application.

100 and cannot return more. Passing a greater value is ignored. The response contains a ‘nextLink` property describing the URI path to get the next page of results if not all results could be returned at once. returned, this property is used to restrict the output to the desired properties. It also excludes all devices from the output that have none of the selected properties. In other terms, only devices having at least one of the selected property being set is part of the results. Examples: - `$select=appInfo` : select all devices having at least 1 appInfo, return them all and don’t return any meta property. - `$select=meta` : return only meta properties in the output. - `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all `appInfo`, plus meta object containing only firstSeen and lastSeen properties. The format is thus a comma separated list of properties to select. Use `appInfo` to select all appInfo properties, `meta` to select all meta properties. Use `appInfo/key` and `meta/key` to select specific appInfo and meta properties. Filter is a boolean expression that can look like the following examples: * `$filter=deviceId gt ’abcdef0123456789abcdef0123456789’‘ * `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge ’abcdef0123456789abcdef0123456789’) and (deviceId lt ‘bacdef0123456789abcdef0123456789’) and (lastModified gt 1447284263690L)‘ The first example is used automatically for paging when returning the `nextLink` property. The filter expression is a combination of checks on some properties that can be compared to their value. The available operators are: * `gt` : greater than * `ge` : greater than or equals * `lt` : less than * `le` : less than or equals * `and` : to add multiple checks (all checks must pass), optional parentheses can be used. The properties that can be used in the expression are the following: * `deviceId operator ’deviceIdValue‘` : a lexicographical comparison is made on the deviceId value, use single quotes for the value. * `lastModified operator numberL` : returns only meta properties or appInfo properties whose last value modification timestamp compared to the specified value is matching (value is milliseconds since January 1st, 1970 UTC). Please note the `L` character after the number of milliseconds, its required when the number of milliseconds exceeds `2^31 - 1` (which is always the case for recent timestamps). Using `lastModified` excludes all devices from the output that have no property matching the timestamp criteria, like `$select`. Please note that the internal value of `lastModified` timestamp for a given property is never part of the results. 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.

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

    Number of devices to return with each call. Defaults to

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

    By default all ‘meta` and `appInfo` properties are

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

    Filter can be used to reduce the number of results.

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

    A hash of custom headers that

Returns:

  • (DevicesQueryResult) —

    which provide lazy access to pages of the



813
814
815
816
817
818
819
820
821
822
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 813

def list_as_lazy(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil)
  response = list_async(resource_group_name, app_collection, app_name, top, select, filter, 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)
    end
    page
  end
end

#list_async(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil) ⇒ Concurrent::Promise

Query the information associated to the devices running an application.

100 and cannot return more. Passing a greater value is ignored. The response contains a ‘nextLink` property describing the URI path to get the next page of results if not all results could be returned at once. returned, this property is used to restrict the output to the desired properties. It also excludes all devices from the output that have none of the selected properties. In other terms, only devices having at least one of the selected property being set is part of the results. Examples: - `$select=appInfo` : select all devices having at least 1 appInfo, return them all and don’t return any meta property. - `$select=meta` : return only meta properties in the output. - `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all `appInfo`, plus meta object containing only firstSeen and lastSeen properties. The format is thus a comma separated list of properties to select. Use `appInfo` to select all appInfo properties, `meta` to select all meta properties. Use `appInfo/key` and `meta/key` to select specific appInfo and meta properties. Filter is a boolean expression that can look like the following examples: * `$filter=deviceId gt ’abcdef0123456789abcdef0123456789’‘ * `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge ’abcdef0123456789abcdef0123456789’) and (deviceId lt ‘bacdef0123456789abcdef0123456789’) and (lastModified gt 1447284263690L)‘ The first example is used automatically for paging when returning the `nextLink` property. The filter expression is a combination of checks on some properties that can be compared to their value. The available operators are: * `gt` : greater than * `ge` : greater than or equals * `lt` : less than * `le` : less than or equals * `and` : to add multiple checks (all checks must pass), optional parentheses can be used. The properties that can be used in the expression are the following: * `deviceId operator ’deviceIdValue‘` : a lexicographical comparison is made on the deviceId value, use single quotes for the value. * `lastModified operator numberL` : returns only meta properties or appInfo properties whose last value modification timestamp compared to the specified value is matching (value is milliseconds since January 1st, 1970 UTC). Please note the `L` character after the number of milliseconds, its required when the number of milliseconds exceeds `2^31 - 1` (which is always the case for recent timestamps). Using `lastModified` excludes all devices from the output that have no property matching the timestamp criteria, like `$select`. Please note that the internal value of `lastModified` timestamp for a given property is never part of the results. 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.

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

    Number of devices to return with each call. Defaults to

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

    By default all ‘meta` and `appInfo` properties are

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

    Filter can be used to reduce the number of results.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 186

def list_async(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = 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?


  request_headers = {}

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

  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,'$top' => top,'$select' => select,'$filter' => filter},
      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::DevicesQueryResult.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) ⇒ DevicesQueryResult

Query the information associated to the devices running an application.

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:

  • (DevicesQueryResult) —

    operation results.



684
685
686
687
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 684

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

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

Query the information associated to the devices running an application.

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.



713
714
715
716
717
718
719
720
721
722
723
724
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
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 713

def list_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{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::DevicesQueryResult.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

Query the information associated to the devices running an application.

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.



699
700
701
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 699

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

#list_with_http_info(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Query the information associated to the devices running an application.

100 and cannot return more. Passing a greater value is ignored. The response contains a ‘nextLink` property describing the URI path to get the next page of results if not all results could be returned at once. returned, this property is used to restrict the output to the desired properties. It also excludes all devices from the output that have none of the selected properties. In other terms, only devices having at least one of the selected property being set is part of the results. Examples: - `$select=appInfo` : select all devices having at least 1 appInfo, return them all and don’t return any meta property. - `$select=meta` : return only meta properties in the output. - `$select=appInfo,meta/firstSeen,meta/lastSeen` : return all `appInfo`, plus meta object containing only firstSeen and lastSeen properties. The format is thus a comma separated list of properties to select. Use `appInfo` to select all appInfo properties, `meta` to select all meta properties. Use `appInfo/key` and `meta/key` to select specific appInfo and meta properties. Filter is a boolean expression that can look like the following examples: * `$filter=deviceId gt ’abcdef0123456789abcdef0123456789’‘ * `$filter=lastModified le 1447284263690L` * `$filter=(deviceId ge ’abcdef0123456789abcdef0123456789’) and (deviceId lt ‘bacdef0123456789abcdef0123456789’) and (lastModified gt 1447284263690L)‘ The first example is used automatically for paging when returning the `nextLink` property. The filter expression is a combination of checks on some properties that can be compared to their value. The available operators are: * `gt` : greater than * `ge` : greater than or equals * `lt` : less than * `le` : less than or equals * `and` : to add multiple checks (all checks must pass), optional parentheses can be used. The properties that can be used in the expression are the following: * `deviceId operator ’deviceIdValue‘` : a lexicographical comparison is made on the deviceId value, use single quotes for the value. * `lastModified operator numberL` : returns only meta properties or appInfo properties whose last value modification timestamp compared to the specified value is matching (value is milliseconds since January 1st, 1970 UTC). Please note the `L` character after the number of milliseconds, its required when the number of milliseconds exceeds `2^31 - 1` (which is always the case for recent timestamps). Using `lastModified` excludes all devices from the output that have no property matching the timestamp criteria, like `$select`. Please note that the internal value of `lastModified` timestamp for a given property is never part of the results. 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.

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

    Number of devices to return with each call. Defaults to

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

    By default all ‘meta` and `appInfo` properties are

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

    Filter can be used to reduce the number of results.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



131
132
133
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 131

def list_with_http_info(resource_group_name, app_collection, app_name, top = nil, select = nil, filter = nil, custom_headers = nil)
  list_async(resource_group_name, app_collection, app_name, top, select, filter, custom_headers).value!
end

#tag_by_device_id(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ DeviceTagsResult

Update the tags registered for a set of devices running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DeviceTagsResult) —

    operation results.



455
456
457
458
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 455

def tag_by_device_id(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  response = tag_by_device_id_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

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

Update the tags registered for a set of devices running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 494

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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

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

  # Serialize Request
  request_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::DeviceTagsParameters.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/tag'

  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 == 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::DeviceTagsResult.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

#tag_by_device_id_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Update the tags registered for a set of devices running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



475
476
477
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 475

def tag_by_device_id_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  tag_by_device_id_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
end

#tag_by_user_id(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ DeviceTagsResult

Update the tags registered for a set of users running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DeviceTagsResult) —

    operation results.



572
573
574
575
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 572

def tag_by_user_id(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  response = tag_by_user_id_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

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

Update the tags registered for a set of users running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
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
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 611

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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

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

  # Serialize Request
  request_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::DeviceTagsParameters.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}/users/tag'

  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 == 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::DeviceTagsResult.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

#tag_by_user_id_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Update the tags registered for a set of users running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the modifications appear in the results of the Get device command.

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 (DeviceTagsParameters)
  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



592
593
594
 
# File 'lib/2014-12-01/generated/azure_mgmt_mobile_engagement/devices.rb', line 592

def tag_by_user_id_with_http_info(resource_group_name, app_collection, app_name, parameters, custom_headers = nil)
  tag_by_user_id_async(resource_group_name, app_collection, app_name, parameters, custom_headers).value!
end