Class: Azure::Automation::Mgmt::V2015_10_31::JobOperations

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

Overview

Automation Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JobOperations

Creates and initializes a new instance of the JobOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AutomationClient (readonly)

Returns reference to the AutomationClient.

Returns:



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

def client
  @client
end

Instance Method Details

#create(resource_group_name, automation_account_name, job_id, parameters, custom_headers: nil) ⇒ Job

Create a job of the runbook.

job operation. 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.

  • job_id —

    The job id.

  • parameters (JobCreateParameters) —

    The parameters supplied to the create

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.



524
525
526
527
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 524

def create(resource_group_name, , job_id, parameters, custom_headers:nil)
  response = create_async(resource_group_name, , job_id, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, automation_account_name, job_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Create a job of the runbook.

job operation. 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.

  • job_id —

    The job id.

  • parameters (JobCreateParameters) —

    The parameters supplied to the create

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 559

def create_async(resource_group_name, , job_id, parameters, 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, 'job_id is nil' if job_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?

  # Serialize Request
  request_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::JobCreateParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobId}'

  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' => ,'jobId' => job_id,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 == 201
      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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::Job.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

#create_with_http_info(resource_group_name, automation_account_name, job_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a job of the runbook.

job operation. 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.

  • job_id —

    The job id.

  • parameters (JobCreateParameters) —

    The parameters supplied to the create

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



542
543
544
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 542

def create_with_http_info(resource_group_name, , job_id, parameters, custom_headers:nil)
  create_async(resource_group_name, , job_id, parameters, custom_headers:custom_headers).value!
end

#get(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Job

Retrieve the job identified by job 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.

  • job_id —

    The job id.

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.



423
424
425
426
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 423

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

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

Retrieve the job identified by job 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.

  • job_id —

    The job id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 454

def get_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}'

  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' => ,'jobId' => job_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::Job.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_output(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ NOT_IMPLEMENTED

Retrieve the job output identified by job 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.

  • job_id (String) —

    The job id.

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

    A hash of custom headers that

Returns:

  • (NOT_IMPLEMENTED) —

    operation results.



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

def get_output(resource_group_name, , job_id, custom_headers:nil)
  response = get_output_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_output_async(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the job output identified by job 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.

  • job_id (String) —

    The job id.

  • 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
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 66

def get_output_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}/output'

  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' => ,'jobId' => job_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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        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_output_with_http_info(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the job output identified by job 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.

  • job_id (String) —

    The job id.

  • 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/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 51

def get_output_with_http_info(resource_group_name, , job_id, custom_headers:nil)
  get_output_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
end

#get_runbook_content(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ NOT_IMPLEMENTED

Retrieve the runbook content of the job identified by job 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.

  • job_id (String) —

    The job id.

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

    A hash of custom headers that

Returns:

  • (NOT_IMPLEMENTED) —

    operation results.



141
142
143
144
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 141

def get_runbook_content(resource_group_name, , job_id, custom_headers:nil)
  response = get_runbook_content_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_runbook_content_async(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the runbook content of the job identified by job 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.

  • job_id (String) —

    The job id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
228
229
230
231
232
233
234
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 172

def get_runbook_content_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}/runbookContent'

  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' => ,'jobId' => job_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 = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        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_runbook_content_with_http_info(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the runbook content of the job identified by job 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.

  • job_id (String) —

    The job id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



157
158
159
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 157

def get_runbook_content_with_http_info(resource_group_name, , job_id, custom_headers:nil)
  get_runbook_content_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
end

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

Retrieve the job identified by job 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.

  • job_id —

    The job id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



439
440
441
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 439

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

#list_by_automation_account(resource_group_name, automation_account_name, filter: nil, custom_headers: nil) ⇒ Array<Job>

Retrieve a list of jobs.

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.

  • 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<Job>) —

    operation results.



635
636
637
638
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 635

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

#list_by_automation_account_as_lazy(resource_group_name, automation_account_name, filter: nil, custom_headers: nil) ⇒ JobListResult

Retrieve a list of jobs.

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.

  • 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:

  • (JobListResult) —

    which provide lazy access to pages of the response.



909
910
911
912
913
914
915
916
917
918
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 909

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

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

Retrieve a list of jobs.

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.

  • 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.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 666

def (resource_group_name, , 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, '@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}/jobs'

  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' => ,'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::JobListResult.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_automation_account_next(next_page_link, custom_headers: nil) ⇒ JobListResult

Retrieve a list of jobs.

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:

  • (JobListResult) —

    operation results.



820
821
822
823
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 820

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

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

Retrieve a list of jobs.

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.



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 849

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

Retrieve a list of jobs.

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.



835
836
837
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 835

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

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

Retrieve a list of jobs.

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.

  • 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.



651
652
653
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 651

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

#resume(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Object

Resume the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that



732
733
734
735
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 732

def resume(resource_group_name, , job_id, custom_headers:nil)
  response = resume_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
  nil
end

#resume_async(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Resume the job identified by jobId.

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.

  • job_id —

    The job id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 763

def resume_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}/resume'

  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' => ,'jobId' => job_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(:post, 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

#resume_with_http_info(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Resume the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



748
749
750
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 748

def resume_with_http_info(resource_group_name, , job_id, custom_headers:nil)
  resume_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
end

#stop(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Object

Stop the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that



334
335
336
337
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 334

def stop(resource_group_name, , job_id, custom_headers:nil)
  response = stop_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
  nil
end

#stop_async(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Stop the job identified by jobId.

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.

  • job_id —

    The job id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def stop_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}/stop'

  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' => ,'jobId' => job_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(:post, 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

#stop_with_http_info(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stop the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



350
351
352
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 350

def stop_with_http_info(resource_group_name, , job_id, custom_headers:nil)
  stop_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
end

#suspend(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Object

Suspend the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that



246
247
248
249
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 246

def suspend(resource_group_name, , job_id, custom_headers:nil)
  response = suspend_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
  nil
end

#suspend_async(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ Concurrent::Promise

Suspend the job identified by jobId.

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.

  • job_id —

    The job id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
321
322
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 277

def suspend_async(resource_group_name, , job_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, 'job_id is nil' if job_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}/jobs/{jobId}/suspend'

  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' => ,'jobId' => job_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(:post, 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

#suspend_with_http_info(resource_group_name, automation_account_name, job_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Suspend the job identified by jobId.

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.

  • job_id —

    The job id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



262
263
264
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/job_operations.rb', line 262

def suspend_with_http_info(resource_group_name, , job_id, custom_headers:nil)
  suspend_async(resource_group_name, , job_id, custom_headers:custom_headers).value!
end