Class: Azure::ResourceHealth::Mgmt::V2017_07_01::ChildAvailabilityStatuses

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

Overview

The Resource Health Client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ChildAvailabilityStatuses

Creates and initializes a new instance of the ChildAvailabilityStatuses class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_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/2017-07-01/generated/azure_mgmt_resource_health/child_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 only support one nesting level resource types : /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.



41
42
43
44
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 41

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 only support one nesting level resource types : /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.



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
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 84

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/childAvailabilityStatuses/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::V2017_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 only support one nesting level resource types : /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.



63
64
65
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 63

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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

including the resource name and resource type. Currently the API only support one nesting level resource types : /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.



156
157
158
159
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 156

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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

including the resource name and resource type. Currently the API only support one nesting level resource types : /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



372
373
374
375
376
377
378
379
380
381
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 372

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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

including the resource name and resource type. Currently the API only support one nesting level resource types : /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.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 203

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/childAvailabilityStatuses'

  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::V2017_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(next_page_link, custom_headers: nil) ⇒ AvailabilityStatusListResult

Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

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.



268
269
270
271
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 268

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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

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.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 301

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::V2017_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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

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.



285
286
287
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 285

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 the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status

including the resource name and resource type. Currently the API only support one nesting level resource types : /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.



180
181
182
 
# File 'lib/2017-07-01/generated/azure_mgmt_resource_health/child_availability_statuses.rb', line 180

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