class Azure::Security::Mgmt::V2020_01_01_preview::SecureScoreControls

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

Attributes

client[R]

@return [SecurityCenter] reference to the SecurityCenter

Public Class Methods

new(client) click to toggle source

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

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

Public Instance Methods

list(expand:nil, custom_headers:nil) click to toggle source

Get all security controls within a scope

@param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<SecureScoreControlDetails>] operation results.

# File lib/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 134
def list(expand:nil, custom_headers:nil)
  first_page = list_as_lazy(expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(expand:nil, custom_headers:nil) click to toggle source

Get all security controls within a scope

@param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

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

Get all security controls within a scope

@param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 163
def list_async(expand: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/secureScoreControls'

  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,'$expand' => expand},
      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::V2020_01_01_preview::Models::SecureScoreControlList.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_secure_score(secure_score_name, expand:nil, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@param secure_score_name [String] The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below. @param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<SecureScoreControlDetails>] operation results.

# File lib/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 36
def list_by_secure_score(secure_score_name, expand:nil, custom_headers:nil)
  first_page = list_by_secure_score_as_lazy(secure_score_name, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end
list_by_secure_score_as_lazy(secure_score_name, expand:nil, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@param secure_score_name [String] The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below. @param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 410
def list_by_secure_score_as_lazy(secure_score_name, expand:nil, custom_headers:nil)
  response = list_by_secure_score_async(secure_score_name, expand:expand, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_by_secure_score_async(secure_score_name, expand:nil, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@param secure_score_name [String] The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below. @param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 69
def list_by_secure_score_async(secure_score_name, expand: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?
  fail ArgumentError, 'secure_score_name is nil' if secure_score_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/secureScores/{secureScoreName}/secureScoreControls'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'secureScoreName' => secure_score_name},
      query_params: {'api-version' => @client.api_version,'$expand' => expand},
      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::V2020_01_01_preview::Models::SecureScoreControlList.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_secure_score_next(next_page_link, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@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 [SecureScoreControlList] operation results.

# File lib/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 227
def list_by_secure_score_next(next_page_link, custom_headers:nil)
  response = list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_secure_score_next_async(next_page_link, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 256
def list_by_secure_score_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::V2020_01_01_preview::Models::SecureScoreControlList.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_secure_score_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 242
def list_by_secure_score_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_by_secure_score_with_http_info(secure_score_name, expand:nil, custom_headers:nil) click to toggle source

Get all security controls for a specific initiative within a scope

@param secure_score_name [String] The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below. @param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 53
def list_by_secure_score_with_http_info(secure_score_name, expand:nil, custom_headers:nil)
  list_by_secure_score_async(secure_score_name, expand:expand, custom_headers:custom_headers).value!
end
list_next(next_page_link, custom_headers:nil) click to toggle source

Get all security controls within a scope

@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 [SecureScoreControlList] operation results.

# File lib/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 317
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

Get all security controls within a scope

@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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 346
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::V2020_01_01_preview::Models::SecureScoreControlList.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

Get all security controls within a scope

@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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 332
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(expand:nil, custom_headers:nil) click to toggle source

Get all security controls within a scope

@param expand [ExpandControlsEnum] OData expand. Optional. Possible values include: 'definition' @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/2020-01-01-preview/generated/azure_mgmt_security/secure_score_controls.rb, line 149
def list_with_http_info(expand:nil, custom_headers:nil)
  list_async(expand:expand, custom_headers:custom_headers).value!
end