Class: Azure::SecurityInsights::Mgmt::V2020_01_01::Incidents

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb

Overview

API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Incidents

Creates and initializes a new instance of the Incidents class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityInsights (readonly)

Returns reference to the SecurityInsights.

Returns:



23
24
25
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, workspace_name, incident_id, incident, custom_headers: nil) ⇒ Incident

Creates or updates the incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

  • incident (Incident) —

    The incident

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

    A hash of custom headers that

Returns:

  • (Incident) —

    operation results.



272
273
274
275
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 272

def create_or_update(resource_group_name, workspace_name, incident_id, incident, custom_headers:nil)
  response = create_or_update_async(resource_group_name, workspace_name, incident_id, incident, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, workspace_name, incident_id, incident, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates the incident.

user’s subscription. The name is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

  • incident (Incident) —

    The incident

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 307

def create_or_update_async(resource_group_name, workspace_name, incident_id, incident, custom_headers:nil)
  @client.api_version = '2020-01-01'
  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, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'incident_id is nil' if incident_id.nil?
  fail ArgumentError, 'incident is nil' if incident.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?

  # Serialize Request
  request_mapper = Azure::SecurityInsights::Mgmt::V2020_01_01::Models::Incident.mapper()
  request_content = @client.serialize(request_mapper,  incident)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'incidentId' => incident_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 || status_code == 201
      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::SecurityInsights::Mgmt::V2020_01_01::Models::Incident.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::SecurityInsights::Mgmt::V2020_01_01::Models::Incident.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

#create_or_update_with_http_info(resource_group_name, workspace_name, incident_id, incident, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates the incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

  • incident (Incident) —

    The incident

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



290
291
292
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 290

def create_or_update_with_http_info(resource_group_name, workspace_name, incident_id, incident, custom_headers:nil)
  create_or_update_async(resource_group_name, workspace_name, incident_id, incident, custom_headers:custom_headers).value!
end

#delete(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ Object

Delete the incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

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

    A hash of custom headers that



398
399
400
401
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 398

def delete(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  response = delete_async(resource_group_name, workspace_name, incident_id, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ Concurrent::Promise

Delete the incident.

user’s subscription. The name is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 431

def delete_async(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  @client.api_version = '2020-01-01'
  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, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'incident_id is nil' if incident_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'incidentId' => incident_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete the incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



415
416
417
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 415

def delete_with_http_info(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  delete_async(resource_group_name, workspace_name, incident_id, custom_headers:custom_headers).value!
end

#get(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ Incident

Gets an incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

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

    A hash of custom headers that

Returns:

  • (Incident) —

    operation results.



164
165
166
167
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 164

def get(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  response = get_async(resource_group_name, workspace_name, incident_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets an incident.

user’s subscription. The name is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

  • 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
251
252
253
254
255
256
257
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 197

def get_async(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  @client.api_version = '2020-01-01'
  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, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'incident_id is nil' if incident_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'incidentId' => incident_id},
      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::SecurityInsights::Mgmt::V2020_01_01::Models::Incident.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(resource_group_name, workspace_name, incident_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an incident.

user’s subscription. The name is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

  • incident_id (String) —

    Incident ID

  • 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-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 181

def get_with_http_info(resource_group_name, workspace_name, incident_id, custom_headers:nil)
  get_async(resource_group_name, workspace_name, incident_id, custom_headers:custom_headers).value!
end

#list(resource_group_name, workspace_name, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<Incident>

Gets all incidents.

user’s subscription. The name is case insensitive. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

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

    Filters the results, based on a Boolean condition.

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

    Sorts the results. Optional.

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

    Returns only the first n results. Optional.

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

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (Array<Incident>) —

    operation results.



44
45
46
47
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 44

def list(resource_group_name, workspace_name, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, workspace_name, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, workspace_name, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ IncidentList

Gets all incidents.

user’s subscription. The name is case insensitive. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

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

    Filters the results, based on a Boolean condition.

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

    Sorts the results. Optional.

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

    Returns only the first n results. Optional.

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

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (IncidentList) —

    which provide lazy access to pages of the response.



592
593
594
595
596
597
598
599
600
601
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 592

def list_as_lazy(resource_group_name, workspace_name, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  response = list_async(resource_group_name, workspace_name, filter:filter, orderby:orderby, top:top, 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(resource_group_name, workspace_name, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets all incidents.

user’s subscription. The name is case insensitive. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

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

    Filters the results, based on a Boolean condition.

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

    Sorts the results. Optional.

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

    Returns only the first n results. Optional.

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

    Skiptoken is only used if a previous operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



91
92
93
94
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
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-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 91

def list_async(resource_group_name, workspace_name, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  @client.api_version = '2020-01-01'
  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, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1


  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}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$orderby' => orderby,'$top' => top,'$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::SecurityInsights::Mgmt::V2020_01_01::Models::IncidentList.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) ⇒ IncidentList

Gets all incidents.

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:

  • (IncidentList) —

    operation results.



493
494
495
496
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 493

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

Gets all incidents.

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.



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 522

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::SecurityInsights::Mgmt::V2020_01_01::Models::IncidentList.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

Gets all incidents.

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.



508
509
510
 
# File 'lib/2020-01-01/generated/azure_mgmt_security_insights/incidents.rb', line 508

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(resource_group_name, workspace_name, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all incidents.

user’s subscription. The name is case insensitive. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • workspace_name (String) —

    The name of the workspace.

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

    Filters the results, based on a Boolean condition.

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

    Sorts the results. Optional.

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

    Returns only the first n results. Optional.

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

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

def list_with_http_info(resource_group_name, workspace_name, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_async(resource_group_name, workspace_name, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end