Class: Azure::SQL::Mgmt::V2017_03_01_preview::Jobs

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

Creates and initializes a new instance of the Jobs class.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly) 



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

def client
  @client
end

Instance Method Details

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

Creates or updates a job.

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



254
255
256
257
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 254

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

Creates or updates a job.

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
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
362
363
364
365
366
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 293

def create_or_update_async(resource_group_name, server_name, job_agent_name, job_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, '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::Job.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}'

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

Creates or updates a job.

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



274
275
276
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 274

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

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

Deletes a job.

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



381
382
383
384
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 381

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

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

Deletes a job.

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



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
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 418

def delete_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}'

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

Deletes a job.

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



400
401
402
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 400

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

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

Gets a job.

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



145
146
147
148
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 145

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

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

Gets a job.

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 182

def get_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}'

  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::Job.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Gets a job.

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



164
165
166
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 164

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

#list_by_agent(resource_group_name, server_name, job_agent_name, custom_headers: nil) ⇒ Array<Job>

Gets a list of jobs.

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



40
41
42
43
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 40

def list_by_agent(resource_group_name, server_name, job_agent_name, custom_headers:nil)
  first_page = list_by_agent_as_lazy(resource_group_name, server_name, job_agent_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_agent_as_lazy(resource_group_name, server_name, job_agent_name, custom_headers: nil) ⇒ JobListResult

Gets a list of jobs.

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



568
569
570
571
572
573
574
575
576
577
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 568

def list_by_agent_as_lazy(resource_group_name, server_name, job_agent_name, custom_headers:nil)
  response = list_by_agent_async(resource_group_name, server_name, job_agent_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_agent_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets a list of jobs.

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



75
76
77
78
79
80
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
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 75

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

  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: {'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::JobListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_agent_next(next_page_link, custom_headers: nil) ⇒ JobListResult

Gets a list of jobs.

to List operation. will be added to the HTTP request.



475
476
477
478
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 475

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

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

Gets a list of jobs.

to List operation. to the HTTP request.



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 504

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::JobListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_agent_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of jobs.

to List operation. will be added to the HTTP request.



490
491
492
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 490

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

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

Gets a list of jobs.

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



58
59
60
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/jobs.rb', line 58

def list_by_agent_with_http_info(resource_group_name, server_name, job_agent_name, custom_headers:nil)
  list_by_agent_async(resource_group_name, server_name, job_agent_name, custom_headers:custom_headers).value!
end