Class: Azure::ResourceHealth::Mgmt::V2018_07_01::EventsOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb

Overview

The Resource Health Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ EventsOperations

Creates and initializes a new instance of the EventsOperations class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientResourceHealthClient (readonly)

Returns reference to the ResourceHealthClient.

Returns:



22
23
24
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 22

def client
  @client
end

Instance Method Details

#list_by_single_resource(resource_uri, filter: nil, custom_headers: nil) ⇒ Array<Event>

Lists current service health events for given resource.

including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/subscriptionId/resourceGroups/resource-group-name/providers/resource-provider-name/resource-type/resource-name and /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resource-provider-name/parentResourceType/parentResourceName/resourceType/resourceName information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • resource_uri (String)

    The fully qualified ID of the resource,

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (Array<Event>)

    operation results.



136
137
138
139
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 136

def list_by_single_resource(resource_uri, filter:nil, custom_headers:nil)
  first_page = list_by_single_resource_as_lazy(resource_uri, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_single_resource_as_lazy(resource_uri, filter: nil, custom_headers: nil) ⇒ Events

Lists current service health events for given resource.

including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/subscriptionId/resourceGroups/resource-group-name/providers/resource-provider-name/resource-type/resource-name and /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resource-provider-name/parentResourceType/parentResourceName/resourceType/resourceName information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • resource_uri (String)

    The fully qualified ID of the resource,

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (Events)

    which provide lazy access to pages of the response.



451
452
453
454
455
456
457
458
459
460
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 451

def list_by_single_resource_as_lazy(resource_uri, filter:nil, custom_headers:nil)
  response = list_by_single_resource_async(resource_uri, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_single_resource_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_single_resource_async(resource_uri, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists current service health events for given resource.

including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/subscriptionId/resourceGroups/resource-group-name/providers/resource-provider-name/resource-type/resource-name and /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resource-provider-name/parentResourceType/parentResourceName/resourceType/resourceName information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN to the HTTP request.

Parameters:

  • resource_uri (String)

    The fully qualified ID of the resource,

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

  • 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
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 179

def list_by_single_resource_async(resource_uri, filter:nil, custom_headers:nil)
  fail ArgumentError, 'resource_uri is nil' if resource_uri.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 = '{resourceUri}/providers/Microsoft.ResourceHealth/events'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'resourceUri' => resource_uri},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'view' => @client.view},
      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::ResourceHealth::Mgmt::V2018_07_01::Models::Events.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_single_resource_next(next_page_link, custom_headers: nil) ⇒ Events

Lists current service health events for given resource.

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:

  • (Events)

    operation results.



332
333
334
335
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 332

def list_by_single_resource_next(next_page_link, custom_headers:nil)
  response = list_by_single_resource_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_single_resource_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists current service health events for given resource.

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.



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
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 361

def list_by_single_resource_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 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::ResourceHealth::Mgmt::V2018_07_01::Models::Events.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_single_resource_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists current service health events for given resource.

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.



347
348
349
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 347

def list_by_single_resource_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_single_resource_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_single_resource_with_http_info(resource_uri, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists current service health events for given resource.

including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/subscriptionId/resourceGroups/resource-group-name/providers/resource-provider-name/resource-type/resource-name and /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/resource-provider-name/parentResourceType/parentResourceName/resourceType/resourceName information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • resource_uri (String)

    The fully qualified ID of the resource,

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



158
159
160
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 158

def list_by_single_resource_with_http_info(resource_uri, filter:nil, custom_headers:nil)
  list_by_single_resource_async(resource_uri, filter:filter, custom_headers:custom_headers).value!
end

#list_by_subscription_id(filter: nil, custom_headers: nil) ⇒ Array<Event>

Lists current service health events in the subscription.

information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (Array<Event>)

    operation results.



35
36
37
38
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 35

def list_by_subscription_id(filter:nil, custom_headers:nil)
  first_page = list_by_subscription_id_as_lazy(filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_subscription_id_as_lazy(filter: nil, custom_headers: nil) ⇒ Events

Lists current service health events in the subscription.

information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (Events)

    which provide lazy access to pages of the response.



423
424
425
426
427
428
429
430
431
432
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 423

def list_by_subscription_id_as_lazy(filter:nil, custom_headers:nil)
  response = list_by_subscription_id_async(filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_subscription_id_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_subscription_id_async(filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists current service health events in the subscription.

information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
117
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 66

def list_by_subscription_id_async(filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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}/providers/Microsoft.ResourceHealth/events'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'view' => @client.view},
      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::ResourceHealth::Mgmt::V2018_07_01::Models::Events.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_subscription_id_next(next_page_link, custom_headers: nil) ⇒ Events

Lists current service health events in the subscription.

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:

  • (Events)

    operation results.



242
243
244
245
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 242

def list_by_subscription_id_next(next_page_link, custom_headers:nil)
  response = list_by_subscription_id_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_subscription_id_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists current service health events in the subscription.

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.



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
311
312
313
314
315
316
317
318
319
320
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 271

def list_by_subscription_id_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 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::ResourceHealth::Mgmt::V2018_07_01::Models::Events.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_subscription_id_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists current service health events in the subscription.

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.



257
258
259
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 257

def list_by_subscription_id_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_subscription_id_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_subscription_id_with_http_info(filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists current service health events in the subscription.

information please see docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil)

    The filter to apply on the operation. For more

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



51
52
53
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/events_operations.rb', line 51

def list_by_subscription_id_with_http_info(filter:nil, custom_headers:nil)
  list_by_subscription_id_async(filter:filter, custom_headers:custom_headers).value!
end