Class: Azure::ARM::Network::ApplicationGateways

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_network/application_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) ⇒ ApplicationGateways

Creates and initializes a new instance of the ApplicationGateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:



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

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers = nil) ⇒ ApplicationGateway

The Put ApplicationGateway operation creates/updates a ApplicationGateway

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the ApplicationGateway.

  • parameters (ApplicationGateway) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:



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

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

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

The Put ApplicationGateway operation creates/updates a ApplicationGateway

create/delete ApplicationGateway operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the ApplicationGateway.

  • parameters (ApplicationGateway) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 341

def begin_create_or_update_async(resource_group_name, application_gateway_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'application_gateway_name is nil' if application_gateway_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

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

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

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

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

  request_url = @base_url || @client.base_url

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

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

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = ApplicationGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = ApplicationGateway.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, application_gateway_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

The Put ApplicationGateway operation creates/updates a ApplicationGateway

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the ApplicationGateway.

  • parameters (ApplicationGateway) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

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

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

The delete applicationgateway operation deletes the specified applicationgateway.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that



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

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

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

The delete applicationgateway operation deletes the specified applicationgateway.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def begin_delete_async(resource_group_name, application_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'application_gateway_name is nil' if application_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/applicationGateways/{applicationGatewayName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'applicationGatewayName' => application_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The delete applicationgateway operation deletes the specified applicationgateway.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

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

#begin_start(resource_group_name, application_gateway_name, custom_headers = nil) ⇒ Object

The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that



690
691
692
693
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 690

def begin_start(resource_group_name, application_gateway_name, custom_headers = nil)
  response = begin_start_async(resource_group_name, application_gateway_name, custom_headers).value!
  nil
end

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

The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 721

def begin_start_async(resource_group_name, application_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'application_gateway_name is nil' if application_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/applicationGateways/{applicationGatewayName}/start'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'applicationGatewayName' => application_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



706
707
708
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 706

def begin_start_with_http_info(resource_group_name, application_gateway_name, custom_headers = nil)
  begin_start_async(resource_group_name, application_gateway_name, custom_headers).value!
end

#begin_stop(resource_group_name, application_gateway_name, custom_headers = nil) ⇒ Object

The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that



815
816
817
818
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 815

def begin_stop(resource_group_name, application_gateway_name, custom_headers = nil)
  response = begin_stop_async(resource_group_name, application_gateway_name, custom_headers).value!
  nil
end

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

The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 846

def begin_stop_async(resource_group_name, application_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'application_gateway_name is nil' if application_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/applicationGateways/{applicationGatewayName}/stop'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'applicationGatewayName' => application_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



831
832
833
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 831

def begin_stop_with_http_info(resource_group_name, application_gateway_name, custom_headers = nil)
  begin_stop_async(resource_group_name, application_gateway_name, custom_headers).value!
end

#create_or_update(resource_group_name, application_gateway_name, parameters, custom_headers = nil) ⇒ ApplicationGateway

The Put ApplicationGateway operation creates/updates a ApplicationGateway

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the ApplicationGateway.

  • parameters (ApplicationGateway) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:



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

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

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

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

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the ApplicationGateway.

  • parameters (ApplicationGateway) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

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

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

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

  promise
end

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

The delete applicationgateway operation deletes the specified applicationgateway.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that



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

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

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

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



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

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

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

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

  promise
end

#get(resource_group_name, application_gateway_name, custom_headers = nil) ⇒ ApplicationGateway

The Get applicationgateway operation retreives information about the specified applicationgateway.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that

Returns:



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

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

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

The Get applicationgateway operation retreives information about the specified applicationgateway.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_async(resource_group_name, application_gateway_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'application_gateway_name is nil' if application_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/applicationGateways/{applicationGatewayName}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'applicationGatewayName' => application_gateway_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The Get applicationgateway operation retreives information about the specified applicationgateway.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the applicationgateway.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

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

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

The List ApplicationGateway operation retrieves all the applicationgateways 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:



448
449
450
451
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 448

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

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

The List applicationgateway operation retrieves all the applicationgateways 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:



561
562
563
564
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 561

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

#list_all_as_lazy(custom_headers = nil) ⇒ ApplicationGatewayListResult

The List applicationgateway operation retrieves all the applicationgateways 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:



541
542
543
544
545
546
547
548
549
550
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 541

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

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

The List applicationgateway operation retrieves all the applicationgateways 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.



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
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 588

def list_all_async(custom_headers = nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

#list_all_next(next_page_link, custom_headers = nil) ⇒ ApplicationGatewayListResult

The List applicationgateway operation retrieves all the applicationgateways in a subscription.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



995
996
997
998
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 995

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

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

The List applicationgateway operation retrieves all the applicationgateways in a subscription.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

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


  request_headers = {}

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The List applicationgateway operation retrieves all the applicationgateways in a subscription.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1011
1012
1013
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 1011

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

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

The List applicationgateway operation retrieves all the applicationgateways 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.



575
576
577
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 575

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

#list_as_lazy(resource_group_name, custom_headers = nil) ⇒ ApplicationGatewayListResult

The List ApplicationGateway operation retrieves all the applicationgateways 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:



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 427

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

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

The List ApplicationGateway operation retrieves all the applicationgateways 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.



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

def list_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers = nil) ⇒ ApplicationGatewayListResult

The List ApplicationGateway operation retrieves all the applicationgateways in a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:



902
903
904
905
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 902

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

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

The List ApplicationGateway operation retrieves all the applicationgateways in a resource group.

call to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

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


  request_headers = {}

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

The List ApplicationGateway operation retrieves all the applicationgateways in a resource group.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



918
919
920
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 918

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

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

The List ApplicationGateway operation retrieves all the applicationgateways 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.



463
464
465
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 463

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

#start(resource_group_name, application_gateway_name, custom_headers = nil) ⇒ Object

The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that



650
651
652
653
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 650

def start(resource_group_name, application_gateway_name, custom_headers = nil)
  response = start_async(resource_group_name, application_gateway_name, custom_headers).value!
  nil
end

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

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 664

def start_async(resource_group_name, application_gateway_name, custom_headers = nil)
  # Send request
  promise = begin_start_async(resource_group_name, application_gateway_name, custom_headers)

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

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

  promise
end

#stop(resource_group_name, application_gateway_name, custom_headers = nil) ⇒ Object

The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that



775
776
777
778
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 775

def stop(resource_group_name, application_gateway_name, custom_headers = nil)
  response = stop_async(resource_group_name, application_gateway_name, custom_headers).value!
  nil
end

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

  • application_gateway_name (String) —

    The name of the application gateway.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/generated/azure_mgmt_network/application_gateways.rb', line 789

def stop_async(resource_group_name, application_gateway_name, custom_headers = nil)
  # Send request
  promise = begin_stop_async(resource_group_name, application_gateway_name, custom_headers)

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

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

  promise
end