Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::Shares

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

Overview

Shares

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Shares

Creates and initializes a new instance of the Shares class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.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/shares.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(device_name, name, share, resource_group_name, custom_headers: nil) ⇒ Share

Creates a new share or updates an existing share on the device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • share (Share) —

    The share properties.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Share) —

    operation results.



354
355
356
357
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 354

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

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

Creates a new share or updates an existing share on the device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • share (Share) —

    The share properties.

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



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
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 387

def begin_create_or_update_async(device_name, name, share, 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, 'share is nil' if share.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::Share.mapper()
  request_content = @client.serialize(request_mapper,  share)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{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::Share.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, share, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new share or updates an existing share on the device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • share (Share) —

    The share properties.

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



371
372
373
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 371

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

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

Deletes the share on the Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



461
462
463
464
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 461

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 share on the Data Box Edge/Data Box Gateway device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 492

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}/shares/{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 share on the Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



477
478
479
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 477

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

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

Refreshes the share metadata with the data from the cloud.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



548
549
550
551
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 548

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

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

Refreshes the share metadata with the data from the cloud.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 579

def begin_refresh_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}/shares/{name}/refresh'

  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(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.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_refresh_with_http_info(device_name, name, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Refreshes the share metadata with the data from the cloud.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



564
565
566
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 564

def begin_refresh_with_http_info(device_name, name, resource_group_name, custom_headers:nil)
  begin_refresh_async(device_name, name, resource_group_name, custom_headers:custom_headers).value!
end

#create_or_update(device_name, name, share, resource_group_name, custom_headers: nil) ⇒ Share

Creates a new share or updates an existing share on the device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • share (Share) —

    The share properties.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Share) —

    operation results.



228
229
230
231
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 228

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

#create_or_update_async(device_name, name, share, 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 share name.

  • share (Share) —

    The share properties.

  • 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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 244

def create_or_update_async(device_name, name, share, resource_group_name, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(device_name, name, share, 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::Share.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 share on the Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



271
272
273
274
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 271

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 share 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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 286

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) ⇒ Share

Gets a share by name.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Share) —

    operation results.



129
130
131
132
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 129

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 a share by name.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



160
161
162
163
164
165
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
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 160

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}/shares/{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::Share.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 a share by name.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share 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.



145
146
147
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 145

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, custom_headers: nil) ⇒ Array<Share>

Lists all the shares in a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Array<Share>) —

    operation results.



34
35
36
37
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 34

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

#list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, custom_headers: nil) ⇒ ShareList

Lists all the shares in a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (ShareList) —

    which provide lazy access to pages of the response.



725
726
727
728
729
730
731
732
733
734
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 725

def list_by_data_box_edge_device_as_lazy(device_name, resource_group_name, custom_headers:nil)
  response = list_by_data_box_edge_device_async(device_name, resource_group_name, 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, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the shares in a Data Box Edge/Data Box Gateway device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device 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.



63
64
65
66
67
68
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
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 63

def list_by_data_box_edge_device_async(device_name, resource_group_name, 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}/shares'

  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},
      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::ShareList.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) ⇒ ShareList

Lists all the shares in 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:

  • (ShareList) —

    operation results.



635
636
637
638
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 635

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

Lists all the shares in 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.



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
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 664

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::ShareList.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

Lists all the shares in 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.



650
651
652
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 650

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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the shares in a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device 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.



49
50
51
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 49

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

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

Refreshes the share metadata with the data from the cloud.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The share name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that



311
312
313
314
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 311

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

#refresh_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 share 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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/shares.rb', line 326

def refresh_async(device_name, name, resource_group_name, custom_headers:nil)
  # Send request
  promise = begin_refresh_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