Class: Azure::Security::Mgmt::V2020_08_06_preview::IotAlerts

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IotAlerts

Creates and initializes a new instance of the IotAlerts class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityCenter (readonly)

Returns reference to the SecurityCenter.

Returns:



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

def client
  @client
end

Instance Method Details

#get(scope, iot_alert_id, custom_headers: nil) ⇒ IotAlertModel

Get IoT alert

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

  • iot_alert_id (String) —

    Id of the alert

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

    A hash of custom headers that

Returns:

  • (IotAlertModel) —

    operation results.



164
165
166
167
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 164

def get(scope, iot_alert_id, custom_headers:nil)
  response = get_async(scope, iot_alert_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(scope, iot_alert_id, custom_headers: nil) ⇒ Concurrent::Promise

Get IoT alert

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

  • iot_alert_id (String) —

    Id of the alert

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 197

def get_async(scope, iot_alert_id, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'iot_alert_id is nil' if iot_alert_id.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 = '{scope}/providers/Microsoft.Security/iotAlerts/{iotAlertId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'iotAlertId' => iot_alert_id},
      skip_encoding_path_params: {'scope' => scope},
      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::V2020_08_06_preview::Models::IotAlertModel.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(scope, iot_alert_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get IoT alert

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

  • iot_alert_id (String) —

    Id of the alert

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



181
182
183
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 181

def get_with_http_info(scope, iot_alert_id, custom_headers:nil)
  get_async(scope, iot_alert_id, custom_headers:custom_headers).value!
end

#list(scope, min_start_time_utc: nil, max_start_time_utc: nil, alert_type: nil, device_management_type: nil, compromised_entity: nil, limit: nil, skip_token: nil, custom_headers: nil) ⇒ Array<IotAlertModel>

List IoT alerts

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) format) format) specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

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

    Filter by minimum startTimeUtc (ISO 8601

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

    Filter by maximum startTimeUtc (ISO 8601

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

    Filter by alert type

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    Filter by compromised device

  • limit (Integer) (defaults to: nil) —

    Limit the number of items returned in a single page

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

    Skip token used for pagination

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

    A hash of custom headers that

Returns:

  • (Array<IotAlertModel>) —

    operation results.



46
47
48
49
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 46

def list(scope, min_start_time_utc:nil, max_start_time_utc:nil, alert_type:nil, device_management_type:nil, compromised_entity:nil, limit:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(scope, min_start_time_utc:min_start_time_utc, max_start_time_utc:max_start_time_utc, alert_type:alert_type, device_management_type:device_management_type, compromised_entity:compromised_entity, limit:limit, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(scope, min_start_time_utc: nil, max_start_time_utc: nil, alert_type: nil, device_management_type: nil, compromised_entity: nil, limit: nil, skip_token: nil, custom_headers: nil) ⇒ IotAlertListModel

List IoT alerts

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) format) format) specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

response.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

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

    Filter by minimum startTimeUtc (ISO 8601

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

    Filter by maximum startTimeUtc (ISO 8601

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

    Filter by alert type

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    Filter by compromised device

  • limit (Integer) (defaults to: nil) —

    Limit the number of items returned in a single page

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

    Skip token used for pagination

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

    A hash of custom headers that

Returns:

  • (IotAlertListModel) —

    which provide lazy access to pages of the



365
366
367
368
369
370
371
372
373
374
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 365

def list_as_lazy(scope, min_start_time_utc:nil, max_start_time_utc:nil, alert_type:nil, device_management_type:nil, compromised_entity:nil, limit:nil, skip_token:nil, custom_headers:nil)
  response = list_async(scope, min_start_time_utc:min_start_time_utc, max_start_time_utc:max_start_time_utc, alert_type:alert_type, device_management_type:device_management_type, compromised_entity:compromised_entity, limit:limit, skip_token:skip_token, 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(scope, min_start_time_utc: nil, max_start_time_utc: nil, alert_type: nil, device_management_type: nil, compromised_entity: nil, limit: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

List IoT alerts

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) format) format) specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

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

    Filter by minimum startTimeUtc (ISO 8601

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

    Filter by maximum startTimeUtc (ISO 8601

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

    Filter by alert type

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    Filter by compromised device

  • limit (Integer) (defaults to: nil) —

    Limit the number of items returned in a single page

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

    Skip token used for pagination

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



99
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 99

def list_async(scope, min_start_time_utc:nil, max_start_time_utc:nil, alert_type:nil, device_management_type:nil, compromised_entity:nil, limit:nil, skip_token:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.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 = '{scope}/providers/Microsoft.Security/iotAlerts'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version,'startTimeUtc>' => min_start_time_utc,'startTimeUtc<' => max_start_time_utc,'alertType' => alert_type,'deviceManagementType' => device_management_type,'compromisedEntity' => compromised_entity,'$limit' => limit,'$skipToken' => skip_token},
      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_08_06_preview::Models::IotAlertListModel.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) ⇒ IotAlertListModel

List IoT alerts

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (IotAlertListModel) —

    operation results.



262
263
264
265
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 262

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) ⇒ Concurrent::Promise

List IoT alerts

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 291

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_08_06_preview::Models::IotAlertListModel.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) ⇒ MsRestAzure::AzureOperationResponse

List IoT alerts

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



277
278
279
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 277

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(scope, min_start_time_utc: nil, max_start_time_utc: nil, alert_type: nil, device_management_type: nil, compromised_entity: nil, limit: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List IoT alerts

/subscriptions/subscriptionId) or IoT Hub (i.e. /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Devices/iotHubs/iotHubName) format) format) specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query: Subscription (i.e.

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

    Filter by minimum startTimeUtc (ISO 8601

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

    Filter by maximum startTimeUtc (ISO 8601

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

    Filter by alert type

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    Filter by compromised device

  • limit (Integer) (defaults to: nil) —

    Limit the number of items returned in a single page

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

    Skip token used for pagination

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



73
74
75
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_alerts.rb', line 73

def list_with_http_info(scope, min_start_time_utc:nil, max_start_time_utc:nil, alert_type:nil, device_management_type:nil, compromised_entity:nil, limit:nil, skip_token:nil, custom_headers:nil)
  list_async(scope, min_start_time_utc:min_start_time_utc, max_start_time_utc:max_start_time_utc, alert_type:alert_type, device_management_type:device_management_type, compromised_entity:compromised_entity, limit:limit, skip_token:skip_token, custom_headers:custom_headers).value!
end