Class: Azure::Network::Mgmt::V2020_05_01::VirtualHubBgpConnections

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb

Overview

VirtualHubBgpConnections

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VirtualHubBgpConnections

Creates and initializes a new instance of the VirtualHubBgpConnections class.

Parameters:

  • client —

    service class for accessing basic functionality.

[View source]

17
18
19
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ NetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:


22
23
24
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 22

def client
  @client
end

Instance Method Details

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

Retrieves the details of all VirtualHubBgpConnections.

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<BgpConnection>) —

    operation results.

[View source]

35
36
37
38
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 35

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) ⇒ ListVirtualHubBgpConnectionResults

Retrieves the details of all VirtualHubBgpConnections.

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:

  • (ListVirtualHubBgpConnectionResults) —

    which provide lazy access to

[View source]

223
224
225
226
227
228
229
230
231
232
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 223

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

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.

[View source]

66
67
68
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
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 66

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}/bgpConnections'

  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::V2020_05_01::Models::ListVirtualHubBgpConnectionResults.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) ⇒ ListVirtualHubBgpConnectionResults

Retrieves the details of all VirtualHubBgpConnections.

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:

  • (ListVirtualHubBgpConnectionResults) —

    operation results.

[View source]

131
132
133
134
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 131

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

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.

[View source]

160
161
162
163
164
165
166
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
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 160

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::V2020_05_01::Models::ListVirtualHubBgpConnectionResults.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 VirtualHubBgpConnections.

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.

[View source]

146
147
148
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 146

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

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.

[View source]

51
52
53
 
# File 'lib/2020-05-01/generated/azure_mgmt_network/virtual_hub_bgp_connections.rb', line 51

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