Class: Azure::Network::Mgmt::V2019_11_01::HubVirtualNetworkConnections

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb

Overview

HubVirtualNetworkConnections

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ HubVirtualNetworkConnections

Creates and initializes a new instance of the HubVirtualNetworkConnections class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:


22
23
24
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, virtual_hub_name, connection_name, custom_headers: nil) ⇒ HubVirtualNetworkConnection

Retrieves the details of a HubVirtualNetworkConnection.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

  • connection_name (String)

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (HubVirtualNetworkConnection)

    operation results.


36
37
38
39
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 36

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

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

Retrieves the details of a HubVirtualNetworkConnection.

VirtualHub. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

  • connection_name (String)

    The name of the vpn connection.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


69
70
71
72
73
74
75
76
77
78
79
80
81
82
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
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 69

def get_async(resource_group_name, virtual_hub_name, connection_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_hub_name is nil' if virtual_hub_name.nil?
  fail ArgumentError, 'connection_name is nil' if connection_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualHubName' => virtual_hub_name,'connectionName' => connection_name},
      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::V2019_11_01::Models::HubVirtualNetworkConnection.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, virtual_hub_name, connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the details of a HubVirtualNetworkConnection.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

  • connection_name (String)

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


53
54
55
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 53

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

#list(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ Array<HubVirtualNetworkConnection>

Retrieves the details of all HubVirtualNetworkConnections.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (Array<HubVirtualNetworkConnection>)

    operation results.


136
137
138
139
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 136

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

#list_as_lazy(resource_group_name, virtual_hub_name, custom_headers: nil) ⇒ ListHubVirtualNetworkConnectionsResult

Retrieves the details of all HubVirtualNetworkConnections.

VirtualHub. will be added to the HTTP request.

pages of the response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (ListHubVirtualNetworkConnectionsResult)

    which provide lazy access to


324
325
326
327
328
329
330
331
332
333
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 324

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

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

Retrieves the details of all HubVirtualNetworkConnections.

VirtualHub. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


167
168
169
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/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 167

def list_async(resource_group_name, virtual_hub_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_hub_name is nil' if virtual_hub_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualHubName' => virtual_hub_name},
      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::V2019_11_01::Models::ListHubVirtualNetworkConnectionsResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ ListHubVirtualNetworkConnectionsResult

Retrieves the details of all HubVirtualNetworkConnections.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ListHubVirtualNetworkConnectionsResult)

    operation results.


232
233
234
235
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 232

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

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

Retrieves the details of all HubVirtualNetworkConnections.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 261

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


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

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

  request_url = @base_url || @client.base_url

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

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

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

    result
  end

  promise.execute
end

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

Retrieves the details of all HubVirtualNetworkConnections.

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

Parameters:

  • next_page_link (String)

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


247
248
249
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 247

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

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

Retrieves the details of all HubVirtualNetworkConnections.

VirtualHub. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • virtual_hub_name (String)

    The name of the VirtualHub.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


152
153
154
# File 'lib/2019-11-01/generated/azure_mgmt_network/hub_virtual_network_connections.rb', line 152

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