Class: Azure::Network::Mgmt::V2019_06_01::VpnLinkConnections

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

Overview

VpnLinkConnections

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnLinkConnections

Creates and initializes a new instance of the VpnLinkConnections class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_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-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 22

def client
  @client
end

Instance Method Details

#list_by_vpn_connection(resource_group_name, gateway_name, connection_name, custom_headers: nil) ⇒ Array<VpnSiteLinkConnection>

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • connection_name (String)

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (Array<VpnSiteLinkConnection>)

    operation results.


37
38
39
40
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 37

def list_by_vpn_connection(resource_group_name, gateway_name, connection_name, custom_headers:nil)
  first_page = list_by_vpn_connection_as_lazy(resource_group_name, gateway_name, connection_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_vpn_connection_as_lazy(resource_group_name, gateway_name, connection_name, custom_headers: nil) ⇒ ListVpnSiteLinkConnectionsResult

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

VpnGateway. will be added to the HTTP request.

of the response.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

  • connection_name (String)

    The name of the vpn connection.

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

    A hash of custom headers that

Returns:

  • (ListVpnSiteLinkConnectionsResult)

    which provide lazy access to pages


235
236
237
238
239
240
241
242
243
244
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 235

def list_by_vpn_connection_as_lazy(resource_group_name, gateway_name, connection_name, custom_headers:nil)
  response = list_by_vpn_connection_async(resource_group_name, gateway_name, connection_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_vpn_connection_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_vpn_connection_async(resource_group_name, gateway_name, connection_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

VpnGateway. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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


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
124
125
126
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 72

def list_by_vpn_connection_async(resource_group_name, gateway_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, 'gateway_name is nil' if gateway_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/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections'

  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,'gatewayName' => gateway_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 MsRest::HttpOperationError.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_06_01::Models::ListVpnSiteLinkConnectionsResult.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_by_vpn_connection_next(next_page_link, custom_headers: nil) ⇒ ListVpnSiteLinkConnectionsResult

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

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:

  • (ListVpnSiteLinkConnectionsResult)

    operation results.


139
140
141
142
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 139

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

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

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

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.


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
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 170

def list_by_vpn_connection_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 MsRest::HttpOperationError.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_06_01::Models::ListVpnSiteLinkConnectionsResult.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_by_vpn_connection_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

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.


155
156
157
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 155

def list_by_vpn_connection_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_vpn_connection_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_vpn_connection_with_http_info(resource_group_name, gateway_name, connection_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

VpnGateway. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name of the

  • gateway_name (String)

    The name of the gateway.

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


55
56
57
# File 'lib/2019-06-01/generated/azure_mgmt_network/vpn_link_connections.rb', line 55

def list_by_vpn_connection_with_http_info(resource_group_name, gateway_name, connection_name, custom_headers:nil)
  list_by_vpn_connection_async(resource_group_name, gateway_name, connection_name, custom_headers:custom_headers).value!
end