Class: Azure::Security::Mgmt::V2017_08_01_preview::SecurityCenter

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-08-01-preview/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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 100

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

  @advanced_threat_protection = AdvancedThreatProtection.new(self)
  @auto_provisioning_settings = AutoProvisioningSettings.new(self)
  @compliances = Compliances.new(self)
  @device_security_groups = DeviceSecurityGroups.new(self)
  @information_protection_policies = InformationProtectionPolicies.new(self)
  @io_tsecurity_solutions_analytics = IoTSecuritySolutionsAnalytics.new(self)
  @io_tsecurity_solutions_analytics_aggregated_alerts = IoTSecuritySolutionsAnalyticsAggregatedAlerts.new(self)
  @io_tsecurity_solutions_analytics_aggregated_alert = IoTSecuritySolutionsAnalyticsAggregatedAlert.new(self)
  @io_tsecurity_solutions_analytics_recommendation = IoTSecuritySolutionsAnalyticsRecommendation.new(self)
  @io_tsecurity_solutions_analytics_recommendations = IoTSecuritySolutionsAnalyticsRecommendations.new(self)
  @io_tsecurity_solutions = IoTSecuritySolutions.new(self)
  @io_tsecurity_solutions_resource_group = IoTSecuritySolutionsResourceGroup.new(self)
  @iot_security_solution = IotSecuritySolution.new(self)
  @pricings = Pricings.new(self)
  @security_contacts = SecurityContacts.new(self)
  @settings = Settings.new(self)
  @workspace_settings = WorkspaceSettings.new(self)
  @api_version = '2017-08-01-preview'
  @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.



27
28
29
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 27

def accept_language
  @accept_language
end

#advanced_threat_protection ⇒ AdvancedThreatProtection (readonly)

Returns advanced_threat_protection.

Returns:



39
40
41
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 39

def advanced_threat_protection
  @advanced_threat_protection
end

#api_version ⇒ String (readonly)

Returns API version for the operation.

Returns:

  • (String) —

    API version for the operation



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

def api_version
  @api_version
end

#auto_provisioning_settings ⇒ AutoProvisioningSettings (readonly)

Returns auto_provisioning_settings.

Returns:



42
43
44
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 42

def auto_provisioning_settings
  @auto_provisioning_settings
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



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

def base_url
  @base_url
end

#compliances ⇒ Compliances (readonly)

Returns compliances.

Returns:



45
46
47
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 45

def compliances
  @compliances
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/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 18

def credentials
  @credentials
end

#device_security_groups ⇒ DeviceSecurityGroups (readonly)

Returns device_security_groups.

Returns:



48
49
50
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 48

def device_security_groups
  @device_security_groups
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



36
37
38
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#information_protection_policies ⇒ InformationProtectionPolicies (readonly)

Returns information_protection_policies.

Returns:



51
52
53
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 51

def information_protection_policies
  @information_protection_policies
end

#io_tsecurity_solutions ⇒ IoTSecuritySolutions (readonly)

Returns io_tsecurity_solutions.

Returns:



73
74
75
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 73

def io_tsecurity_solutions
  @io_tsecurity_solutions
end

#io_tsecurity_solutions_analytics ⇒ IoTSecuritySolutionsAnalytics (readonly)

Returns io_tsecurity_solutions_analytics.

Returns:



54
55
56
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 54

def io_tsecurity_solutions_analytics
  @io_tsecurity_solutions_analytics
end

#io_tsecurity_solutions_analytics_aggregated_alert ⇒ IoTSecuritySolutionsAnalyticsAggregatedAlert (readonly)

io_tsecurity_solutions_analytics_aggregated_alert

Returns:



62
63
64
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 62

def io_tsecurity_solutions_analytics_aggregated_alert
  @io_tsecurity_solutions_analytics_aggregated_alert
end

#io_tsecurity_solutions_analytics_aggregated_alerts ⇒ IoTSecuritySolutionsAnalyticsAggregatedAlerts (readonly)

io_tsecurity_solutions_analytics_aggregated_alerts

Returns:



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

def io_tsecurity_solutions_analytics_aggregated_alerts
  @io_tsecurity_solutions_analytics_aggregated_alerts
end

#io_tsecurity_solutions_analytics_recommendation ⇒ IoTSecuritySolutionsAnalyticsRecommendation (readonly)

io_tsecurity_solutions_analytics_recommendation

Returns:



66
67
68
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 66

def io_tsecurity_solutions_analytics_recommendation
  @io_tsecurity_solutions_analytics_recommendation
end

#io_tsecurity_solutions_analytics_recommendations ⇒ IoTSecuritySolutionsAnalyticsRecommendations (readonly)

io_tsecurity_solutions_analytics_recommendations

Returns:



70
71
72
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 70

def io_tsecurity_solutions_analytics_recommendations
  @io_tsecurity_solutions_analytics_recommendations
end

#io_tsecurity_solutions_resource_group ⇒ IoTSecuritySolutionsResourceGroup (readonly)

io_tsecurity_solutions_resource_group

Returns:



77
78
79
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 77

def io_tsecurity_solutions_resource_group
  @io_tsecurity_solutions_resource_group
end

#iot_security_solution ⇒ IotSecuritySolution (readonly)

Returns iot_security_solution.

Returns:



80
81
82
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 80

def iot_security_solution
  @iot_security_solution
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#pricings ⇒ Pricings (readonly)

Returns pricings.

Returns:



83
84
85
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 83

def pricings
  @pricings
end

#security_contacts ⇒ SecurityContacts (readonly)

Returns security_contacts.

Returns:



86
87
88
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 86

def security_contacts
  @security_contacts
end

#settings ⇒ Settings (readonly)

Returns settings.

Returns:



89
90
91
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 89

def settings
  @settings
end

#subscription_id ⇒ String

Returns Azure subscription ID.

Returns:

  • (String) —

    Azure subscription ID



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

def subscription_id
  @subscription_id
end

#workspace_settings ⇒ WorkspaceSettings (readonly)

Returns workspace_settings.

Returns:



92
93
94
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 92

def workspace_settings
  @workspace_settings
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.



147
148
149
150
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 147

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.



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 172

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.



159
160
161
162
163
 
# File 'lib/2017-08-01-preview/generated/azure_mgmt_security/security_center.rb', line 159

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