Class: Azure::Network::Mgmt::V2018_08_01::ExpressRouteCircuitConnections

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

Overview

ExpressRouteCircuitConnections

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ExpressRouteCircuitConnections

Creates and initializes a new instance of the ExpressRouteCircuitConnections class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers: nil) ⇒ ExpressRouteCircuitConnection

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

connection.

ExpressRouteCircuitConnection

Parameters supplied to the create or update

express route circuit connection 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 express route circuit.

  • peering_name (String) —

    The name of the peering.

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that

Returns:

  • (ExpressRouteCircuitConnection) —

    operation results.



346
347
348
349
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 346

def begin_create_or_update(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

connection.

ExpressRouteCircuitConnection

Parameters supplied to the create or update

express route circuit connection operation. 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.

  • connection_name (String) —

    The name of the express route circuit

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 389

def begin_create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_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, 'peering_name is nil' if peering_name.nil?
  fail ArgumentError, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, 'express_route_circuit_connection_parameters is nil' if express_route_circuit_connection_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::V2018_08_01::Models::ExpressRouteCircuitConnection.mapper()
  request_content = @client.serialize(request_mapper,  express_route_circuit_connection_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}/peerings/{peeringName}/connections/{connectionName}'

  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,'connectionName' => connection_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

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

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

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

connection.

ExpressRouteCircuitConnection

Parameters supplied to the create or update

express route circuit connection 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 express route circuit.

  • peering_name (String) —

    The name of the peering.

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



368
369
370
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 368

def begin_create_or_update_with_http_info(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, circuit_name, peering_name, connection_name, custom_headers: nil) ⇒ Object

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that



245
246
247
248
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 245

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

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

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_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.



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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 282

def begin_delete_async(resource_group_name, circuit_name, peering_name, connection_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, 'connection_name is nil' if connection_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}/connections/{connectionName}'

  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,'connectionName' => connection_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

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

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_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.



264
265
266
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 264

def begin_delete_with_http_info(resource_group_name, circuit_name, peering_name, connection_name, custom_headers:nil)
  begin_delete_async(resource_group_name, circuit_name, peering_name, connection_name, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers: nil) ⇒ ExpressRouteCircuitConnection

Creates or updates a Express Route Circuit Connection in the specified express route circuits.

connection.

ExpressRouteCircuitConnection

Parameters supplied to the create or update

express route circuit connection 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 express route circuit.

  • peering_name (String) —

    The name of the peering.

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that

Returns:

  • (ExpressRouteCircuitConnection) —

    operation results.



194
195
196
197
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 194

def create_or_update(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers: nil) ⇒ Concurrent::Promise

connection.

ExpressRouteCircuitConnection

Parameters supplied to the create or update

express route circuit connection 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 express route circuit.

  • peering_name (String) —

    The name of the peering.

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 214

def create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, circuit_name, peering_name, connection_name, express_route_circuit_connection_parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2018_08_01::Models::ExpressRouteCircuitConnection.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, peering_name, connection_name, custom_headers: nil) ⇒ Object

Deletes the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_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/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 36

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

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

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

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 53

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

Gets the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_name (String) —

    The name of the express route circuit

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

    A hash of custom headers that

Returns:

  • (ExpressRouteCircuitConnection) —

    operation results.



83
84
85
86
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 83

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

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

Gets the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_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.



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 120

def get_async(resource_group_name, circuit_name, peering_name, connection_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, 'connection_name is nil' if connection_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}/connections/{connectionName}'

  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,'connectionName' => connection_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::V2018_08_01::Models::ExpressRouteCircuitConnection.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Gets the specified Express Route Circuit Connection from the specified express route circuit.

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

  • connection_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.



102
103
104
 
# File 'lib/2018-08-01/generated/azure_mgmt_network/express_route_circuit_connections.rb', line 102

def get_with_http_info(resource_group_name, circuit_name, peering_name, connection_name, custom_headers:nil)
  get_async(resource_group_name, circuit_name, peering_name, connection_name, custom_headers:custom_headers).value!
end