Class: Azure::EdgeGateway::Mgmt::V2019_03_01::Roles

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb

Overview

Roles

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Roles

Creates and initializes a new instance of the Roles class.



17
18
19
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataBoxEdgeManagementClient (readonly) 



22
23
24
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(device_name, name, role, resource_group_name, custom_headers: nil) ⇒ Role

Create or update a role.

will be added to the HTTP request.



310
311
312
313
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 310

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

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

Create or update a role.

to the HTTP request.



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 343

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::EdgeGateway::Mgmt::V2019_03_01::Models::Role.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, role, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update a role.

will be added to the HTTP request.



327
328
329
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 327

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

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

Deletes the role on the data box edge device.

will be added to the HTTP request.



415
416
417
418
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 415

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 role on the data box edge device.

to the HTTP request.



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 446

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}/roles/{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
  end

  promise.execute
end

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

Deletes the role on the data box edge device.

will be added to the HTTP request.



431
432
433
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 431

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, role, resource_group_name, custom_headers: nil) ⇒ Role

Create or update a role.

will be added to the HTTP request.



224
225
226
227
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 224

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

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

will be added to the HTTP request.

response.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 240

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

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::EdgeGateway::Mgmt::V2019_03_01::Models::Role.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 role on the data box edge device.

will be added to the HTTP request.



267
268
269
270
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 267

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.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 282

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

Gets a specific role by name.

will be added to the HTTP request.



127
128
129
130
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 127

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 specific role by name.

to the HTTP request.



158
159
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
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 158

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}/roles/{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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::EdgeGateway::Mgmt::V2019_03_01::Models::Role.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 specific role by name.

will be added to the HTTP request.



143
144
145
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 143

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

Lists all the roles configured in a data box edge/gateway device.

will be added to the HTTP request.



34
35
36
37
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.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) ⇒ RoleList

Lists all the roles configured in a data box edge/gateway device.

will be added to the HTTP request.



588
589
590
591
592
593
594
595
596
597
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 588

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 roles configured in a data box edge/gateway device.

to the HTTP request.



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
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.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}/roles'

  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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::EdgeGateway::Mgmt::V2019_03_01::Models::RoleList.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) ⇒ RoleList

Lists all the roles configured in a data box edge/gateway device.

to List operation. will be added to the HTTP request.



500
501
502
503
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 500

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 roles configured in a data box edge/gateway device.

to List operation. to the HTTP request.



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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 529

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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::EdgeGateway::Mgmt::V2019_03_01::Models::RoleList.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 roles configured in a data box edge/gateway device.

to List operation. will be added to the HTTP request.



515
516
517
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.rb', line 515

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 roles configured in a data box edge/gateway device.

will be added to the HTTP request.



49
50
51
 
# File 'lib/2019-03-01/generated/azure_mgmt_edgegateway/roles.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