Class: Azure::Security::Mgmt::V2020_08_06_preview::SecurityCenter

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 74

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

  @iot_defender_settings = IotDefenderSettings.new(self)
  @iot_sensors = IotSensors.new(self)
  @devices_for_subscription = DevicesForSubscription.new(self)
  @devices_for_hub = DevicesForHub.new(self)
  @device_operations = DeviceOperations.new(self)
  @on_premise_iot_sensors = OnPremiseIotSensors.new(self)
  @iot_alerts = IotAlerts.new(self)
  @iot_alert_types = IotAlertTypes.new(self)
  @iot_recommendations = IotRecommendations.new(self)
  @iot_recommendation_types = IotRecommendationTypes.new(self)
  @api_version = '2020-08-06-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/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 27

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns API version for the operation.

Returns:

  • (String) —

    API version for the operation



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

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

def credentials
  @credentials
end

#device_operations ⇒ DeviceOperations (readonly)

Returns device_operations.

Returns:



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

def device_operations
  @device_operations
end

#devices_for_hub ⇒ DevicesForHub (readonly)

Returns devices_for_hub.

Returns:



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

def devices_for_hub
  @devices_for_hub
end

#devices_for_subscription ⇒ DevicesForSubscription (readonly)

Returns devices_for_subscription.

Returns:



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

def devices_for_subscription
  @devices_for_subscription
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/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#iot_alert_types ⇒ IotAlertTypes (readonly)

Returns iot_alert_types.

Returns:



60
61
62
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 60

def iot_alert_types
  @iot_alert_types
end

#iot_alerts ⇒ IotAlerts (readonly)

Returns iot_alerts.

Returns:



57
58
59
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 57

def iot_alerts
  @iot_alerts
end

#iot_defender_settings ⇒ IotDefenderSettings (readonly)

Returns iot_defender_settings.

Returns:



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

def iot_defender_settings
  @iot_defender_settings
end

#iot_recommendation_types ⇒ IotRecommendationTypes (readonly)

Returns iot_recommendation_types.

Returns:



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

def iot_recommendation_types
  @iot_recommendation_types
end

#iot_recommendations ⇒ IotRecommendations (readonly)

Returns iot_recommendations.

Returns:



63
64
65
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 63

def iot_recommendations
  @iot_recommendations
end

#iot_sensors ⇒ IotSensors (readonly)

Returns iot_sensors.

Returns:



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

def iot_sensors
  @iot_sensors
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/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#on_premise_iot_sensors ⇒ OnPremiseIotSensors (readonly)

Returns on_premise_iot_sensors.

Returns:



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

def on_premise_iot_sensors
  @on_premise_iot_sensors
end

#subscription_id ⇒ String

Returns Azure subscription ID.

Returns:

  • (String) —

    Azure subscription ID



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

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



114
115
116
117
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 114

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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 139

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.



126
127
128
129
130
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/security_center.rb', line 126

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