Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::Users

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb

Overview

Users

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Users

Creates and initializes a new instance of the Users class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataBoxEdgeManagementClient (readonly)

Returns reference to the DataBoxEdgeManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(device_name, name, user, resource_group_name, custom_headers: nil) ⇒ User

Creates a new user or updates an existing user’s information on a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • user (User) —

    The user details.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (User) —

    operation results.



322
323
324
325
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 322

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

#begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new user or updates an existing user’s information on a Data Box Edge/Data Box Gateway device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • user (User) —

    The user details.

  • resource_group_name (String) —

    The resource group name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 357

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


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

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

  # Serialize Request
  request_mapper = Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::User.mapper()
  request_content = @client.serialize(request_mapper,  user)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataBoxEdge::Mgmt::V2019_08_01::Models::User.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(device_name, name, user, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new user or updates an existing user’s information on a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • user (User) —

    The user details.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



340
341
342
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 340

def begin_create_or_update_with_http_info(device_name, name, user, resource_group_name, custom_headers:nil)
  begin_create_or_update_async(device_name, name, user, resource_group_name, custom_headers:custom_headers).value!
end

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

Deletes the user on a databox edge/gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



431
432
433
434
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 431

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

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

Deletes the user on a databox edge/gateway device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 462

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


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

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

Deletes the user on a databox edge/gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



447
448
449
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 447

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

#create_or_update(device_name, name, user, resource_group_name, custom_headers: nil) ⇒ User

Creates a new user or updates an existing user’s information on a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • user (User) —

    The user details.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (User) —

    operation results.



235
236
237
238
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 235

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

#create_or_update_async(device_name, name, user, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • user (User) —

    The user details.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 251

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

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

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

  promise
end

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

Deletes the user on a databox edge/gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



278
279
280
281
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 278

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

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

will be added to the HTTP request.

response.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 293

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

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

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

  promise
end

#get(device_name, name, resource_group_name, custom_headers: nil) ⇒ User

Gets the properties of the specified user.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (User) —

    operation results.



135
136
137
138
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 135

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

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

Gets the properties of the specified user.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 166

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


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataBoxEdge::Mgmt::V2019_08_01::Models::User.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(device_name, name, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the properties of the specified user.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The user name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



151
152
153
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 151

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

#list_by_data_box_edge_device(device_name, resource_group_name, filter: nil, custom_headers: nil) ⇒ Array<User>

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

type property will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    Specify $filter=‘UserType eq <type>’ to filter on user

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

    A hash of custom headers that

Returns:

  • (Array<User>) —

    operation results.



36
37
38
39
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 36

def list_by_data_box_edge_device(device_name, resource_group_name, filter:nil, custom_headers:nil)
  first_page = list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, filter: nil, custom_headers: nil) ⇒ UserList

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

type property will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    Specify $filter=‘UserType eq <type>’ to filter on user

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

    A hash of custom headers that

Returns:

  • (UserList) —

    which provide lazy access to pages of the response.



610
611
612
613
614
615
616
617
618
619
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 610

def list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, filter:nil, custom_headers:nil)
  response = list_by_data_box_edge_device_async(device_name, resource_group_name, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_data_box_edge_device_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_data_box_edge_device_async(device_name, resource_group_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

type property to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    Specify $filter=‘UserType eq <type>’ to filter on user

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 69

def list_by_data_box_edge_device_async(device_name, resource_group_name, filter:nil, custom_headers:nil)
  fail ArgumentError, 'device_name is nil' if device_name.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, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'deviceName' => device_name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      query_params: {'api-version' => @client.api_version,'$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 MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataBoxEdge::Mgmt::V2019_08_01::Models::UserList.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_by_data_box_edge_device_next(next_page_link, custom_headers: nil) ⇒ UserList

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

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:

  • (UserList) —

    operation results.



518
519
520
521
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 518

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

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

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

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.



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
594
595
596
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 547

def list_by_data_box_edge_device_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DataBoxEdge::Mgmt::V2019_08_01::Models::UserList.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_by_data_box_edge_device_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

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.



533
534
535
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 533

def list_by_data_box_edge_device_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_data_box_edge_device_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_data_box_edge_device_with_http_info(device_name, resource_group_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

type property will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    Specify $filter=‘UserType eq <type>’ to filter on user

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/users.rb', line 53

def list_by_data_box_edge_device_with_http_info(device_name, resource_group_name, filter:nil, custom_headers:nil)
  list_by_data_box_edge_device_async(device_name, resource_group_name, filter:filter, custom_headers:custom_headers).value!
end