class Azure::Security::Mgmt::V2019_01_01_preview::AlertsSuppressionRules

API spec for Microsoft.Security (Azure Security Center) resource provider

Attributes

client[R]

@return [SecurityCenter] reference to the SecurityCenter

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the AlertsSuppressionRules class. @param client service class for accessing basic functionality.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

delete(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Delete dismiss alert rule for this subscription.

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 328
def delete(alerts_suppression_rule_name, custom_headers:nil)
  response = delete_async(alerts_suppression_rule_name, custom_headers:custom_headers).value!
  nil
end
delete_async(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Delete dismiss alert rule for this subscription.

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 357
def delete_async(alerts_suppression_rule_name, custom_headers: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?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).nil?
  fail ArgumentError, 'alerts_suppression_rule_name is nil' if alerts_suppression_rule_name.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.Security/alertsSuppressionRules/{alertsSuppressionRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'alertsSuppressionRuleName' => alerts_suppression_rule_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, options)

  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(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Delete dismiss alert rule for this subscription.

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 343
def delete_with_http_info(alerts_suppression_rule_name, custom_headers:nil)
  delete_async(alerts_suppression_rule_name, custom_headers:custom_headers).value!
end
get(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [AlertsSuppressionRule] operation results.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 125
def get(alerts_suppression_rule_name, custom_headers:nil)
  response = get_async(alerts_suppression_rule_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 156
def get_async(alerts_suppression_rule_name, custom_headers: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?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).nil?
  fail ArgumentError, 'alerts_suppression_rule_name is nil' if alerts_suppression_rule_name.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.Security/alertsSuppressionRules/{alertsSuppressionRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'alertsSuppressionRuleName' => alerts_suppression_rule_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::Security::Mgmt::V2019_01_01_preview::Models::AlertsSuppressionRule.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_with_http_info(alerts_suppression_rule_name, custom_headers:nil) click to toggle source

Get dismiss rule, with name: {alertsSuppressionRuleName}, for the given subscription

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 141
def get_with_http_info(alerts_suppression_rule_name, custom_headers:nil)
  get_async(alerts_suppression_rule_name, custom_headers:custom_headers).value!
end
list(alert_type:nil, custom_headers:nil) click to toggle source

List of all the dismiss rules for the given subscription

@param alert_type [String] Type of the alert to get rules for @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<AlertsSuppressionRule>] operation results.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 33
def list(alert_type:nil, custom_headers:nil)
  first_page = list_as_lazy(alert_type:alert_type, custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(alert_type:nil, custom_headers:nil) click to toggle source

List of all the dismiss rules for the given subscription

@param alert_type [String] Type of the alert to get rules for @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [AlertsSuppressionRulesList] which provide lazy access to pages of the response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 502
def list_as_lazy(alert_type:nil, custom_headers:nil)
  response = list_async(alert_type:alert_type, 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(alert_type:nil, custom_headers:nil) click to toggle source

List of all the dismiss rules for the given subscription

@param alert_type [String] Type of the alert to get rules for @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 60
def list_async(alert_type:nil, custom_headers: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?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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.Security/alertsSuppressionRules'

  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,'AlertType' => alert_type},
      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::Security::Mgmt::V2019_01_01_preview::Models::AlertsSuppressionRulesList.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) click to toggle source

List of all the dismiss rules for the given subscription

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [AlertsSuppressionRulesList] operation results.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 412
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) click to toggle source

List of all the dismiss rules for the given subscription

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 441
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::Security::Mgmt::V2019_01_01_preview::Models::AlertsSuppressionRulesList.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) click to toggle source

List of all the dismiss rules for the given subscription

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 427
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(alert_type:nil, custom_headers:nil) click to toggle source

List of all the dismiss rules for the given subscription

@param alert_type [String] Type of the alert to get rules for @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 47
def list_with_http_info(alert_type:nil, custom_headers:nil)
  list_async(alert_type:alert_type, custom_headers:custom_headers).value!
end
update(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:nil) click to toggle source

Update existing rule or create new rule if it doesn't exist

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param alerts_suppression_rule [AlertsSuppressionRule] Suppression rule object @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [AlertsSuppressionRule] operation results.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 223
def update(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:nil)
  response = update_async(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
update_async(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:nil) click to toggle source

Update existing rule or create new rule if it doesn't exist

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param alerts_suppression_rule [AlertsSuppressionRule] Suppression rule object @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 256
def update_async(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers: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?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).nil?
  fail ArgumentError, 'alerts_suppression_rule_name is nil' if alerts_suppression_rule_name.nil?
  fail ArgumentError, 'alerts_suppression_rule is nil' if alerts_suppression_rule.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::Security::Mgmt::V2019_01_01_preview::Models::AlertsSuppressionRule.mapper()
  request_content = @client.serialize(request_mapper,  alerts_suppression_rule)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Security/alertsSuppressionRules/{alertsSuppressionRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'alertsSuppressionRuleName' => alerts_suppression_rule_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, 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::Security::Mgmt::V2019_01_01_preview::Models::AlertsSuppressionRule.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
update_with_http_info(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:nil) click to toggle source

Update existing rule or create new rule if it doesn't exist

@param alerts_suppression_rule_name [String] The unique name of the suppression alert rule @param alerts_suppression_rule [AlertsSuppressionRule] Suppression rule object @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-01-01-preview/generated/azure_mgmt_security/alerts_suppression_rules.rb, line 240
def update_with_http_info(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:nil)
  update_async(alerts_suppression_rule_name, alerts_suppression_rule, custom_headers:custom_headers).value!
end