Class: Azure::Monitor::Mgmt::V2018_03_01::MetricAlertsStatus

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb

Overview

Monitor Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ MetricAlertsStatus

Creates and initializes a new instance of the MetricAlertsStatus class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.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/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 22

def client
  @client
end

Instance Method Details

#list(resource_group_name, rule_name, custom_headers: nil) ⇒ MetricAlertStatusCollection

Retrieve an alert rule status.

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:

  • (MetricAlertStatusCollection) —

    operation results.



34
35
36
37
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 34

def list(resource_group_name, rule_name, custom_headers:nil)
  response = list_async(resource_group_name, rule_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Retrieve an alert rule status.

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.



63
64
65
66
67
68
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
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 63

def list_async(resource_group_name, rule_name, 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?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Insights/metricAlerts/{ruleName}/status'

  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' => @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 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?
    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::Monitor::Mgmt::V2018_03_01::Models::MetricAlertStatusCollection.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_name(resource_group_name, rule_name, status_name, custom_headers: nil) ⇒ MetricAlertStatusCollection

Retrieve an alert rule status.

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.

  • status_name (String) —

    The name of the status.

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

    A hash of custom headers that

Returns:

  • (MetricAlertStatusCollection) —

    operation results.



129
130
131
132
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 129

def list_by_name(resource_group_name, rule_name, status_name, custom_headers:nil)
  response = list_by_name_async(resource_group_name, rule_name, status_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_name_async(resource_group_name, rule_name, status_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve an alert rule status.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • rule_name (String) —

    The name of the rule.

  • status_name (String) —

    The name of the status.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 160

def list_by_name_async(resource_group_name, rule_name, status_name, 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?
  fail ArgumentError, 'status_name is nil' if status_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Insights/metricAlerts/{ruleName}/status/{statusName}'

  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,'statusName' => status_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 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?
    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::Monitor::Mgmt::V2018_03_01::Models::MetricAlertStatusCollection.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_name_with_http_info(resource_group_name, rule_name, status_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve an alert rule status.

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.

  • status_name (String) —

    The name of the status.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



145
146
147
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 145

def list_by_name_with_http_info(resource_group_name, rule_name, status_name, custom_headers:nil)
  list_by_name_async(resource_group_name, rule_name, status_name, custom_headers:custom_headers).value!
end

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

Retrieve an alert rule status.

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.



49
50
51
 
# File 'lib/2018-03-01/generated/azure_mgmt_monitor/metric_alerts_status.rb', line 49

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