Class: Azure::ResourceHealth::Mgmt::V2018_07_01::AvailabilityStatuses

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

Overview

The Resource Health Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AvailabilityStatuses

Creates and initializes a new instance of the AvailabilityStatuses class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ResourceHealthClient (readonly)

Returns reference to the ResourceHealthClient.

Returns:



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

def client
  @client
end

Instance Method Details

#get_by_resource(resource_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ AvailabilityStatus

Gets current availability status for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (AvailabilityStatus) —

    operation results.



255
256
257
258
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 255

def get_by_resource(resource_uri, filter:nil, expand:nil, custom_headers:nil)
  response = get_by_resource_async(resource_uri, filter:filter, expand:expand, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Gets current availability status for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 302

def get_by_resource_async(resource_uri, filter:nil, expand: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/availabilityStatuses/current'

  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,'$expand' => expand},
      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::AvailabilityStatus.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_by_resource_with_http_info(resource_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets current availability status for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



279
280
281
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 279

def get_by_resource_with_http_info(resource_uri, filter:nil, expand:nil, custom_headers:nil)
  get_by_resource_async(resource_uri, filter:filter, expand:expand, custom_headers:custom_headers).value!
end

#list(resource_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ Array<AvailabilityStatus>

Lists all historical availability transitions and impacting events for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (Array<AvailabilityStatus>) —

    operation results.



375
376
377
378
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 375

def list(resource_uri, filter:nil, expand:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_uri, filter:filter, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists all historical availability transitions and impacting events for a single 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 expands the recommendedactions in the response. will be added to the HTTP request.

the response.

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

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (AvailabilityStatusListResult) —

    which provide lazy access to pages of



830
831
832
833
834
835
836
837
838
839
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 830

def list_as_lazy(resource_uri, filter:nil, expand:nil, custom_headers:nil)
  response = list_async(resource_uri, filter:filter, expand:expand, 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_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all historical availability transitions and impacting events for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



424
425
426
427
428
429
430
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
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 424

def list_async(resource_uri, filter:nil, expand: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/availabilityStatuses'

  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,'$expand' => expand},
      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::AvailabilityStatusListResult.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(resource_group_name, filter: nil, expand: nil, custom_headers: nil) ⇒ Array<AvailabilityStatus>

Lists the current availability status for all the resources in the resource group.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (Array<AvailabilityStatus>) —

    operation results.



143
144
145
146
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 143

def list_by_resource_group(resource_group_name, filter:nil, expand:nil, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, filter:filter, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, filter: nil, expand: nil, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists the current availability status for all the resources in the resource group.

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

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (AvailabilityStatusListResult) —

    which provide lazy access to pages of



798
799
800
801
802
803
804
805
806
807
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 798

def list_by_resource_group_as_lazy(resource_group_name, filter:nil, expand:nil, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, filter:filter, expand:expand, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Lists the current availability status for all the resources in the resource group.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
231
232
233
234
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 182

def list_by_resource_group_async(resource_group_name, filter:nil, expand:nil, 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, '@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.ResourceHealth/availabilityStatuses'

  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},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$expand' => expand},
      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::AvailabilityStatusListResult.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_next(next_page_link, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists the current availability status for all the resources in the resource group.

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:

  • (AvailabilityStatusListResult) —

    operation results.



581
582
583
584
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 581

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

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

Lists the current availability status for all the resources in the resource group.

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.



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 612

def list_by_resource_group_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::AvailabilityStatusListResult.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the current availability status for all the resources in the resource group.

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.



597
598
599
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 597

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, filter: nil, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the current availability status for all the resources in the resource group.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



163
164
165
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 163

def list_by_resource_group_with_http_info(resource_group_name, filter:nil, expand:nil, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, filter:filter, expand:expand, custom_headers:custom_headers).value!
end

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

Lists the current availability status for all the resources in the subscription.

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

Parameters:

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (Array<AvailabilityStatus>) —

    operation results.



38
39
40
41
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 38

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

#list_by_subscription_id_as_lazy(filter: nil, expand: nil, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists the current availability status for all the resources in the subscription.

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

the response.

Parameters:

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (AvailabilityStatusListResult) —

    which provide lazy access to pages of



771
772
773
774
775
776
777
778
779
780
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 771

def list_by_subscription_id_as_lazy(filter:nil, expand:nil, custom_headers:nil)
  response = list_by_subscription_id_async(filter:filter, expand:expand, 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, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the current availability status for all the resources in the subscription.

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

Parameters:

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_by_subscription_id_async(filter:nil, expand: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/availabilityStatuses'

  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,'$expand' => expand},
      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::AvailabilityStatusListResult.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) ⇒ AvailabilityStatusListResult

Lists the current availability status for all the resources 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:

  • (AvailabilityStatusListResult) —

    operation results.



488
489
490
491
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 488

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 the current availability status for all the resources 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.



519
520
521
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
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 519

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::AvailabilityStatusListResult.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 the current availability status for all the resources 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.



504
505
506
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 504

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

Lists the current availability status for all the resources in the subscription.

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

Parameters:

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

    The filter to apply on the operation. For more

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



57
58
59
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 57

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

#list_next(next_page_link, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists all historical availability transitions and impacting events for a single 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:

  • (AvailabilityStatusListResult) —

    operation results.



674
675
676
677
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 674

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

Lists all historical availability transitions and impacting events for a single 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.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 705

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 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::AvailabilityStatusListResult.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

Lists all historical availability transitions and impacting events for a single 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.



690
691
692
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 690

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_uri, filter: nil, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all historical availability transitions and impacting events for a single 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 expands the recommendedactions in the response. 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

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

    Setting $expand=recommendedactions in url query

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



400
401
402
 
# File 'lib/2018-07-01/generated/azure_mgmt_resource_health/availability_statuses.rb', line 400

def list_with_http_info(resource_uri, filter:nil, expand:nil, custom_headers:nil)
  list_async(resource_uri, filter:filter, expand:expand, custom_headers:custom_headers).value!
end