Class: Azure::SQL::Mgmt::V2017_03_01_preview::JobExecutions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01-preview/generated/azure_mgmt_sql/job_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) ⇒ JobExecutions

Creates and initializes a new instance of the JobExecutions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_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_executions.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ JobExecution

Starts an elastic job 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.

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



642
643
644
645
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 642

def begin_create(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  response = begin_create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

Starts an elastic job 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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 679

def begin_create_async(resource_group_name, server_name, job_agent_name, job_name, 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, '@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}/start'

  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,'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 || status_code == 202
      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

#begin_create_or_update(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ JobExecution

Creates or updates a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. under. 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 job execution id to create the job execution

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



752
753
754
755
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 752

def begin_create_or_update(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. under. 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 job execution id to create the job execution

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 793

def begin_create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_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, '@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}'

  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: {'api-version' => @client.api_version},
      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 == 200 || status_code == 202 || status_code == 201
      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
    # Deserialize Response
    if status_code == 201
      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

#begin_create_or_update_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. under. 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 job execution id to create the job execution

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



773
774
775
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 773

def begin_create_or_update_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers).value!
end

#begin_create_with_http_info(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Starts an elastic job 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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



661
662
663
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 661

def begin_create_with_http_info(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  begin_create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:custom_headers).value!
end

#cancel(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ Object

Requests cancellation of a job 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.

  • job_execution_id —

    The id of the job execution to cancel.

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

    A hash of custom headers that



181
182
183
184
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 181

def cancel(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  response = cancel_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers).value!
  nil
end

#cancel_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ Concurrent::Promise

Requests cancellation of a job 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.

  • job_execution_id —

    The id of the job execution to cancel.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 220

def cancel_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_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, '@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}/cancel'

  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: {'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 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?

    result
  end

  promise.execute
end

#cancel_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Requests cancellation of a job 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.

  • job_execution_id —

    The id of the job execution to cancel.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



201
202
203
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 201

def cancel_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  cancel_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers).value!
end

#create(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ JobExecution

Starts an elastic job 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.

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



282
283
284
285
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 282

def create(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  response = create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. 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.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 300

def create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2017_03_01_preview::Models::JobExecution.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#create_or_update(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ JobExecution

Creates or updates a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. under. 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 job execution id to create the job execution

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



590
591
592
593
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 590

def create_or_update(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  response = create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers: nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. under. 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 job execution id to create the job execution

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 610

def create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::SQL::Mgmt::V2017_03_01_preview::Models::JobExecution.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

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

Gets a job 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.

  • job_execution_id —

    The id of the job execution

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



477
478
479
480
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 477

def get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers:nil)
  response = get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_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, custom_headers: nil) ⇒ Concurrent::Promise

Gets a job 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.

  • job_execution_id —

    The id of the job execution

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 516

def get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_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, '@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}'

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

Gets a job 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.

  • job_execution_id —

    The id of the job execution

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



497
498
499
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 497

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

#list_by_agent(resource_group_name, server_name, job_agent_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 all executions in a job agent.

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.

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



52
53
54
55
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 52

def list_by_agent(resource_group_name, server_name, job_agent_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_agent_as_lazy(resource_group_name, server_name, job_agent_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_agent_as_lazy(resource_group_name, server_name, job_agent_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 all executions in a job agent.

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.

  • 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



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 1067

def list_by_agent_as_lazy(resource_group_name, server_name, job_agent_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_agent_async(resource_group_name, server_name, job_agent_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_agent_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_agent_async(resource_group_name, server_name, job_agent_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 all executions in a job agent.

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.

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 111

def list_by_agent_async(resource_group_name, server_name, job_agent_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, '@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}/executions'

  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,'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_agent_next(next_page_link, custom_headers: nil) ⇒ JobExecutionListResult

Lists all executions in a job agent.

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.



871
872
873
874
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 871

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

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

Lists all executions in a job agent.

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.



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 900

def list_by_agent_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_agent_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all executions in a job agent.

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.



886
887
888
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 886

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

#list_by_agent_with_http_info(resource_group_name, server_name, job_agent_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 all executions in a job agent.

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.

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



82
83
84
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 82

def list_by_agent_with_http_info(resource_group_name, server_name, job_agent_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_agent_async(resource_group_name, server_name, job_agent_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

#list_by_job(resource_group_name, server_name, job_agent_name, job_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 a job’s executions.

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.

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



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

def list_by_job(resource_group_name, server_name, job_agent_name, job_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_job_as_lazy(resource_group_name, server_name, job_agent_name, job_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_job_as_lazy(resource_group_name, server_name, job_agent_name, job_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 a job’s executions.

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.

  • 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



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 1105

def list_by_job_as_lazy(resource_group_name, server_name, job_agent_name, job_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_job_async(resource_group_name, server_name, job_agent_name, job_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_job_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_job_async(resource_group_name, server_name, job_agent_name, job_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 a job’s executions.

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.

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



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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 405

def list_by_job_async(resource_group_name, server_name, job_agent_name, job_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, '@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'

  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,'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_next(next_page_link, custom_headers: nil) ⇒ JobExecutionListResult

Lists a job’s executions.

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.



961
962
963
964
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 961

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

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

Lists a job’s executions.

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.



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 990

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

Lists a job’s executions.

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.



976
977
978
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 976

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

#list_by_job_with_http_info(resource_group_name, server_name, job_agent_name, job_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 a job’s executions.

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.

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



375
376
377
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb', line 375

def list_by_job_with_http_info(resource_group_name, server_name, job_agent_name, job_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_job_async(resource_group_name, server_name, job_agent_name, job_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