Class: Azure::Security::Mgmt::V2020_01_01::SecurityCenter

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-01-01/generated/azure_mgmt_security/security_center.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ SecurityCenter

Creates initializes a new instance of the SecurityCenter class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



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_security/security_center.rb', line 95

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @adaptive_network_hardenings = AdaptiveNetworkHardenings.new(self)
  @allowed_connections = AllowedConnections.new(self)
  @adaptive_application_controls = AdaptiveApplicationControls.new(self)
  @assessments_metadata = AssessmentsMetadata.new(self)
  @assessments = Assessments.new(self)
  @discovered_security_solutions = DiscoveredSecuritySolutions.new(self)
  @security_solutions = SecuritySolutions.new(self)
  @security_solutions_reference_data_operations = SecuritySolutionsReferenceDataOperations.new(self)
  @external_security_solutions = ExternalSecuritySolutions.new(self)
  @jit_network_access_policies = JitNetworkAccessPolicies.new(self)
  @server_vulnerability_assessment_operations = ServerVulnerabilityAssessmentOperations.new(self)
  @topology = Topology.new(self)
  @secure_scores = SecureScores.new(self)
  @secure_score_controls = SecureScoreControls.new(self)
  @secure_score_control_definitions = SecureScoreControlDefinitions.new(self)
  @api_version = '2020-01-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



31
32
33
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 31

def accept_language
  @accept_language
end

#adaptive_application_controls ⇒ AdaptiveApplicationControls (readonly)

Returns adaptive_application_controls.

Returns:



49
50
51
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 49

def adaptive_application_controls
  @adaptive_application_controls
end

#adaptive_network_hardenings ⇒ AdaptiveNetworkHardenings (readonly)

Returns adaptive_network_hardenings.

Returns:



43
44
45
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 43

def adaptive_network_hardenings
  @adaptive_network_hardenings
end

#allowed_connections ⇒ AllowedConnections (readonly)

Returns allowed_connections.

Returns:



46
47
48
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 46

def allowed_connections
  @allowed_connections
end

#api_version ⇒ String (readonly)

Returns API version for the operation.

Returns:

  • (String) —

    API version for the operation



21
22
23
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 21

def api_version
  @api_version
end

#asc_location ⇒ String

subscription. can be retrieved from Get locations

Returns:

  • (String) —

    The location where ASC stores the data of the



28
29
30
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 28

def asc_location
  @asc_location
end

#assessments ⇒ Assessments (readonly)

Returns assessments.

Returns:



55
56
57
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 55

def assessments
  @assessments
end

#assessments_metadata ⇒ AssessmentsMetadata (readonly)

Returns assessments_metadata.

Returns:



52
53
54
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 52

def assessments_metadata
  @assessments_metadata
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 18

def credentials
  @credentials
end

#discovered_security_solutions ⇒ DiscoveredSecuritySolutions (readonly)

Returns discovered_security_solutions.

Returns:



58
59
60
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 58

def discovered_security_solutions
  @discovered_security_solutions
end

#external_security_solutions ⇒ ExternalSecuritySolutions (readonly)

Returns external_security_solutions.

Returns:



68
69
70
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 68

def external_security_solutions
  @external_security_solutions
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



40
41
42
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 40

def generate_client_request_id
  @generate_client_request_id
end

#jit_network_access_policies ⇒ JitNetworkAccessPolicies (readonly)

Returns jit_network_access_policies.

Returns:



71
72
73
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 71

def jit_network_access_policies
  @jit_network_access_policies
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



35
36
37
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 35

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#secure_score_control_definitions ⇒ SecureScoreControlDefinitions (readonly)

Returns secure_score_control_definitions.

Returns:



87
88
89
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 87

def secure_score_control_definitions
  @secure_score_control_definitions
end

#secure_score_controls ⇒ SecureScoreControls (readonly)

Returns secure_score_controls.

Returns:



84
85
86
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 84

def secure_score_controls
  @secure_score_controls
end

#secure_scores ⇒ SecureScores (readonly)

Returns secure_scores.

Returns:



81
82
83
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 81

def secure_scores
  @secure_scores
end

#security_solutions ⇒ SecuritySolutions (readonly)

Returns security_solutions.

Returns:



61
62
63
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 61

def security_solutions
  @security_solutions
end

#security_solutions_reference_data_operations ⇒ SecuritySolutionsReferenceDataOperations (readonly)

security_solutions_reference_data_operations

Returns:



65
66
67
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 65

def security_solutions_reference_data_operations
  @security_solutions_reference_data_operations
end

#server_vulnerability_assessment_operations ⇒ ServerVulnerabilityAssessmentOperations (readonly)

server_vulnerability_assessment_operations

Returns:



75
76
77
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 75

def server_vulnerability_assessment_operations
  @server_vulnerability_assessment_operations
end

#subscription_id ⇒ String

Returns Azure subscription ID.

Returns:

  • (String) —

    Azure subscription ID



24
25
26
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 24

def subscription_id
  @subscription_id
end

#topology ⇒ Topology (readonly)

Returns topology.

Returns:



78
79
80
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 78

def topology
  @topology
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



140
141
142
143
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 140

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 165

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



152
153
154
155
156
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/security_center.rb', line 152

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end