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

#clientNetworkManagementClient (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

Creates or updates an express route circuit.

update express route circuit 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 create or

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

    A hash of custom headers that

Returns:



792
793
794
795
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 792

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

Creates or updates an express route circuit.

update express route circuit 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 create or

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



825
826
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
883
884
885
886
887
888
889
890
891
892
893
894
895
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 825

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      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 == 201 || status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 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

Creates or updates an express route circuit.

update express route circuit 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 create or

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

Deletes the specified express route circuit.

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



709
710
711
712
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 709

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

Deletes the specified express route circuit.

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.



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 738

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      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 == 204 || 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
  end

  promise.execute
end

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

Deletes the specified express route circuit.

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.



724
725
726
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 724

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

Gets the currently advertised ARP table associated with the express route circuit 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 express route 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:



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

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

Gets the currently advertised ARP table associated with the express route circuit 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 express route 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.



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
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 945

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # 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

Gets the currently advertised ARP table associated with the express route circuit 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 express route 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.



928
929
930
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 928

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

Gets the currently advertised routes table associated with the express route circuit 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 express route 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:



1012
1013
1014
1015
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1012

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

Gets the currently advertised routes table associated with the express route circuit 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 express route 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.



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
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1047

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # 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

Gets the currently advertised routes table summary associated with the express route circuit 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 express route 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:



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

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

Gets the currently advertised routes table summary associated with the express route circuit 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 express route 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.



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
1196
1197
1198
1199
1200
1201
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1149

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # 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

Gets the currently advertised routes table summary associated with the express route circuit 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 express route 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.



1132
1133
1134
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1132

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

Gets the currently advertised routes table associated with the express route circuit 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 express route 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.



1030
1031
1032
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1030

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

Creates or updates an express route circuit.

update express route circuit 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 create or

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

    A hash of custom headers that

Returns:



169
170
171
172
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 169

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

update express route circuit 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 create or

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 185

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

Deletes the specified express route circuit.

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



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

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



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

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

Gets information about the specified express route circuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • circuit_name (String)

    The name of express route circuit.

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

    A hash of custom headers that

Returns:



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

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

Gets information about the specified express route circuit.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • circuit_name (String)

    The name of 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.



105
106
107
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
152
153
154
155
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 105

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}'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = 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

Gets all stats from an express route circuit 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 express route circuit.

  • peering_name (String)

    The name of the peering.

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

    A hash of custom headers that

Returns:



446
447
448
449
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 446

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

Gets all stats from an express route circuit 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 express route 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.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 477

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'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = 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

Gets all stats from an express route circuit 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 express route 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.



462
463
464
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 462

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

Gets all the stats from an express route circuit 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 express route circuit.

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

    A hash of custom headers that

Returns:



354
355
356
357
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 354

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

Gets all the stats from an express route circuit 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 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.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 383

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'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = 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

Gets all the stats from an express route circuit 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 express route circuit.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



369
370
371
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 369

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

Gets information about the specified express route circuit.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • circuit_name (String)

    The name of express route circuit.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



91
92
93
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 91

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>

Gets all the express route circuits 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:



539
540
541
542
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 539

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>

Gets all the express route circuits 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:



625
626
627
628
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 625

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

Gets all the express route circuits in a subscription.

will be added to the HTTP request.

the response.

Parameters:

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

    A hash of custom headers that

Returns:



1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1407

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_page_link|
      list_all_next_async(next_page_link, custom_headers)
    end
    page
  end
end

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

Gets all the express route circuits 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.



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 650

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'

  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?
    # 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

Gets all the express route circuits in a subscription.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:



1300
1301
1302
1303
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1300

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

Gets all the express route circuits in a subscription.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
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
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1329

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}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = 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

Gets all the express route circuits in a subscription.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



1315
1316
1317
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1315

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

Gets all the express route circuits 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.



638
639
640
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 638

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

Gets the currently advertised ARP table associated with the express route circuit 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 express route 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:



216
217
218
219
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 216

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 express route 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



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 232

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

Gets all the express route circuits in a resource group.

will be added to the HTTP request.

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:



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1387

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_page_link|
      list_next_async(next_page_link, custom_headers)
    end
    page
  end
end

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

Gets all the express route circuits 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.



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 566

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'

  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?
    # 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

Gets all the express route circuits in a resource group.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:



1213
1214
1215
1216
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1213

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

Gets all the express route circuits in a resource group.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
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
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 1242

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}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = 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

Gets all the express route circuits in a resource group.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



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

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

Gets the currently advertised routes table associated with the express route circuit 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 express route 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:



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

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 express route 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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 279

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

Gets the currently advertised routes table summary associated with the express route circuit 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 express route 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:



310
311
312
313
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 310

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 express route 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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 326

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

Gets all the express route circuits 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.



553
554
555
# File 'lib/generated/azure_mgmt_network/express_route_circuits.rb', line 553

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