class Azure::Automation::Mgmt::V2015_10_31::TestJobOperations

Automation Client

Attributes

client[R]

@return [AutomationClient] reference to the AutomationClient

Private Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the TestJobOperations class. @param client service class for accessing basic functionality.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

create(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil) click to toggle source

Create a test job of the runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The parameters supplied to the create test job operation. @param parameters [TestJobCreateParameters] The parameters supplied to the create test job operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [TestJob] operation results.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 38
def create(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil) click to toggle source

Create a test job of the runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The parameters supplied to the create test job operation. @param parameters [TestJobCreateParameters] The parameters supplied to the create test job 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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 75
def create_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if automation_account_name.nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

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

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'automationAccountName' => automation_account_name,'runbookName' => runbook_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 201
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::TestJob.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
create_with_http_info(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil) click to toggle source

Create a test job of the runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The parameters supplied to the create test job operation. @param parameters [TestJobCreateParameters] The parameters supplied to the create test job 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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 57
def create_with_http_info(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:nil)
  create_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers:custom_headers).value!
end
get(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Retrieve the test job for the specified runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [TestJob] operation results.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 151
def get(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  response = get_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Retrieve the test job for the specified runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 182
def get_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if automation_account_name.nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'automationAccountName' => automation_account_name,'runbookName' => runbook_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::TestJob.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, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Retrieve the test job for the specified runbook.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 167
def get_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  get_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
end
resume(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Resume the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 249
def resume(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  response = resume_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
  nil
end
resume_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Resume the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 280
def resume_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if automation_account_name.nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'automationAccountName' => automation_account_name,'runbookName' => runbook_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end
resume_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Resume the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 265
def resume_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  resume_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
end
stop(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Stop the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 337
def stop(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  response = stop_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
  nil
end
stop_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Stop the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 368
def stop_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if automation_account_name.nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'automationAccountName' => automation_account_name,'runbookName' => runbook_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end
stop_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Stop the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 353
def stop_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  stop_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
end
suspend(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Suspend the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 425
def suspend(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  response = suspend_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
  nil
end
suspend_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Suspend the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 456
def suspend_async(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'automation_account_name is nil' if automation_account_name.nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'automationAccountName' => automation_account_name,'runbookName' => runbook_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end
suspend_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil) click to toggle source

Suspend the test job.

@param resource_group_name [String] Name of an Azure Resource group. @param automation_account_name [String] The name of the automation account. @param runbook_name [String] The runbook name. @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/2015-10-31/generated/azure_mgmt_automation/test_job_operations.rb, line 441
def suspend_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers:nil)
  suspend_async(resource_group_name, automation_account_name, runbook_name, custom_headers:custom_headers).value!
end