Class: Azure::ARM::Network::LocalNetworkGateways

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ LocalNetworkGateways

Creates and initializes a new instance of the LocalNetworkGateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the NetworkManagementClient.

Returns:

  • reference to the NetworkManagementClient



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resource group through Network resource provider.

gateway. Create or update Local Network Gateway operation through Network resource provider. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

  • parameters (LocalNetworkGateway) —

    Parameters supplied to the Begin

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 83

def begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  parameters.validate unless parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  request_headers = {}

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

  # Serialize Request
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  unless parameters.nil?
    parameters = LocalNetworkGateway.serialize_object(parameters)
  end
  request_content = JSON.generate(parameters, quirks_mode: true)
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'localNetworkGatewayName' => local_network_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }
  request = MsRest::HttpOperationRequest.new(@base_url || @client.base_url, path_template, :put, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = 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)
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = 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_delete(resource_group_name, local_network_gateway_name, custom_headers = nil) ⇒ Concurrent::Promise

The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider.

gateway. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



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
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 261

def begin_delete(resource_group_name, local_network_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  request_headers = {}

  # 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/localNetworkGateways/{localNetworkGatewayName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'localNetworkGatewayName' => local_network_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }
  request = MsRest::HttpOperationRequest.new(@base_url || @client.base_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resource group through Network resource provider.

gateway. Create or update Local Network Gateway operation through Network resource provider. uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. for the response.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

  • parameters (LocalNetworkGateway) —

    Parameters supplied to the Begin

  • @client.api_version (String) —

    Client Api Version.

  • @client.subscription_id (String) —

    Gets subscription credentials which

  • @client.accept_language (String) —

    Gets or sets the preferred language

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

def create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update(resource_group_name, local_network_gateway_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      unless parsed_response.nil?
        parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
      end
    end

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

  promise
end

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

The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider.

gateway. response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 232

def delete(resource_group_name, local_network_gateway_name, custom_headers = nil)
  # Send request
  promise = begin_delete(resource_group_name, local_network_gateway_name, custom_headers)

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

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

  promise
end

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

The Get LocalNetworkGateway operation retrieves information about the specified local network gateway through Network resource provider.

gateway. applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • local_network_gateway_name (String) —

    The name of the local network

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 170

def get(resource_group_name, local_network_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'local_network_gateway_name is nil' if local_network_gateway_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  request_headers = {}

  # 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/localNetworkGateways/{localNetworkGatewayName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'localNetworkGatewayName' => local_network_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }
  request = MsRest::HttpOperationRequest.new(@base_url || @client.base_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = LocalNetworkGateway.deserialize_object(parsed_response)
        end
        result.body = 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(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

The List LocalNetworkGateways opertion retrieves all the local network gateways stored.

applied to HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 312

def list(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }
  request = MsRest::HttpOperationRequest.new(@base_url || @client.base_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = LocalNetworkGatewayListResult.deserialize_object(parsed_response)
        end
        result.body = 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) ⇒ Concurrent::Promise

The List LocalNetworkGateways opertion retrieves all the local network gateways stored.

call to List operation. applied to HTTP request.

response.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers need to be

Returns:

  • (Concurrent::Promise) —

    Promise object which allows to get HTTP



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/azure_mgmt_network/local_network_gateways.rb', line 375

def list_next(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?
  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {})
  }
  request = MsRest::HttpOperationRequest.new(@base_url || @client.base_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        unless parsed_response.nil?
          parsed_response = LocalNetworkGatewayListResult.deserialize_object(parsed_response)
        end
        result.body = 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