Class: Azure::Batch::Mgmt::V2017_05_01::ApplicationPackageOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-05-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/2017-05-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/2017-05-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_id, version, parameters, custom_headers: nil) ⇒ Object

Activates the specified application package.

contains the Batch 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_id (String) —

    The ID of the application.

  • version (String) —

    The version of the application to activate.

  • parameters (ActivateApplicationPackageParameters) —

    The parameters for

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

    A hash of custom headers that



38
39
40
41
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 38

def activate(resource_group_name, , application_id, version, parameters, custom_headers:nil)
  response = activate_async(resource_group_name, , application_id, version, parameters, custom_headers:custom_headers).value!
  nil
end

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

Activates the specified application package.

contains the Batch 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_id (String) —

    The ID of the application.

  • version (String) —

    The version of the application to activate.

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



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

def activate_async(resource_group_name, , application_id, version, 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, 'version is nil' if version.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_05_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/{applicationId}/versions/{version}/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' => ,'applicationId' => application_id,'version' => version,'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 == 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

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

Activates the specified application package.

contains the Batch 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_id (String) —

    The ID of the application.

  • version (String) —

    The version of the application to activate.

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



58
59
60
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 58

def activate_with_http_info(resource_group_name, , application_id, version, parameters, custom_headers:nil)
  activate_async(resource_group_name, , application_id, version, parameters, custom_headers:custom_headers).value!
end

#create(resource_group_name, account_name, application_id, version, custom_headers: nil) ⇒ ApplicationPackage

Creates an application package record.

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.

  • version (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (ApplicationPackage) —

    operation results.



149
150
151
152
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 149

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

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

Creates an application package record.

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.

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



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
238
239
240
241
242
243
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 184

def create_async(resource_group_name, , application_id, version, 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, 'version is nil' if version.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}/versions/{version}'

  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,'version' => version,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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_05_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_id, version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates an application package record.

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.

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



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

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

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

Deletes an application package record and its associated binary file.

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.

  • version (String) —

    The version of the application to delete.

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

    A hash of custom headers that



257
258
259
260
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 257

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

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

Deletes an application package record and its associated binary file.

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.

  • version (String) —

    The version of the application to delete.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
337
338
339
340
341
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 292

def delete_async(resource_group_name, , application_id, version, 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, 'version is nil' if version.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}/versions/{version}'

  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,'version' => version,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(: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, version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an application package record and its associated binary file.

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.

  • version (String) —

    The version of the application to delete.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



275
276
277
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 275

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

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

Gets information about the specified application package.

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.

  • version (String) —

    The version of the application.

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

    A hash of custom headers that

Returns:

  • (ApplicationPackage) —

    operation results.



356
357
358
359
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 356

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

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

Gets information about the specified application package.

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.

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



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
445
446
447
448
449
450
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 391

def get_async(resource_group_name, , application_id, version, 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, 'version is nil' if version.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}/versions/{version}'

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

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

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

Gets information about the specified application package.

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.

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



374
375
376
 
# File 'lib/2017-05-01/generated/azure_mgmt_batch/application_package_operations.rb', line 374

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