Class: Azure::Automation::Mgmt::V2015_10_31::NodeReports

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb

Overview

Automation Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ NodeReports

Creates and initializes a new instance of the NodeReports class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientAutomationClient (readonly)

Returns reference to the AutomationClient.

Returns:



22
23
24
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ DscNodeReport

Retrieve the Dsc node report data by node id and report id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

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

    A hash of custom headers that

Returns:

  • (DscNodeReport)

    operation results.



138
139
140
141
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 138

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

#get_async(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the Dsc node report data by node id and report id.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 171

def get_async(resource_group_name, , node_id, report_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'node_id is nil' if node_id.nil?
  fail ArgumentError, 'report_id is nil' if report_id.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'automationAccountName' => ,'nodeId' => node_id,'reportId' => report_id,'subscriptionId' => @client.subscription_id},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::DscNodeReport.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_content(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ Object

Retrieve the Dsc node reports by node id and report id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

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

    A hash of custom headers that

Returns:

  • (Object)

    operation results.



241
242
243
244
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 241

def get_content(resource_group_name, , node_id, report_id, custom_headers:nil)
  response = get_content_async(resource_group_name, , node_id, report_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_content_async(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the Dsc node reports by node id and report id.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 274

def get_content_async(resource_group_name, , node_id, report_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'node_id is nil' if node_id.nil?
  fail ArgumentError, 'report_id is nil' if report_id.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}/content'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'automationAccountName' => ,'nodeId' => node_id,'reportId' => report_id,'subscriptionId' => @client.subscription_id},
      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
  end

  promise.execute
end

#get_content_with_http_info(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the Dsc node reports by node id and report id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



258
259
260
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 258

def get_content_with_http_info(resource_group_name, , node_id, report_id, custom_headers:nil)
  get_content_async(resource_group_name, , node_id, report_id, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, automation_account_name, node_id, report_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the Dsc node report data by node id and report id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The Dsc node id.

  • report_id (String)

    The report id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



155
156
157
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 155

def get_with_http_info(resource_group_name, , node_id, report_id, custom_headers:nil)
  get_async(resource_group_name, , node_id, report_id, custom_headers:custom_headers).value!
end

#list_by_node(resource_group_name, automation_account_name, node_id, filter: nil, custom_headers: nil) ⇒ Array<DscNodeReport>

Retrieve the Dsc node report list by node id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The parameters supplied to the list operation.

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (Array<DscNodeReport>)

    operation results.



36
37
38
39
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 36

def list_by_node(resource_group_name, , node_id, filter:nil, custom_headers:nil)
  first_page = list_by_node_as_lazy(resource_group_name, , node_id, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_node_as_lazy(resource_group_name, automation_account_name, node_id, filter: nil, custom_headers: nil) ⇒ DscNodeReportListResult

Retrieve the Dsc node report list by node id.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The parameters supplied to the list operation.

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (DscNodeReportListResult)

    which provide lazy access to pages of the



423
424
425
426
427
428
429
430
431
432
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 423

def list_by_node_as_lazy(resource_group_name, , node_id, filter:nil, custom_headers:nil)
  response = list_by_node_async(resource_group_name, , node_id, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_node_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_node_async(resource_group_name, automation_account_name, node_id, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the Dsc node report list by node id.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The parameters supplied to the list operation.

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 69

def list_by_node_async(resource_group_name, , node_id, filter:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'node_id is nil' if node_id.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'automationAccountName' => ,'nodeId' => node_id,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::DscNodeReportListResult.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_node_next(next_page_link, custom_headers: nil) ⇒ DscNodeReportListResult

Retrieve the Dsc node report list by node id.

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:

  • (DscNodeReportListResult)

    operation results.



332
333
334
335
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 332

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

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

Retrieve the Dsc node report list by node id.

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
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 361

def list_by_node_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::DscNodeReportListResult.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_node_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the Dsc node report list by node id.

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/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 347

def list_by_node_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_node_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_node_with_http_info(resource_group_name, automation_account_name, node_id, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the Dsc node report list by node id.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    Name of an Azure Resource group.

  • automation_account_name (String)

    The name of the automation account.

  • node_id (String)

    The parameters supplied to the list operation.

  • filter (String) (defaults to: nil)

    The filter to apply on the operation.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



53
54
55
# File 'lib/2015-10-31/generated/azure_mgmt_automation/node_reports.rb', line 53

def list_by_node_with_http_info(resource_group_name, , node_id, filter:nil, custom_headers:nil)
  list_by_node_async(resource_group_name, , node_id, filter:filter, custom_headers:custom_headers).value!
end