Class: Azure::SQL::Mgmt::V2017_03_01_preview::JobTargetExecutions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb

Overview

The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JobTargetExecutions

Creates and initializes a new instance of the JobTargetExecutions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers: nil) ⇒ JobExecution

Gets a target execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

  • target_id —

    The target id.

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



344
345
346
347
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 344

def get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers:nil)
  response = get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets a target execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

  • target_id —

    The target id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 387

def get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'job_agent_name is nil' if job_agent_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'job_execution_id is nil' if job_execution_id.nil?
  fail ArgumentError, 'step_name is nil' if step_name.nil?
  fail ArgumentError, 'target_id is nil' if target_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.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'jobAgentName' => job_agent_name,'jobName' => job_name,'jobExecutionId' => job_execution_id,'stepName' => step_name,'targetId' => target_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 MsRestAzure::AzureOperationError.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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecution.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_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a target execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

  • target_id —

    The target id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



366
367
368
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 366

def get_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers:nil)
  get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers:custom_headers).value!
end

#list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Array<JobExecution>

Lists target executions for all steps of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (Array<JobExecution>) —

    operation results.



54
55
56
57
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 54

def list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  first_page = list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ JobExecutionListResult

Lists target executions for all steps of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (JobExecutionListResult) —

    which provide lazy access to pages of the



655
656
657
658
659
660
661
662
663
664
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 655

def list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  response = list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_job_execution_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists target executions for all steps of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 117

def list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'job_agent_name is nil' if job_agent_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'job_execution_id is nil' if job_execution_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.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/targets'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'jobAgentName' => job_agent_name,'jobName' => job_name,'jobExecutionId' => job_execution_id,'subscriptionId' => @client.subscription_id},
      query_params: {'createTimeMin' => create_time_min,'createTimeMax' => create_time_max,'endTimeMin' => end_time_min,'endTimeMax' => end_time_max,'isActive' => is_active,'$skip' => skip,'$top' => top,'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 MsRestAzure::AzureOperationError.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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_job_execution_next(next_page_link, custom_headers: nil) ⇒ JobExecutionListResult

Lists target executions for all steps of a job execution.

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:

  • (JobExecutionListResult) —

    operation results.



457
458
459
460
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 457

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

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

Lists target executions for all steps of a job execution.

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.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 486

def list_by_job_execution_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 MsRestAzure::AzureOperationError.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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_job_execution_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists target executions for all steps of a job execution.

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.



472
473
474
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 472

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

#list_by_job_execution_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists target executions for all steps of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



86
87
88
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 86

def list_by_job_execution_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
end

#list_by_step(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Array<JobExecution>

Lists the target executions of a job step execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • step_name (String) —

    The name of the step.

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (Array<JobExecution>) —

    operation results.



203
204
205
206
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 203

def list_by_step(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  first_page = list_by_step_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_step_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ JobExecutionListResult

Lists the target executions of a job step execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • step_name (String) —

    The name of the step.

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (JobExecutionListResult) —

    which provide lazy access to pages of the



695
696
697
698
699
700
701
702
703
704
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 695

def list_by_step_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  response = list_by_step_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_step_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_step_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the target executions of a job step execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • step_name (String) —

    The name of the step.

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 268

def list_by_step_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'job_agent_name is nil' if job_agent_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'job_execution_id is nil' if job_execution_id.nil?
  fail ArgumentError, 'step_name is nil' if step_name.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.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'jobAgentName' => job_agent_name,'jobName' => job_name,'jobExecutionId' => job_execution_id,'stepName' => step_name,'subscriptionId' => @client.subscription_id},
      query_params: {'createTimeMin' => create_time_min,'createTimeMax' => create_time_max,'endTimeMin' => end_time_min,'endTimeMax' => end_time_max,'isActive' => is_active,'$skip' => skip,'$top' => top,'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 MsRestAzure::AzureOperationError.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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_step_next(next_page_link, custom_headers: nil) ⇒ JobExecutionListResult

Lists the target executions of a job step execution.

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:

  • (JobExecutionListResult) —

    operation results.



547
548
549
550
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 547

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

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

Lists the target executions of a job step execution.

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.



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
623
624
625
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 576

def list_by_step_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 MsRestAzure::AzureOperationError.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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_step_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the target executions of a job step execution.

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.



562
563
564
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 562

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

#list_by_step_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the target executions of a job step execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • step_name (String) —

    The name of the step.

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



236
237
238
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_target_executions.rb', line 236

def list_by_step_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  list_by_step_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
end