Class: Azure::Network::Mgmt::V2020_08_01::ExpressRouteCircuits

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

Overview

ExpressRouteCircuits

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.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



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

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:

  • (ExpressRouteCircuit)

    operation results.



914
915
916
917
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 914

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



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
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 947

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
  request_content = @client.serialize(request_mapper,  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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, 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.



931
932
933
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 931

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



828
829
830
831
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 828

def begin_delete(resource_group_name, circuit_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, circuit_name, custom_headers: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.



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
896
897
898
899
900
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 857

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, 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.



843
844
845
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 843

def begin_delete_with_http_info(resource_group_name, circuit_name, custom_headers:nil)
  begin_delete_async(resource_group_name, circuit_name, custom_headers: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:

  • (ExpressRouteCircuitsArpTableListResult)

    operation results.



1033
1034
1035
1036
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1033

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



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
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1068

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsArpTableListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_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.



1051
1052
1053
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1051

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

  • (ExpressRouteCircuitsRoutesTableListResult)

    operation results.



1138
1139
1140
1141
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1138

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



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
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1173

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsRoutesTableListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_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:

  • (ExpressRouteCircuitsRoutesTableSummaryListResult)

    operation results.



1243
1244
1245
1246
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1243

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



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
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1278

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsRoutesTableSummaryListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_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.



1261
1262
1263
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1261

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



1156
1157
1158
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1156

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

  • (ExpressRouteCircuit)

    operation results.



168
169
170
171
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 168

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



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

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:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

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

  promise
end

#delete(resource_group_name, 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



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

def delete(resource_group_name, circuit_name, custom_headers:nil)
  response = delete_async(resource_group_name, circuit_name, custom_headers: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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 46

def delete_async(resource_group_name, circuit_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, circuit_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

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

  promise
end

#get(resource_group_name, 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:

  • (ExpressRouteCircuit)

    operation results.



72
73
74
75
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 72

def get(resource_group_name, circuit_name, custom_headers:nil)
  response = get_async(resource_group_name, circuit_name, custom_headers: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.



101
102
103
104
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
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 101

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_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:

  • (ExpressRouteCircuitStats)

    operation results.



556
557
558
559
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 556

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



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 587

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitStats.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_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.



572
573
574
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 572

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

  • (ExpressRouteCircuitStats)

    operation results.



461
462
463
464
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 461

def get_stats(resource_group_name, circuit_name, custom_headers:nil)
  response = get_stats_async(resource_group_name, circuit_name, custom_headers: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.



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 490

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitStats.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_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.



476
477
478
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 476

def get_stats_with_http_info(resource_group_name, circuit_name, custom_headers:nil)
  get_stats_async(resource_group_name, circuit_name, custom_headers: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.



87
88
89
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 87

def get_with_http_info(resource_group_name, circuit_name, custom_headers:nil)
  get_async(resource_group_name, circuit_name, custom_headers: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:

  • (Array<ExpressRouteCircuit>)

    operation results.



652
653
654
655
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 652

def list(resource_group_name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, custom_headers: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:

  • (Array<ExpressRouteCircuit>)

    operation results.



741
742
743
744
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 741

def list_all(custom_headers:nil)
  first_page = list_all_as_lazy(custom_headers: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:

  • (ExpressRouteCircuitListResult)

    which provide lazy access to pages of



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1545

def list_all_as_lazy(custom_headers:nil)
  response = list_all_async(custom_headers: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: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.



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 766

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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:

  • (ExpressRouteCircuitListResult)

    operation results.



1435
1436
1437
1438
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1435

def list_all_next(next_page_link, custom_headers:nil)
  response = list_all_next_async(next_page_link, custom_headers: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.



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
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1464

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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.



1450
1451
1452
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1450

def list_all_next_with_http_info(next_page_link, custom_headers:nil)
  list_all_next_async(next_page_link, custom_headers: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.



754
755
756
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 754

def list_all_with_http_info(custom_headers:nil)
  list_all_async(custom_headers: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:

  • (ExpressRouteCircuitsArpTableListResult)

    operation results.



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

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 339

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:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsArpTableListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  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:

  • (ExpressRouteCircuitListResult)

    which provide lazy access to pages of



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1525

def list_as_lazy(resource_group_name, custom_headers:nil)
  response = list_async(resource_group_name, custom_headers: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: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.



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
727
728
729
730
731
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 679

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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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:

  • (ExpressRouteCircuitListResult)

    operation results.



1345
1346
1347
1348
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1345

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers: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.



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
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1374

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


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

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

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_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.



1360
1361
1362
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 1360

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers: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:

  • (ExpressRouteCircuitsRoutesTableListResult)

    operation results.



370
371
372
373
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 370

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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 386

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:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsRoutesTableListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  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:

  • (ExpressRouteCircuitsRoutesTableSummaryListResult)

    operation results.



417
418
419
420
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 417

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 433

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:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuitsRoutesTableSummaryListResult.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  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.



666
667
668
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 666

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

#update_tags(resource_group_name, circuit_name, parameters, custom_headers: nil) ⇒ ExpressRouteCircuit

Updates an express route circuit tags.

circuit tags. 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 (TagsObject)

    Parameters supplied to update express route

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

    A hash of custom headers that

Returns:

  • (ExpressRouteCircuit)

    operation results.



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

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

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

Updates an express route circuit tags.

circuit tags. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • circuit_name (String)

    The name of the circuit.

  • parameters (TagsObject)

    Parameters supplied to update express route

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 247

def update_tags_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 = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

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

  # Serialize Request
  request_mapper = Azure::Network::Mgmt::V2020_08_01::Models::TagsObject.mapper()
  request_content = @client.serialize(request_mapper,  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(:patch, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2020_08_01::Models::ExpressRouteCircuit.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#update_tags_with_http_info(resource_group_name, circuit_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an express route circuit tags.

circuit tags. 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 (TagsObject)

    Parameters supplied to update express route

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



231
232
233
# File 'lib/2020-08-01/generated/azure_mgmt_network/express_route_circuits.rb', line 231

def update_tags_with_http_info(resource_group_name, circuit_name, parameters, custom_headers:nil)
  update_tags_async(resource_group_name, circuit_name, parameters, custom_headers:custom_headers).value!
end