Class: Azure::Network::Mgmt::V2019_09_01::AvailablePrivateEndpointTypes

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

Overview

AvailablePrivateEndpointTypes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AvailablePrivateEndpointTypes

Creates and initializes a new instance of the AvailablePrivateEndpointTypes class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#list(location, custom_headers: nil) ⇒ Array<AvailablePrivateEndpointType>

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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

    A hash of custom headers that

Returns:

  • (Array<AvailablePrivateEndpointType>) —

    operation results.



34
35
36
37
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 34

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

#list_as_lazy(location, custom_headers: nil) ⇒ AvailablePrivateEndpointTypesResult

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

pages of the response.

Parameters:

  • location (String) —

    The location of the domain name.

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

    A hash of custom headers that

Returns:

  • (AvailablePrivateEndpointTypesResult) —

    which provide lazy access to



411
412
413
414
415
416
417
418
419
420
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 411

def list_as_lazy(location, custom_headers:nil)
  response = list_async(location, 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(location, custom_headers: nil) ⇒ Concurrent::Promise

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
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
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 63

def list_async(location, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.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 = {}
  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}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'subscriptionId' => @client.subscription_id},
      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_09_01::Models::AvailablePrivateEndpointTypesResult.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_resource_group(location, resource_group_name, custom_headers: nil) ⇒ Array<AvailablePrivateEndpointType>

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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

  • (Array<AvailablePrivateEndpointType>) —

    operation results.



128
129
130
131
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 128

def list_by_resource_group(location, resource_group_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(location, resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(location, resource_group_name, custom_headers: nil) ⇒ AvailablePrivateEndpointTypesResult

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

pages of the response.

Parameters:

  • location (String) —

    The location of the domain name.

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

  • (AvailablePrivateEndpointTypesResult) —

    which provide lazy access to



434
435
436
437
438
439
440
441
442
443
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 434

def list_by_resource_group_as_lazy(location, resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(location, resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(location, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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



159
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
210
211
212
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 159

def list_by_resource_group_async(location, resource_group_name, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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/locations/{location}/availablePrivateEndpointTypes'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      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_09_01::Models::AvailablePrivateEndpointTypesResult.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_resource_group_next(next_page_link, custom_headers: nil) ⇒ AvailablePrivateEndpointTypesResult

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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:

  • (AvailablePrivateEndpointTypesResult) —

    operation results.



318
319
320
321
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 318

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

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

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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.



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
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 349

def list_by_resource_group_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_09_01::Models::AvailablePrivateEndpointTypesResult.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_resource_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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.



334
335
336
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 334

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(location, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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



144
145
146
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 144

def list_by_resource_group_with_http_info(location, resource_group_name, custom_headers:nil)
  list_by_resource_group_async(location, resource_group_name, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ AvailablePrivateEndpointTypesResult

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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:

  • (AvailablePrivateEndpointTypesResult) —

    operation results.



225
226
227
228
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 225

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

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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.



256
257
258
259
260
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
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 256

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_09_01::Models::AvailablePrivateEndpointTypesResult.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

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

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.



241
242
243
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 241

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(location, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The location of the domain name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2019-09-01/generated/azure_mgmt_network/available_private_endpoint_types.rb', line 49

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