class Azure::SQL::Mgmt::V2017_03_01_preview::JobExecutions
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.
Attributes
@return [SqlManagementClient] reference to the SqlManagementClient
Private Class Methods
Creates and initializes a new instance of the JobExecutions
class. @param client service class for accessing basic functionality.
# File lib/2017-03-01-preview/generated/azure_mgmt_sql/job_executions.rb, line 20 def initialize(client) @client = client end
Private Instance Methods
Starts an elastic job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecution] operation results.
# 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
Starts an elastic job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Creates or updates a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param job_execution_id The job execution id to create the job execution under. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecution] operation results.
# 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
Creates or updates a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param job_execution_id The job execution id to create the job execution under. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Creates or updates a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param job_execution_id The job execution id to create the job execution under. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Starts an elastic job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Requests cancellation of a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution to cancel. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# 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
Requests cancellation of a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution to cancel. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Requests cancellation of a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution to cancel. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Starts an elastic job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecution] operation results.
# 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
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# 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
Creates or updates a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param job_execution_id The job execution id to create the job execution under. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecution] operation results.
# 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
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param job_execution_id The job execution id to create the job execution under. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] promise which provides async access to http response.
# 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
Gets a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecution] operation results.
# 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
Gets a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Gets a job execution.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job. @param job_execution_id The id of the job execution @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Lists all executions in a job agent.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<JobExecution>] operation results.
# 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
Lists all executions in a job agent.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecutionListResult] which provide lazy access to pages of the response.
# 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
Lists all executions in a job agent.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Lists all executions in a job agent.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecutionListResult] operation results.
# 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
Lists all executions in a job agent.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Lists all executions in a job agent.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Lists all executions in a job agent.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Lists a job's executions.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<JobExecution>] operation results.
# 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
Lists a job's executions.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecutionListResult] which provide lazy access to pages of the response.
# 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
Lists a job's executions.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Lists a job's executions.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [JobExecutionListResult] operation results.
# 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
Lists a job's executions.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# 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
Lists a job's executions.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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
Lists a job's executions.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param job_agent_name [String] The name of the job agent. @param job_name [String] The name of the job to get. @param create_time_min [DateTime] If specified, only job executions created at or after the specified time are included. @param create_time_max [DateTime] If specified, only job executions created before the specified time are included. @param end_time_min [DateTime] If specified, only job executions completed at or after the specified time are included. @param end_time_max [DateTime] If specified, only job executions completed before the specified time are included. @param is_active [Boolean] If specified, only active or only completed job executions are included. @param skip [Integer] The number of elements in the collection to skip. @param top [Integer] The number of elements to return from the collection. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# 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