Class: Azure::ARM::Network::ExpressRouteCircuits

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_network/express_route_circuits.rb

Overview

The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resrources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ExpressRouteCircuits

Creates and initializes a new instance of the ExpressRouteCircuits class.

Parameters:

  • client —

    service class for accessing basic functionality.



21
22
23
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



26
27
28
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 26

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, circuit_name, parameters, custom_headers = nil) ⇒ ExpressRouteCircuit

The Put ExpressRouteCircuit operation creates/updates a ExpressRouteCircuit

create/delete ExpressRouteCircuit operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • parameters (ExpressRouteCircuit) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:



308
309
310
311
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 308

def begin_create_or_update(resource_group_name, circuit_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put ExpressRouteCircuit operation creates/updates a ExpressRouteCircuit

create/delete ExpressRouteCircuit operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • parameters (ExpressRouteCircuit) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 341

def begin_create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_name.nil?
  fail ArgumentError, 'parameters is nil' if 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 = {}

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

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

  # Serialize Request
  request_mapper = ExpressRouteCircuit.mapper()
  request_content = @client.serialize(request_mapper,  parameters, 'parameters')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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 == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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, circuit_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Put ExpressRouteCircuit operation creates/updates a ExpressRouteCircuit

create/delete ExpressRouteCircuit operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • parameters (ExpressRouteCircuit) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



325
326
327
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 325

def begin_create_or_update_with_http_info(resource_group_name, circuit_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, circuit_name, custom_headers = nil) ⇒ Object

The delete ExpressRouteCircuit operation deletes the specified ExpressRouteCircuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the express route Circuit.

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

    A hash of custom headers that



77
78
79
80
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 77

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

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

The delete ExpressRouteCircuit operation deletes the specified ExpressRouteCircuit.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the express route Circuit.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 108

def begin_delete_async(resource_group_name, circuit_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_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 = {}

  # 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/expressRouteCircuits/{circuitName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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(resource_group_name, circuit_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The delete ExpressRouteCircuit operation deletes the specified ExpressRouteCircuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the express route Circuit.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



93
94
95
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 93

def begin_delete_with_http_info(resource_group_name, circuit_name, custom_headers = nil)
  begin_delete_async(resource_group_name, circuit_name, custom_headers).value!
end

#begin_list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsArpTableListResult

The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



478
479
480
481
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 478

def begin_list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = begin_list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#begin_list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 515

def begin_list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_name.nil?
  fail ArgumentError, 'peering_name is nil' if peering_name.nil?
  fail ArgumentError, 'device_path is nil' if device_path.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 = {}

  # 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/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'peeringName' => peering_name,'devicePath' => device_path,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitsArpTableListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_list_arp_table_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



497
498
499
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 497

def begin_list_arp_table_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  begin_list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
end

#begin_list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsRoutesTableListResult

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



634
635
636
637
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 634

def begin_list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = begin_list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#begin_list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 671

def begin_list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_name.nil?
  fail ArgumentError, 'peering_name is nil' if peering_name.nil?
  fail ArgumentError, 'device_path is nil' if device_path.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 = {}

  # 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/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'peeringName' => peering_name,'devicePath' => device_path,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitsRoutesTableListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsRoutesTableSummaryListResult

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



790
791
792
793
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 790

def begin_list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = begin_list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#begin_list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 827

def begin_list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_name.nil?
  fail ArgumentError, 'peering_name is nil' if peering_name.nil?
  fail ArgumentError, 'device_path is nil' if device_path.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 = {}

  # 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/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'peeringName' => peering_name,'devicePath' => device_path,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitsRoutesTableSummaryListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_list_routes_table_summary_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



809
810
811
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 809

def begin_list_routes_table_summary_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  begin_list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
end

#begin_list_routes_table_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



653
654
655
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 653

def begin_list_routes_table_with_http_info(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  begin_list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
end

#create_or_update(resource_group_name, circuit_name, parameters, custom_headers = nil) ⇒ ExpressRouteCircuit

The Put ExpressRouteCircuit operation creates/updates a ExpressRouteCircuit

create/delete ExpressRouteCircuit operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • parameters (ExpressRouteCircuit) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:



262
263
264
265
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 262

def create_or_update(resource_group_name, circuit_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

create/delete ExpressRouteCircuit operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • parameters (ExpressRouteCircuit) —

    Parameters supplied to the

  • 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/generated/azure_mgmt_network/express_route_circuits.rb', line 278

def create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, circuit_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = ExpressRouteCircuit.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#delete(resource_group_name, circuit_name, custom_headers = nil) ⇒ Object

The delete ExpressRouteCircuit operation deletes the specified ExpressRouteCircuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the express route Circuit.

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

    A hash of custom headers that



37
38
39
40
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 37

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

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

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the express route Circuit.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 51

def delete_async(resource_group_name, circuit_name, custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, circuit_name, 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, circuit_name, custom_headers = nil) ⇒ ExpressRouteCircuit

The Get ExpressRouteCircuit operation retreives information about the specified ExpressRouteCircuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    A hash of custom headers that

Returns:



164
165
166
167
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 164

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

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

The Get ExpressRouteCircuit operation retreives information about the specified ExpressRouteCircuit.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 195

def get_async(resource_group_name, circuit_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_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 = {}

  # 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/expressRouteCircuits/{circuitName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_peering_stats(resource_group_name, circuit_name, peering_name, custom_headers = nil) ⇒ ExpressRouteCircuitStats

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

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

    A hash of custom headers that

Returns:



993
994
995
996
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 993

def get_peering_stats(resource_group_name, circuit_name, peering_name, custom_headers = nil)
  response = get_peering_stats_async(resource_group_name, circuit_name, peering_name, custom_headers).value!
  response.body unless response.nil?
end

#get_peering_stats_async(resource_group_name, circuit_name, peering_name, custom_headers = nil) ⇒ Concurrent::Promise

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1026

def get_peering_stats_async(resource_group_name, circuit_name, peering_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_name.nil?
  fail ArgumentError, 'peering_name is nil' if peering_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 = {}

  # 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/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'peeringName' => peering_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitStats.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_peering_stats_with_http_info(resource_group_name, circuit_name, peering_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1010
1011
1012
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1010

def get_peering_stats_with_http_info(resource_group_name, circuit_name, peering_name, custom_headers = nil)
  get_peering_stats_async(resource_group_name, circuit_name, peering_name, custom_headers).value!
end

#get_stats(resource_group_name, circuit_name, custom_headers = nil) ⇒ ExpressRouteCircuitStats

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    A hash of custom headers that

Returns:



895
896
897
898
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 895

def get_stats(resource_group_name, circuit_name, custom_headers = nil)
  response = get_stats_async(resource_group_name, circuit_name, custom_headers).value!
  response.body unless response.nil?
end

#get_stats_async(resource_group_name, circuit_name, custom_headers = nil) ⇒ Concurrent::Promise

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 926

def get_stats_async(resource_group_name, circuit_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'circuit_name is nil' if circuit_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 = {}

  # 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/expressRouteCircuits/{circuitName}/stats'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'circuitName' => circuit_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitStats.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_stats_with_http_info(resource_group_name, circuit_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Liststats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



911
912
913
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 911

def get_stats_with_http_info(resource_group_name, circuit_name, custom_headers = nil)
  get_stats_async(resource_group_name, circuit_name, custom_headers).value!
end

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

The Get ExpressRouteCircuit operation retreives information about the specified ExpressRouteCircuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



180
181
182
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 180

def get_with_http_info(resource_group_name, circuit_name, custom_headers = nil)
  get_async(resource_group_name, circuit_name, custom_headers).value!
end

#list(resource_group_name, custom_headers = nil) ⇒ Array<ExpressRouteCircuit>

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a 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:



1114
1115
1116
1117
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1114

def list(resource_group_name, custom_headers = nil)
  first_page = list_as_lazy(resource_group_name, custom_headers)
  first_page.get_all_items
end

#list_all(custom_headers = nil) ⇒ Array<ExpressRouteCircuit>

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:



1227
1228
1229
1230
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1227

def list_all(custom_headers = nil)
  first_page = list_all_as_lazy(custom_headers)
  first_page.get_all_items
end

#list_all_as_lazy(custom_headers = nil) ⇒ ExpressRouteCircuitListResult

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.

will be added to the HTTP request.

of the response.

Parameters:

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

    A hash of custom headers that

Returns:



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1207

def list_all_as_lazy(custom_headers = nil)
  response = list_all_async(custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_all_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_all_async(custom_headers = nil) ⇒ Concurrent::Promise

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a 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.



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1254

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

  # 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/expressRouteCircuits'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_all_next(next_page_link, custom_headers = nil) ⇒ ExpressRouteCircuitListResult

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



1411
1412
1413
1414
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1411

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

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

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1442

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


  request_headers = {}

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

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_all_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1427
1428
1429
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1427

def list_all_next_with_http_info(next_page_link, custom_headers = nil)
  list_all_next_async(next_page_link, custom_headers).value!
end

#list_all_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a 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.



1241
1242
1243
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1241

def list_all_with_http_info(custom_headers = nil)
  list_all_async(custom_headers).value!
end

#list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsArpTableListResult

The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



430
431
432
433
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 430

def list_arp_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 446

def list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  # Send request
  promise = begin_list_arp_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = ExpressRouteCircuitsArpTableListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#list_as_lazy(resource_group_name, custom_headers = nil) ⇒ ExpressRouteCircuitListResult

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

of the response.

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:



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1093

def list_as_lazy(resource_group_name, custom_headers = nil)
  response = list_async(resource_group_name, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_link|
      list_next_async(next_link, custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a 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.



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1143

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

  # 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/expressRouteCircuits'
  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 || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers = nil) ⇒ ExpressRouteCircuitListResult

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



1318
1319
1320
1321
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1318

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

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

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1349

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


  request_headers = {}

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

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1334
1335
1336
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1334

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

#list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsRoutesTableListResult

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



586
587
588
589
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 586

def list_routes_table(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 602

def list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  # Send request
  promise = begin_list_routes_table_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = ExpressRouteCircuitsRoutesTableListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ ExpressRouteCircuitsRoutesTableSummaryListResult

The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:



742
743
744
745
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 742

def list_routes_table_summary(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  response = list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers).value!
  response.body unless response.nil?
end

#list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • circuit_name (String) —

    The name of the circuit.

  • peering_name (String) —

    The name of the peering.

  • device_path (String) —

    The path of the device.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 758

def list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers = nil)
  # Send request
  promise = begin_list_routes_table_summary_async(resource_group_name, circuit_name, peering_name, device_path, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = ExpressRouteCircuitsRoutesTableSummaryListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response, 'parsed_response')
    end

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

  promise
end

#list_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a 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.



1129
1130
1131
 
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1129

def list_with_http_info(resource_group_name, custom_headers = nil)
  list_async(resource_group_name, custom_headers).value!
end