Class: Azure::Batch::Mgmt::V2017_01_01::ApplicationOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb

Overview

ApplicationOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApplicationOperations

Creates and initializes a new instance of the ApplicationOperations class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientBatchManagementClient (readonly)

Returns reference to the BatchManagementClient.

Returns:



22
23
24
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 22

def client
  @client
end

Instance Method Details

#create(resource_group_name, account_name, application_id, parameters: nil, custom_headers: nil) ⇒ Application

Adds an application to the specified Batch account.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (AddApplicationParameters) (defaults to: nil)

    The parameters for the request.

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

    A hash of custom headers that

Returns:

  • (Application)

    operation results.



37
38
39
40
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 37

def create(resource_group_name, , application_id, parameters:nil, custom_headers:nil)
  response = create_async(resource_group_name, , application_id, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, account_name, application_id, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Adds an application to the specified Batch account.

contains the Batch account. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (AddApplicationParameters) (defaults to: nil)

    The parameters for the request.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



72
73
74
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
130
131
132
133
134
135
136
137
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 72

def create_async(resource_group_name, , application_id, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  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, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '24'" if !.nil? && .length > 24
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !.nil? && .match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'application_id is nil' if application_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::Batch::Mgmt::V2017_01_01::Models::AddApplicationParameters.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.Batch/batchAccounts/{accountName}/applications/{applicationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'accountName' => ,'applicationId' => application_id,'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 == 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 == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Batch::Mgmt::V2017_01_01::Models::Application.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, account_name, application_id, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Adds an application to the specified Batch account.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (AddApplicationParameters) (defaults to: nil)

    The parameters for the request.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



55
56
57
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 55

def create_with_http_info(resource_group_name, , application_id, parameters:nil, custom_headers:nil)
  create_async(resource_group_name, , application_id, parameters:parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, account_name, application_id, custom_headers: nil) ⇒ Object

Deletes an application.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

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

    A hash of custom headers that



150
151
152
153
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 150

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

#delete_async(resource_group_name, account_name, application_id, custom_headers: nil) ⇒ Concurrent::Promise

Deletes an application.

contains the Batch account. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 183

def delete_async(resource_group_name, , application_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  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, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '24'" if !.nil? && .length > 24
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !.nil? && .match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'application_id is nil' if application_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Batch/batchAccounts/{accountName}/applications/{applicationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'accountName' => ,'applicationId' => application_id,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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 == 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, account_name, application_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an application.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



167
168
169
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 167

def delete_with_http_info(resource_group_name, , application_id, custom_headers:nil)
  delete_async(resource_group_name, , application_id, custom_headers:custom_headers).value!
end

#get(resource_group_name, account_name, application_id, custom_headers: nil) ⇒ Application

Gets information about the specified application.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

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

    A hash of custom headers that

Returns:

  • (Application)

    operation results.



245
246
247
248
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 245

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

#get_async(resource_group_name, account_name, application_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets information about the specified application.

contains the Batch account. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
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
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 278

def get_async(resource_group_name, , application_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  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, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '24'" if !.nil? && .length > 24
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !.nil? && .match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'application_id is nil' if application_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Batch/batchAccounts/{accountName}/applications/{applicationId}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Batch::Mgmt::V2017_01_01::Models::Application.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, account_name, application_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified application.

contains the Batch account. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



262
263
264
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 262

def get_with_http_info(resource_group_name, , application_id, custom_headers:nil)
  get_async(resource_group_name, , application_id, custom_headers:custom_headers).value!
end

#list(resource_group_name, account_name, maxresults: nil, custom_headers: nil) ⇒ Array<Application>

Lists all of the applications in the specified account.

contains the Batch account. response. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • maxresults (Integer) (defaults to: nil)

    The maximum number of items to return in the

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

    A hash of custom headers that

Returns:

  • (Array<Application>)

    operation results.



459
460
461
462
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 459

def list(resource_group_name, , maxresults:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, , maxresults:maxresults, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, account_name, maxresults: nil, custom_headers: nil) ⇒ ListApplicationsResult

Lists all of the applications in the specified account.

contains the Batch account. response. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • maxresults (Integer) (defaults to: nil)

    The maximum number of items to return in the

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

    A hash of custom headers that

Returns:

  • (ListApplicationsResult)

    which provide lazy access to pages of the



657
658
659
660
661
662
663
664
665
666
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 657

def list_as_lazy(resource_group_name, , maxresults:nil, custom_headers:nil)
  response = list_async(resource_group_name, , maxresults:maxresults, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, account_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the applications in the specified account.

contains the Batch account. response. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • maxresults (Integer) (defaults to: nil)

    The maximum number of items to return in the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



494
495
496
497
498
499
500
501
502
503
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
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 494

def list_async(resource_group_name, , maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  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, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '24'" if !.nil? && .length > 24
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !.nil? && .match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Batch/batchAccounts/{accountName}/applications'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'accountName' => ,'subscriptionId' => @client.subscription_id},
      query_params: {'maxresults' => maxresults,'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::Batch::Mgmt::V2017_01_01::Models::ListApplicationsResult.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_next(next_page_link, custom_headers: nil) ⇒ ListApplicationsResult

Lists all of the applications in the specified account.

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:

  • (ListApplicationsResult)

    operation results.



563
564
565
566
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 563

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

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

Lists all of the applications in the specified account.

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.



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 592

def list_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::Batch::Mgmt::V2017_01_01::Models::ListApplicationsResult.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the applications in the specified account.

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.



578
579
580
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 578

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, account_name, maxresults: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the applications in the specified account.

contains the Batch account. response. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • maxresults (Integer) (defaults to: nil)

    The maximum number of items to return in the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



477
478
479
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 477

def list_with_http_info(resource_group_name, , maxresults:nil, custom_headers:nil)
  list_async(resource_group_name, , maxresults:maxresults, custom_headers:custom_headers).value!
end

#update(resource_group_name, account_name, application_id, parameters, custom_headers: nil) ⇒ Object

Updates settings for the specified application.

contains the Batch account. request. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (UpdateApplicationParameters)

    The parameters for the

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

    A hash of custom headers that



351
352
353
354
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 351

def update(resource_group_name, , application_id, parameters, custom_headers:nil)
  response = update_async(resource_group_name, , application_id, parameters, custom_headers:custom_headers).value!
  nil
end

#update_async(resource_group_name, account_name, application_id, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Updates settings for the specified application.

contains the Batch account. request. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (UpdateApplicationParameters)

    The parameters for the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 388

def update_async(resource_group_name, , application_id, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  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, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '24'" if !.nil? && .length > 24
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[-\w\._]+$'" if !.nil? && .match(Regexp.new('^^[-\w\._]+$$')).nil?
  fail ArgumentError, 'application_id is nil' if application_id.nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::Batch::Mgmt::V2017_01_01::Models::UpdateApplicationParameters.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.Batch/batchAccounts/{accountName}/applications/{applicationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'accountName' => ,'applicationId' => application_id,'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(:patch, 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 == 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

#update_with_http_info(resource_group_name, account_name, application_id, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates settings for the specified application.

contains the Batch account. request. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group that

  • account_name (String)

    The name of the Batch account.

  • application_id (String)

    The ID of the application.

  • parameters (UpdateApplicationParameters)

    The parameters for the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



370
371
372
# File 'lib/2017-01-01/generated/azure_mgmt_batch/application_operations.rb', line 370

def update_with_http_info(resource_group_name, , application_id, parameters, custom_headers:nil)
  update_async(resource_group_name, , application_id, parameters, custom_headers:custom_headers).value!
end