Class: Azure::Network::Mgmt::V2020_08_01::ExpressRouteGateways

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb

Overview

ExpressRouteGateways

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ExpressRouteGateways

Creates and initializes a new instance of the ExpressRouteGateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers: nil) ⇒ ExpressRouteGateway

Creates or updates a ExpressRoute gateway in a specified resource group.

gateway. required in an ExpressRoute gateway PUT operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

  • put_express_route_gateway_parameters (ExpressRouteGateway) —

    Parameters

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGateway) —

    operation results.



448
449
450
451
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 448

def begin_create_or_update(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a ExpressRoute gateway in a specified resource group.

gateway. required in an ExpressRoute gateway PUT operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

  • put_express_route_gateway_parameters (ExpressRouteGateway) —

    Parameters

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



483
484
485
486
487
488
489
490
491
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 483

def begin_create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'express_route_gateway_name is nil' if express_route_gateway_name.nil?
  fail ArgumentError, 'put_express_route_gateway_parameters is nil' if put_express_route_gateway_parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.mapper()
  request_content = @client.serialize(request_mapper,  put_express_route_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'expressRouteGatewayName' => express_route_gateway_name,'subscriptionId' => @client.subscription_id},
      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 == 201
      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::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.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(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a ExpressRoute gateway in a specified resource group.

gateway. required in an ExpressRoute gateway PUT operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

  • put_express_route_gateway_parameters (ExpressRouteGateway) —

    Parameters

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



466
467
468
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 466

def begin_create_or_update_with_http_info(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, express_route_gateway_name, custom_headers: nil) ⇒ Object

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that



679
680
681
682
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 679

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

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

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

gateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 714

def begin_delete_async(resource_group_name, express_route_gateway_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'express_route_gateway_name is nil' if express_route_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'expressRouteGatewayName' => express_route_gateway_name,'subscriptionId' => @client.subscription_id},
      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(resource_group_name, express_route_gateway_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



697
698
699
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 697

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

#begin_update_tags(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers: nil) ⇒ ExpressRouteGateway

Updates express route gateway tags.

ExpressRouteGateway. update a virtual wan express route gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • express_route_gateway_name (String) —

    The name of the gateway.

  • express_route_gateway_parameters (TagsObject) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGateway) —

    operation results.



569
570
571
572
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 569

def begin_update_tags(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:nil)
  response = begin_update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates express route gateway tags.

ExpressRouteGateway. update a virtual wan express route gateway tags. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • express_route_gateway_name (String) —

    The name of the gateway.

  • express_route_gateway_parameters (TagsObject) —

    Parameters supplied to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



604
605
606
607
608
609
610
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
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 604

def begin_update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_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, 'express_route_gateway_name is nil' if express_route_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'express_route_gateway_parameters is nil' if express_route_gateway_parameters.nil?


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

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::TagsObject.mapper()
  request_content = @client.serialize(request_mapper,  express_route_gateway_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}'

  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,'expressRouteGatewayName' => express_route_gateway_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(:patch, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 202 || 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::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.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_update_tags_with_http_info(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates express route gateway tags.

ExpressRouteGateway. update a virtual wan express route gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • express_route_gateway_name (String) —

    The name of the gateway.

  • express_route_gateway_parameters (TagsObject) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



587
588
589
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 587

def begin_update_tags_with_http_info(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:nil)
  begin_update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers: nil) ⇒ ExpressRouteGateway

Creates or updates a ExpressRoute gateway in a specified resource group.

gateway. required in an ExpressRoute gateway PUT operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

  • put_express_route_gateway_parameters (ExpressRouteGateway) —

    Parameters

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGateway) —

    operation results.



213
214
215
216
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 213

def create_or_update(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

gateway. required in an ExpressRoute gateway PUT operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

  • put_express_route_gateway_parameters (ExpressRouteGateway) —

    Parameters

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 230

def create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, express_route_gateway_name, put_express_route_gateway_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.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(resource_group_name, express_route_gateway_name, custom_headers: nil) ⇒ Object

Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.

gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that



404
405
406
407
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 404

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

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

gateway. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 419

def delete_async(resource_group_name, express_route_gateway_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, express_route_gateway_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(resource_group_name, express_route_gateway_name, custom_headers: nil) ⇒ ExpressRouteGateway

Fetches the details of a ExpressRoute gateway in a resource group.

gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGateway) —

    operation results.



307
308
309
310
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 307

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

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

Fetches the details of a ExpressRoute gateway in a resource group.

gateway. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 338

def get_async(resource_group_name, express_route_gateway_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'express_route_gateway_name is nil' if express_route_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'expressRouteGatewayName' => express_route_gateway_name,'subscriptionId' => @client.subscription_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 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::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, express_route_gateway_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Fetches the details of a ExpressRoute gateway in a resource group.

gateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • express_route_gateway_name (String) —

    The name of the ExpressRoute

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



323
324
325
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 323

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

#list_by_resource_group(resource_group_name, custom_headers: nil) ⇒ ExpressRouteGatewayList

Lists ExpressRoute gateways in a given resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGatewayList) —

    operation results.



119
120
121
122
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 119

def list_by_resource_group(resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_resource_group_async(resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists ExpressRoute gateways in a given resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 146

def list_by_resource_group_async(resource_group_name, custom_headers: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?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_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 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::Network::Mgmt::V2020_08_01::Models::ExpressRouteGatewayList.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_resource_group_with_http_info(resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists ExpressRoute gateways in a given resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



133
134
135
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 133

def list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
end

#list_by_subscription(custom_headers: nil) ⇒ ExpressRouteGatewayList

Lists ExpressRoute gateways under a given subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGatewayList) —

    operation results.



32
33
34
35
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 32

def list_by_subscription(custom_headers:nil)
  response = list_by_subscription_async(custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_subscription_async(custom_headers: nil) ⇒ Concurrent::Promise

Lists ExpressRoute gateways under a given subscription.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



57
58
59
60
61
62
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
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 57

def list_by_subscription_async(custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


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

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

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_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 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::Network::Mgmt::V2020_08_01::Models::ExpressRouteGatewayList.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_subscription_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists ExpressRoute gateways under a given subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



45
46
47
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 45

def list_by_subscription_with_http_info(custom_headers:nil)
  list_by_subscription_async(custom_headers:custom_headers).value!
end

#update_tags(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers: nil) ⇒ ExpressRouteGateway

Updates express route gateway tags.

ExpressRouteGateway. update a virtual wan express route gateway tags. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • express_route_gateway_name (String) —

    The name of the gateway.

  • express_route_gateway_parameters (TagsObject) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (ExpressRouteGateway) —

    operation results.



261
262
263
264
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 261

def update_tags(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:nil)
  response = update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers: nil) ⇒ Concurrent::Promise

ExpressRouteGateway. update a virtual wan express route gateway tags. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name of the

  • express_route_gateway_name (String) —

    The name of the gateway.

  • express_route_gateway_parameters (TagsObject) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_gateways.rb', line 278

def update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:nil)
  # Send request
  promise = begin_update_tags_async(resource_group_name, express_route_gateway_name, express_route_gateway_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteGateway.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