Class: Azure::ARM::Monitor::AlertRules

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_monitor/alert_rules.rb

Overview

Monitor Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AlertRules

Creates and initializes a new instance of the AlertRules class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ MonitorManagementClient (readonly)

Returns reference to the MonitorManagementClient.

Returns:



22
23
24
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, rule_name, parameters, custom_headers = nil) ⇒ AlertRuleResource

Creates or updates an alert rule.

update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • parameters (AlertRuleResource) —

    The parameters of the rule to create or

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

    A hash of custom headers that

Returns:

  • (AlertRuleResource) —

    operation results.



36
37
38
39
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 36

def create_or_update(resource_group_name, rule_name, parameters, custom_headers = nil)
  response = create_or_update_async(resource_group_name, rule_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, rule_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates or updates an alert rule.

update. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • parameters (AlertRuleResource) —

    The parameters of the rule to create or

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



69
70
71
72
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
134
135
136
137
138
139
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 69

def create_or_update_async(resource_group_name, rule_name, parameters, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  api_version = '2016-03-01'
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = Azure::ARM::Monitor::Models::AlertRuleResource.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'ruleName' => rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Monitor::Models::AlertRuleResource.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::ARM::Monitor::Models::AlertRuleResource.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, rule_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates an alert rule.

update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • parameters (AlertRuleResource) —

    The parameters of the rule to create or

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 53

def create_or_update_with_http_info(resource_group_name, rule_name, parameters, custom_headers = nil)
  create_or_update_async(resource_group_name, rule_name, parameters, custom_headers).value!
end

#delete(resource_group_name, rule_name, custom_headers = nil) ⇒ Object

Deletes an alert rule

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    A hash of custom headers that



150
151
152
153
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 150

def delete(resource_group_name, rule_name, custom_headers = nil)
  response = delete_async(resource_group_name, rule_name, custom_headers).value!
  nil
end

#delete_async(resource_group_name, rule_name, custom_headers = nil) ⇒ Concurrent::Promise

Deletes an alert rule

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



179
180
181
182
183
184
185
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
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 179

def delete_async(resource_group_name, rule_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  api_version = '2016-03-01'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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.insights/alertrules/{ruleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'ruleName' => rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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 == 204 || 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
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, rule_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an alert rule

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



165
166
167
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 165

def delete_with_http_info(resource_group_name, rule_name, custom_headers = nil)
  delete_async(resource_group_name, rule_name, custom_headers).value!
end

#get(resource_group_name, rule_name, custom_headers = nil) ⇒ AlertRuleResource

Gets an alert rule

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (AlertRuleResource) —

    operation results.



231
232
233
234
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 231

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

#get_async(resource_group_name, rule_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets an alert rule

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 260

def get_async(resource_group_name, rule_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  api_version = '2016-03-01'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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.insights/alertrules/{ruleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'ruleName' => rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Monitor::Models::AlertRuleResource.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, rule_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an alert rule

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



246
247
248
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 246

def get_with_http_info(resource_group_name, rule_name, custom_headers = nil)
  get_async(resource_group_name, rule_name, custom_headers).value!
end

#list_by_resource_group(resource_group_name, custom_headers = nil) ⇒ AlertRuleResourceCollection

List the alert rules within a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (AlertRuleResourceCollection) —

    operation results.



441
442
443
444
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 441

def list_by_resource_group(resource_group_name, custom_headers = nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers).value!
  response.body unless response.nil?
end

#list_by_resource_group_async(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

List the alert rules within a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 468

def list_by_resource_group_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  api_version = '2016-03-01'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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.insights/alertrules'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Monitor::Models::AlertRuleResourceCollection.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_by_resource_group_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

List the alert rules within a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



455
456
457
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 455

def list_by_resource_group_with_http_info(resource_group_name, custom_headers = nil)
  list_by_resource_group_async(resource_group_name, custom_headers).value!
end

#update(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil) ⇒ AlertRuleResource

Updates an existing AlertRuleResource. To update other fields use the CreateOrUpdate method.

the operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • alert_rules_resource (AlertRuleResourcePatch) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (AlertRuleResource) —

    operation results.



325
326
327
328
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 325

def update(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil)
  response = update_async(resource_group_name, rule_name, alert_rules_resource, custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil) ⇒ Concurrent::Promise

Updates an existing AlertRuleResource. To update other fields use the CreateOrUpdate method.

the operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • alert_rules_resource (AlertRuleResourcePatch) —

    Parameters supplied to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 360

def update_async(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'rule_name is nil' if rule_name.nil?
  api_version = '2016-03-01'
  fail ArgumentError, 'alert_rules_resource is nil' if alert_rules_resource.nil?


  request_headers = {}

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Serialize Request
  request_mapper = Azure::ARM::Monitor::Models::AlertRuleResourcePatch.mapper()
  request_content = @client.serialize(request_mapper,  alert_rules_resource)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/alertrules/{ruleName}'

  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,'ruleName' => rule_name},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ARM::Monitor::Models::AlertRuleResource.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::ARM::Monitor::Models::AlertRuleResource.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

#update_with_http_info(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an existing AlertRuleResource. To update other fields use the CreateOrUpdate method.

the operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • alert_rules_resource (AlertRuleResourcePatch) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



343
344
345
 
# File 'lib/generated/azure_mgmt_monitor/alert_rules.rb', line 343

def update_with_http_info(resource_group_name, rule_name, alert_rules_resource, custom_headers = nil)
  update_async(resource_group_name, rule_name, alert_rules_resource, custom_headers).value!
end