Class: Azure::SQL::Mgmt::V2017_03_01_preview::JobSteps

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

Creates and initializes a new instance of the JobSteps class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers: nil) ⇒ JobStep

Creates or updates a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step.

  • parameters (JobStep) —

    The requested state of the job step.

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

    A hash of custom headers that

Returns:

  • (JobStep) —

    operation results.



491
492
493
494
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 491

def create_or_update(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, 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, step_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step.

  • parameters (JobStep) —

    The requested state of the job step.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 532

def create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, 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, 'step_name is nil' if step_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

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

  # Serialize Request
  request_mapper = Azure::SQL::Mgmt::V2017_03_01_preview::Models::JobStep.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.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}'

  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,'stepName' => step_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || 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::JobStep.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::JobStep.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_or_update_with_http_info(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step.

  • parameters (JobStep) —

    The requested state of the job step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



512
513
514
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 512

def create_or_update_with_http_info(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers: nil) ⇒ Object

Deletes a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step to delete.

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

    A hash of custom headers that



622
623
624
625
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 622

def delete(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers:nil)
  response = delete_async(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers:custom_headers).value!
  nil
end

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

Deletes a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step to delete.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 661

def delete_async(resource_group_name, server_name, job_agent_name, job_name, step_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, 'step_name is nil' if step_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}'

  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,'stepName' => step_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(:delete, 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 == 204
      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

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

Deletes a job step. This will implicitly create a new job version.

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.

  • step_name (String) —

    The name of the job step to delete.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

def delete_with_http_info(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers:nil)
  delete_async(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers: nil) ⇒ JobStep

Gets a job step in a job’s current version.

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.

  • step_name (String) —

    The name of the job step.

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

    A hash of custom headers that

Returns:

  • (JobStep) —

    operation results.



378
379
380
381
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 378

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

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

Gets a job step in a job’s current version.

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.

  • step_name (String) —

    The name of the job step.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 417

def get_async(resource_group_name, server_name, job_agent_name, job_name, step_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, 'step_name is nil' if step_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}'

  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,'stepName' => step_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(: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::JobStep.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_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers: nil) ⇒ JobStep

Gets the specified version of a job step.

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_version (Integer) —

    The version of the job to get.

  • step_name (String) —

    The name of the job step.

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

    A hash of custom headers that

Returns:

  • (JobStep) —

    operation results.



155
156
157
158
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 155

def get_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers:nil)
  response = get_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the specified version of a job step.

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_version (Integer) —

    The version of the job to get.

  • step_name (String) —

    The name of the job step.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 196

def get_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, step_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, 'job_version is nil' if job_version.nil?
  fail ArgumentError, 'step_name is nil' if step_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


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

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps/{stepName}'

  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,'jobVersion' => job_version,'stepName' => step_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(: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::JobStep.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_by_version_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the specified version of a job step.

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_version (Integer) —

    The version of the job to get.

  • step_name (String) —

    The name of the job step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



176
177
178
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 176

def get_by_version_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers:nil)
  get_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers:custom_headers).value!
end

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

Gets a job step in a job’s current version.

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.

  • step_name (String) —

    The name of the job step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



398
399
400
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 398

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

#list_by_job(resource_group_name, server_name, job_agent_name, job_name, custom_headers: nil) ⇒ Array<JobStep>

Gets all job steps for a job’s current version.

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:

  • (Array<JobStep>) —

    operation results.



269
270
271
272
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 269

def list_by_job(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  first_page = list_by_job_as_lazy(resource_group_name, server_name, job_agent_name, job_name, 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, custom_headers: nil) ⇒ JobStepListResult

Gets all job steps for a job’s current version.

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:

  • (JobStepListResult) —

    which provide lazy access to pages of the



931
932
933
934
935
936
937
938
939
940
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 931

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

Gets all job steps for a job’s current version.

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.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 306

def list_by_job_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}/steps'

  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(: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::JobStepListResult.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) ⇒ JobStepListResult

Gets all job steps for a job’s current version.

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:

  • (JobStepListResult) —

    operation results.



809
810
811
812
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 809

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

Gets all job steps for a job’s current version.

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.



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 838

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::JobStepListResult.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

Gets all job steps for a job’s current version.

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.



824
825
826
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 824

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

Gets all job steps for a job’s current version.

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.



288
289
290
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 288

def list_by_job_with_http_info(resource_group_name, server_name, job_agent_name, job_name, custom_headers:nil)
  list_by_job_async(resource_group_name, server_name, job_agent_name, job_name, custom_headers:custom_headers).value!
end

#list_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers: nil) ⇒ Array<JobStep>

Gets all job steps in the specified job version.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_version (Integer) —

    The version of the job to get.

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

    A hash of custom headers that

Returns:

  • (Array<JobStep>) —

    operation results.



42
43
44
45
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 42

def list_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:nil)
  first_page = list_by_version_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_version_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers: nil) ⇒ JobStepListResult

Gets all job steps in the specified job version.

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.

  • job_version (Integer) —

    The version of the job to get.

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

    A hash of custom headers that

Returns:

  • (JobStepListResult) —

    which provide lazy access to pages of the



905
906
907
908
909
910
911
912
913
914
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 905

def list_by_version_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:nil)
  response = list_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_version_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets all job steps in the specified job version.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_version (Integer) —

    The version 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.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 81

def list_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, 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_version is nil' if job_version.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}/versions/{jobVersion}/steps'

  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,'jobVersion' => job_version,'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::JobStepListResult.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_version_next(next_page_link, custom_headers: nil) ⇒ JobStepListResult

Gets all job steps in the specified job version.

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:

  • (JobStepListResult) —

    operation results.



719
720
721
722
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 719

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

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

Gets all job steps in the specified job version.

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.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 748

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

Gets all job steps in the specified job version.

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.



734
735
736
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 734

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

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

Gets all job steps in the specified job version.

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

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_version (Integer) —

    The version 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.



62
63
64
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_steps.rb', line 62

def list_by_version_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:nil)
  list_by_version_async(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers:custom_headers).value!
end