Class: Azure::Advisor::Mgmt::V2020_01_01::Suppressions
- Inherits:
-
Object
- Object
- Azure::Advisor::Mgmt::V2020_01_01::Suppressions
- Includes:
- MsRestAzure
- Defined in:
- lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb
Overview
REST APIs for Azure Advisor
Instance Attribute Summary collapse
-
#client ⇒ AdvisorManagementClient
readonly
Reference to the AdvisorManagementClient.
Instance Method Summary collapse
-
#create(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ SuppressionContract
Enables the snoozed or dismissed attribute of a recommendation.
-
#create_async(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ Concurrent::Promise
Enables the snoozed or dismissed attribute of a recommendation.
-
#create_with_http_info(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Enables the snoozed or dismissed attribute of a recommendation.
-
#delete(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Object
Enables the activation of a snoozed or dismissed recommendation.
-
#delete_async(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Concurrent::Promise
Enables the activation of a snoozed or dismissed recommendation.
-
#delete_with_http_info(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Enables the activation of a snoozed or dismissed recommendation.
-
#get(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ SuppressionContract
Obtains the details of a suppression.
-
#get_async(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Concurrent::Promise
Obtains the details of a suppression.
-
#get_with_http_info(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Obtains the details of a suppression.
-
#initialize(client) ⇒ Suppressions
constructor
Creates and initializes a new instance of the Suppressions class.
-
#list(top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<SuppressionContract>
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_as_lazy(top: nil, skip_token: nil, custom_headers: nil) ⇒ SuppressionContractListResult
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_async(top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_next(next_page_link, custom_headers: nil) ⇒ SuppressionContractListResult
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Retrieves the list of snoozed or dismissed suppressions for a subscription.
-
#list_with_http_info(top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Retrieves the list of snoozed or dismissed suppressions for a subscription.
Constructor Details
#initialize(client) ⇒ Suppressions
Creates and initializes a new instance of the Suppressions class.
17 18 19 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ AdvisorManagementClient (readonly)
Returns reference to the AdvisorManagementClient.
22 23 24 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 22 def client @client end |
Instance Method Details
#create(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ SuppressionContract
Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.
identifier of the resource to which the recommendation applies. attribute; for example, the snooze duration. will be added to the HTTP request.
140 141 142 143 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 140 def create(resource_uri, recommendation_id, name, suppression_contract, custom_headers:nil) response = create_async(resource_uri, recommendation_id, name, suppression_contract, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_async(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ Concurrent::Promise
Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.
identifier of the resource to which the recommendation applies. attribute; for example, the snooze duration. to the HTTP request.
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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 181 def create_async(resource_uri, recommendation_id, name, suppression_contract, 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, 'name is nil' if name.nil? fail ArgumentError, 'suppression_contract is nil' if suppression_contract.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? # Serialize Request request_mapper = Azure::Advisor::Mgmt::V2020_01_01::Models::SuppressionContract.mapper() request_content = @client.serialize(request_mapper, suppression_contract) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = '{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceUri' => resource_uri,'recommendationId' => recommendation_id,'name' => name}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) 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::SuppressionContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_with_http_info(resource_uri, recommendation_id, name, suppression_contract, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.
identifier of the resource to which the recommendation applies. attribute; for example, the snooze duration. will be added to the HTTP request.
161 162 163 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 161 def create_with_http_info(resource_uri, recommendation_id, name, suppression_contract, custom_headers:nil) create_async(resource_uri, recommendation_id, name, suppression_contract, custom_headers:custom_headers).value! end |
#delete(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Object
Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
identifier of the resource to which the recommendation applies. will be added to the HTTP request.
256 257 258 259 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 256 def delete(resource_uri, recommendation_id, name, custom_headers:nil) response = delete_async(resource_uri, recommendation_id, name, custom_headers:custom_headers).value! nil end |
#delete_async(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Concurrent::Promise
Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
identifier of the resource to which the recommendation applies. to the HTTP request.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 291 def delete_async(resource_uri, recommendation_id, name, 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, 'name is nil' if 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 = '{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceUri' => resource_uri,'recommendationId' => recommendation_id,'name' => name}, query_params: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:delete, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless 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 |
#delete_with_http_info(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
identifier of the resource to which the recommendation applies. will be added to the HTTP request.
274 275 276 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 274 def delete_with_http_info(resource_uri, recommendation_id, name, custom_headers:nil) delete_async(resource_uri, recommendation_id, name, custom_headers:custom_headers).value! end |
#get(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ SuppressionContract
Obtains the details of a suppression.
identifier of the resource to which the recommendation applies. will be added to the HTTP request.
36 37 38 39 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 36 def get(resource_uri, recommendation_id, name, custom_headers:nil) response = get_async(resource_uri, recommendation_id, name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ Concurrent::Promise
Obtains the details of a suppression.
identifier of the resource to which the recommendation applies. to the HTTP request.
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 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 69 def get_async(resource_uri, recommendation_id, name, 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, 'name is nil' if 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 = '{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceUri' => resource_uri,'recommendationId' => recommendation_id,'name' => 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, ) 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::SuppressionContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(resource_uri, recommendation_id, name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Obtains the details of a suppression.
identifier of the resource to which the recommendation applies. will be added to the HTTP request.
53 54 55 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 53 def get_with_http_info(resource_uri, recommendation_id, name, custom_headers:nil) get_async(resource_uri, recommendation_id, name, custom_headers:custom_headers).value! end |
#list(top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<SuppressionContract>
Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
of this API is being used. version of this API. will be added to the HTTP request.
350 351 352 353 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 350 def list(top:nil, skip_token:nil, custom_headers:nil) first_page = list_as_lazy(top:top, skip_token:skip_token, custom_headers:custom_headers) first_page.get_all_items end |
#list_as_lazy(top: nil, skip_token: nil, custom_headers: nil) ⇒ SuppressionContractListResult
Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
of this API is being used. version of this API. will be added to the HTTP request.
the response.
551 552 553 554 555 556 557 558 559 560 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 551 def list_as_lazy(top:nil, skip_token:nil, custom_headers:nil) response = list_async(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(top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise
Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
of this API is being used. version of this API. to the HTTP request.
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 387 def list_async(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/suppressions' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version,'$top' => top,'$skipToken' => skip_token}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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::SuppressionContractListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_next(next_page_link, custom_headers: nil) ⇒ SuppressionContractListResult
Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
to List operation. will be added to the HTTP request.
452 453 454 455 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 452 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 list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
to List operation. to the HTTP request.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 485 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 = { 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, ) 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::SuppressionContractListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., 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 list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
to List operation. will be added to the HTTP request.
469 470 471 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 469 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(top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.
of this API is being used. version of this API. will be added to the HTTP request.
369 370 371 |
# File 'lib/2020-01-01/generated/azure_mgmt_advisor/suppressions.rb', line 369 def list_with_http_info(top:nil, skip_token:nil, custom_headers:nil) list_async(top:top, skip_token:skip_token, custom_headers:custom_headers).value! end |