Class: Azure::Batch::Mgmt::V2019_08_01::ApplicationPackageOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb

Overview

ApplicationPackageOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApplicationPackageOperations

Creates and initializes a new instance of the ApplicationPackageOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ BatchManagementClient (readonly)

Returns reference to the BatchManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 22

def client
  @client
end

Instance Method Details

#activate(resource_group_name, account_name, application_name, version_name, parameters, custom_headers: nil) ⇒ ApplicationPackage

Activates the specified application package. This should be done after the ‘ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks

contains the Batch account. unique within the account. the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

  • parameters (ActivateApplicationPackageParameters) —

    The parameters for

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

    A hash of custom headers that

Returns:

  • (ApplicationPackage) —

    operation results.



42
43
44
45
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 42

def activate(resource_group_name, , application_name, version_name, parameters, custom_headers:nil)
  response = activate_async(resource_group_name, , application_name, version_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#activate_async(resource_group_name, account_name, application_name, version_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Activates the specified application package. This should be done after the ‘ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks

contains the Batch account. unique within the account. the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

  • parameters (ActivateApplicationPackageParameters) —

    The parameters for

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 87

def activate_async(resource_group_name, , application_name, version_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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_name is nil' if application_name.nil?
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MaxLength': '64'" if !application_name.nil? && application_name.length > 64
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MinLength': '1'" if !application_name.nil? && application_name.length < 1
  fail ArgumentError, "'application_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !application_name.nil? && application_name.match(Regexp.new('^^[a-zA-Z0-9_-]+$$')).nil?
  fail ArgumentError, 'version_name is nil' if version_name.nil?
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MaxLength': '64'" if !version_name.nil? && version_name.length > 64
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MinLength': '1'" if !version_name.nil? && version_name.length < 1
  fail ArgumentError, "'version_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$'" if !version_name.nil? && version_name.match(Regexp.new('^^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$$')).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::V2019_08_01::Models::ActivateApplicationPackageParameters.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/{applicationName}/versions/{versionName}/activate'

  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' => ,'applicationName' => application_name,'versionName' => version_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(:post, path_template, options)

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

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

#activate_with_http_info(resource_group_name, account_name, application_name, version_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Activates the specified application package. This should be done after the ‘ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks

contains the Batch account. unique within the account. the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

  • parameters (ActivateApplicationPackageParameters) —

    The parameters for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 65

def activate_with_http_info(resource_group_name, , application_name, version_name, parameters, custom_headers:nil)
  activate_async(resource_group_name, , application_name, version_name, parameters, custom_headers:custom_headers).value!
end

#create(resource_group_name, account_name, application_name, version_name, custom_headers: nil) ⇒ ApplicationPackage

Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the ‘ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (ApplicationPackage) —

    operation results.



177
178
179
180
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 177

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

#create_async(resource_group_name, account_name, application_name, version_name, custom_headers: nil) ⇒ Concurrent::Promise

Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the ‘ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

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



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 218

def create_async(resource_group_name, , application_name, version_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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_name is nil' if application_name.nil?
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MaxLength': '64'" if !application_name.nil? && application_name.length > 64
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MinLength': '1'" if !application_name.nil? && application_name.length < 1
  fail ArgumentError, "'application_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !application_name.nil? && application_name.match(Regexp.new('^^[a-zA-Z0-9_-]+$$')).nil?
  fail ArgumentError, 'version_name is nil' if version_name.nil?
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MaxLength': '64'" if !version_name.nil? && version_name.length > 64
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MinLength': '1'" if !version_name.nil? && version_name.length < 1
  fail ArgumentError, "'version_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$'" if !version_name.nil? && version_name.match(Regexp.new('^^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$$')).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?

  parameters = 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::V2019_08_01::Models::ApplicationPackage.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/{applicationName}/versions/{versionName}'

  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' => ,'applicationName' => application_name,'versionName' => version_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
      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::V2019_08_01::Models::ApplicationPackage.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_name, version_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the ‘ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



198
199
200
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 198

def create_with_http_info(resource_group_name, , application_name, version_name, custom_headers:nil)
  create_async(resource_group_name, , application_name, version_name, custom_headers:custom_headers).value!
end

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

Deletes an application package record and its associated binary file.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that



305
306
307
308
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 305

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

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

Deletes an application package record and its associated binary file.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

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



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 342

def delete_async(resource_group_name, , application_name, version_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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_name is nil' if application_name.nil?
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MaxLength': '64'" if !application_name.nil? && application_name.length > 64
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MinLength': '1'" if !application_name.nil? && application_name.length < 1
  fail ArgumentError, "'application_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !application_name.nil? && application_name.match(Regexp.new('^^[a-zA-Z0-9_-]+$$')).nil?
  fail ArgumentError, 'version_name is nil' if version_name.nil?
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MaxLength': '64'" if !version_name.nil? && version_name.length > 64
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MinLength': '1'" if !version_name.nil? && version_name.length < 1
  fail ArgumentError, "'version_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$'" if !version_name.nil? && version_name.match(Regexp.new('^^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$$')).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/{applicationName}/versions/{versionName}'

  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' => ,'applicationName' => application_name,'versionName' => version_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, account_name, application_name, version_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an application package record and its associated binary file.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



324
325
326
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 324

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

#get(resource_group_name, account_name, application_name, version_name, custom_headers: nil) ⇒ ApplicationPackage

Gets information about the specified application package.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (ApplicationPackage) —

    operation results.



412
413
414
415
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 412

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

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

Gets information about the specified application package.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

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



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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 449

def get_async(resource_group_name, , application_name, version_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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_name is nil' if application_name.nil?
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MaxLength': '64'" if !application_name.nil? && application_name.length > 64
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MinLength': '1'" if !application_name.nil? && application_name.length < 1
  fail ArgumentError, "'application_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !application_name.nil? && application_name.match(Regexp.new('^^[a-zA-Z0-9_-]+$$')).nil?
  fail ArgumentError, 'version_name is nil' if version_name.nil?
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MaxLength': '64'" if !version_name.nil? && version_name.length > 64
  fail ArgumentError, "'version_name' should satisfy the constraint - 'MinLength': '1'" if !version_name.nil? && version_name.length < 1
  fail ArgumentError, "'version_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$'" if !version_name.nil? && version_name.match(Regexp.new('^^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$$')).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/{applicationName}/versions/{versionName}'

  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' => ,'applicationName' => application_name,'versionName' => version_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::Batch::Mgmt::V2019_08_01::Models::ApplicationPackage.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_name, version_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified application package.

contains the Batch account. unique within the 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_name (String) —

    The name of the application. This must be

  • version_name (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



431
432
433
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 431

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

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

Lists all of the application packages in the specified application.

contains the Batch account. unique within the 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.

  • application_name (String) —

    The name of the application. This must be

  • 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<ApplicationPackage>) —

    operation results.



530
531
532
533
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 530

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

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

Lists all of the application packages in the specified application.

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

the response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • account_name (String) —

    The name of the Batch account.

  • application_name (String) —

    The name of the application. This must be

  • 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:

  • (ListApplicationPackagesResult) —

    which provide lazy access to pages of



737
738
739
740
741
742
743
744
745
746
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 737

def list_as_lazy(resource_group_name, , application_name, maxresults:nil, custom_headers:nil)
  response = list_async(resource_group_name, , application_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, application_name, maxresults: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the application packages in the specified application.

contains the Batch account. unique within the 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.

  • application_name (String) —

    The name of the application. This must be

  • 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.



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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 569

def list_async(resource_group_name, , application_name, maxresults:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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_name is nil' if application_name.nil?
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MaxLength': '64'" if !application_name.nil? && application_name.length > 64
  fail ArgumentError, "'application_name' should satisfy the constraint - 'MinLength': '1'" if !application_name.nil? && application_name.length < 1
  fail ArgumentError, "'application_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !application_name.nil? && application_name.match(Regexp.new('^^[a-zA-Z0-9_-]+$$')).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/{applicationName}/versions'

  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' => ,'applicationName' => application_name,'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::V2019_08_01::Models::ListApplicationPackagesResult.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) ⇒ ListApplicationPackagesResult

Lists all of the application packages in the specified application.

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:

  • (ListApplicationPackagesResult) —

    operation results.



641
642
643
644
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 641

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 application packages in the specified application.

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.



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
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 670

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::V2019_08_01::Models::ListApplicationPackagesResult.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 application packages in the specified application.

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.



656
657
658
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 656

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

Lists all of the application packages in the specified application.

contains the Batch account. unique within the 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.

  • application_name (String) —

    The name of the application. This must be

  • 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.



550
551
552
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/application_package_operations.rb', line 550

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