Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::AlertRuleTemplates

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AlertRuleTemplates

Creates and initializes a new instance of the AlertRuleTemplates class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.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/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 23

def client
  @client
end

Instance Method Details

#get(resource_group_name, operational_insights_resource_provider, workspace_name, alert_rule_template_id, custom_headers: nil) ⇒ AlertRuleTemplate

Gets the alert rule template.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • alert_rule_template_id (String) —

    Alert rule template ID

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

    A hash of custom headers that

Returns:

  • (AlertRuleTemplate) —

    operation results.



149
150
151
152
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 149

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

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

Gets the alert rule template.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • alert_rule_template_id (String) —

    Alert rule template ID

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



186
187
188
189
190
191
192
193
194
195
196
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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 186

def get_async(resource_group_name, operational_insights_resource_provider, workspace_name, alert_rule_template_id, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.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, 'alert_rule_template_id is nil' if alert_rule_template_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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'alertRuleTemplateId' => alert_rule_template_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::V2019_01_01_preview::Models::AlertRuleTemplate.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, operational_insights_resource_provider, workspace_name, alert_rule_template_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the alert rule template.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • alert_rule_template_id (String) —

    Alert rule template ID

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



168
169
170
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 168

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

#list(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers: nil) ⇒ Array<AlertRuleTemplate>

Gets all alert rule templates.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

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

    A hash of custom headers that

Returns:

  • (Array<AlertRuleTemplate>) —

    operation results.



38
39
40
41
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 38

def list(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers: nil) ⇒ AlertRuleTemplatesList

Gets all alert rule templates.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

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

    A hash of custom headers that

Returns:

  • (AlertRuleTemplatesList) —

    which provide lazy access to pages of the



353
354
355
356
357
358
359
360
361
362
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 353

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

Gets all alert rule templates.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 73

def list_async(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.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/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name},
      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::V2019_01_01_preview::Models::AlertRuleTemplatesList.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) ⇒ AlertRuleTemplatesList

Gets all alert rule templates.

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:

  • (AlertRuleTemplatesList) —

    operation results.



259
260
261
262
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 259

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 alert rule templates.

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.



288
289
290
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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 288

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::V2019_01_01_preview::Models::AlertRuleTemplatesList.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 alert rule templates.

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.



274
275
276
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 274

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, operational_insights_resource_provider, workspace_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all alert rule templates.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



56
57
58
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/alert_rule_templates.rb', line 56

def list_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers:nil)
  list_async(resource_group_name, operational_insights_resource_provider, workspace_name, custom_headers:custom_headers).value!
end