Class: Azure::Advisor::Mgmt::V2020_01_01::Recommendations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb

Overview

REST APIs for Azure Advisor

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Recommendations

Creates and initializes a new instance of the Recommendations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AdvisorManagementClient (readonly)

Returns reference to the AdvisorManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 22

def client
  @client
end

Instance Method Details

#generate(custom_headers: nil) ⇒ Object

Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that



33
34
35
36
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 33

def generate(custom_headers:nil)
  response = generate_async(custom_headers:custom_headers).value!
  nil
end

#generate_async(custom_headers: nil) ⇒ Concurrent::Promise

Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

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.



62
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 62

def generate_async(custom_headers: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}/providers/Microsoft.Advisor/generateRecommendations'

  request_url = @base_url || @client.base_url

  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 || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 == 202
      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?

    result
  end

  promise.execute
end

#generate_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.

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.



48
49
50
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 48

def generate_with_http_info(custom_headers:nil)
  generate_async(custom_headers:custom_headers).value!
end

#get(resource_uri, recommendation_id, custom_headers: nil) ⇒ ResourceRecommendationBase

Obtains details of a cached recommendation.

identifier of the resource to which the recommendation applies. will be added to the HTTP request.

Parameters:

  • resource_uri (String) —

    The fully qualified Azure Resource Manager

  • recommendation_id (String) —

    The recommendation ID.

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

    A hash of custom headers that

Returns:

  • (ResourceRecommendationBase) —

    operation results.



308
309
310
311
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 308

def get(resource_uri, recommendation_id, custom_headers:nil)
  response = get_async(resource_uri, recommendation_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_uri, recommendation_id, custom_headers: nil) ⇒ Concurrent::Promise

Obtains details of a cached recommendation.

identifier of the resource to which the recommendation applies. to the HTTP request.

Parameters:

  • resource_uri (String) —

    The fully qualified Azure Resource Manager

  • recommendation_id (String) —

    The recommendation ID.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



339
340
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 339

def get_async(resource_uri, recommendation_id, custom_headers:nil)
  fail ArgumentError, 'resource_uri is nil' if resource_uri.nil?
  fail ArgumentError, 'recommendation_id is nil' if recommendation_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 = '{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceUri' => resource_uri,'recommendationId' => recommendation_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::Advisor::Mgmt::V2020_01_01::Models::ResourceRecommendationBase.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_generate_status(operation_id, custom_headers: nil) ⇒ Object

Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

field in the generate recommendation response header. will be added to the HTTP request.

Parameters:

  • operation_id —

    The operation ID, which can be found from the Location

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

    A hash of custom headers that



116
117
118
119
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 116

def get_generate_status(operation_id, custom_headers:nil)
  response = get_generate_status_async(operation_id, custom_headers:custom_headers).value!
  nil
end

#get_generate_status_async(operation_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

field in the generate recommendation response header. to the HTTP request.

Parameters:

  • operation_id —

    The operation ID, which can be found from the Location

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



149
150
151
152
153
154
155
156
157
158
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 149

def get_generate_status_async(operation_id, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'operation_id is nil' if operation_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}/providers/Microsoft.Advisor/generateRecommendations/{operationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'operationId' => operation_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 == 202 || status_code == 204
      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?

    result
  end

  promise.execute
end

#get_generate_status_with_http_info(operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.

field in the generate recommendation response header. will be added to the HTTP request.

Parameters:

  • operation_id —

    The operation ID, which can be found from the Location

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



133
134
135
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 133

def get_generate_status_with_http_info(operation_id, custom_headers:nil)
  get_generate_status_async(operation_id, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_uri, recommendation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Obtains details of a cached recommendation.

identifier of the resource to which the recommendation applies. will be added to the HTTP request.

Parameters:

  • resource_uri (String) —

    The fully qualified Azure Resource Manager

  • recommendation_id (String) —

    The recommendation ID.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



324
325
326
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 324

def get_with_http_info(resource_uri, recommendation_id, custom_headers:nil)
  get_async(resource_uri, recommendation_id, custom_headers:custom_headers).value!
end

#list(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<ResourceRecommendationBase>

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

version of this API is being used. version of this API. will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the recommendations.

  • top (Integer) (defaults to: nil) —

    The number of recommendations per page if a paged

  • skip_token (String) (defaults to: nil) —

    The page-continuation token to use with a paged

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

    A hash of custom headers that

Returns:

  • (Array<ResourceRecommendationBase>) —

    operation results.



207
208
209
210
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 207

def list(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(filter: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ ResourceRecommendationBaseListResult

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

version of this API is being used. version of this API. will be added to the HTTP request.

pages of the response.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the recommendations.

  • top (Integer) (defaults to: nil) —

    The number of recommendations per page if a paged

  • skip_token (String) (defaults to: nil) —

    The page-continuation token to use with a paged

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

    A hash of custom headers that

Returns:

  • (ResourceRecommendationBaseListResult) —

    which provide lazy access to



501
502
503
504
505
506
507
508
509
510
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 501

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

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

version of this API is being used. version of this API. to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the recommendations.

  • top (Integer) (defaults to: nil) —

    The number of recommendations per page if a paged

  • skip_token (String) (defaults to: nil) —

    The page-continuation token to use with a paged

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



244
245
246
247
248
249
250
251
252
253
254
255
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 244

def list_async(filter:nil, top:nil, skip_token:nil, custom_headers: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}/providers/Microsoft.Advisor/recommendations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$top' => top,'$skipToken' => skip_token},
      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::Advisor::Mgmt::V2020_01_01::Models::ResourceRecommendationBaseListResult.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) ⇒ ResourceRecommendationBaseListResult

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

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:

  • (ResourceRecommendationBaseListResult) —

    operation results.



404
405
406
407
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 404

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

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

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.



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 435

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::Advisor::Mgmt::V2020_01_01::Models::ResourceRecommendationBaseListResult.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

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

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.



420
421
422
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 420

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

Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.

version of this API is being used. version of this API. will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the recommendations.

  • top (Integer) (defaults to: nil) —

    The number of recommendations per page if a paged

  • skip_token (String) (defaults to: nil) —

    The page-continuation token to use with a paged

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



226
227
228
 
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/recommendations.rb', line 226

def list_with_http_info(filter:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_async(filter:filter, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end