Class: Azure::Batch::Mgmt::V2017_09_01::PoolOperations

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

Overview

PoolOperations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PoolOperations

Creates and initializes a new instance of the PoolOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_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-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create(resource_group_name, account_name, pool_name, parameters, if_match: nil, if_none_match: nil, custom_headers: nil) ⇒ Pool

Creates a new pool inside the specified account.

contains the Batch account. account. update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. but to prevent updating an existing pool. Other values will be ignored. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Additional parameters for pool creation.

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new pool to be created,

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



788
789
790
791
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 788

def begin_create(resource_group_name, , pool_name, parameters, if_match:nil, if_none_match:nil, custom_headers:nil)
  response = begin_create_async(resource_group_name, , pool_name, parameters, if_match:if_match, if_none_match:if_none_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_async(resource_group_name, account_name, pool_name, parameters, if_match: nil, if_none_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a new pool inside the specified account.

contains the Batch account. account. update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. but to prevent updating an existing pool. Other values will be ignored. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Additional parameters for pool creation.

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new pool to be created,

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 835

def begin_create_async(resource_group_name, , pool_name, parameters, if_match:nil, if_none_match: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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[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['If-Match'] = if_match unless if_match.nil?
  request_headers['If-None-Match'] = if_none_match unless if_none_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Batch::Mgmt::V2017_09_01::Models::Pool.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}/pools/{poolName}'

  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' => ,'poolName' => pool_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?
    # 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_09_01::Models::Pool.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

#begin_create_with_http_info(resource_group_name, account_name, pool_name, parameters, if_match: nil, if_none_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a new pool inside the specified account.

contains the Batch account. account. update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. but to prevent updating an existing pool. Other values will be ignored. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Additional parameters for pool creation.

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new pool to be created,

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



812
813
814
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 812

def begin_create_with_http_info(resource_group_name, , pool_name, parameters, if_match:nil, if_none_match:nil, custom_headers:nil)
  begin_create_async(resource_group_name, , pool_name, parameters, if_match:if_match, if_none_match:if_none_match, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Object

Deletes the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that



917
918
919
920
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 917

def begin_delete(resource_group_name, , pool_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 952

def begin_delete_async(resource_group_name, , pool_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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_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}/pools/{poolName}'

  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' => ,'poolName' => pool_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 || status_code == 202
      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
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



935
936
937
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 935

def begin_delete_with_http_info(resource_group_name, , pool_name, custom_headers:nil)
  begin_delete_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
end

#create(resource_group_name, account_name, pool_name, parameters, if_match: nil, if_none_match: nil, custom_headers: nil) ⇒ Pool

Creates a new pool inside the specified account.

contains the Batch account. account. update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. but to prevent updating an existing pool. Other values will be ignored. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Additional parameters for pool creation.

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new pool to be created,

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



198
199
200
201
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 198

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

#create_async(resource_group_name, account_name, pool_name, parameters, if_match: nil, if_none_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

contains the Batch account. account. update. A value of “*” can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. but to prevent updating an existing pool. Other values will be ignored. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Additional parameters for pool creation.

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

  • if_none_match (String) (defaults to: nil) —

    Set to ‘*’ to allow a new pool to be created,

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 221

def create_async(resource_group_name, , pool_name, parameters, if_match:nil, if_none_match:nil, custom_headers:nil)
  # Send request
  promise = begin_create_async(resource_group_name, , pool_name, parameters, if_match:if_match, if_none_match:if_none_match, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Batch::Mgmt::V2017_09_01::Models::Pool.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

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

Deletes the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that



385
386
387
388
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 385

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

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

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 402

def delete_async(resource_group_name, , pool_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, , pool_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#disable_auto_scale(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Pool

Disables automatic scaling for a pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



539
540
541
542
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 539

def disable_auto_scale(resource_group_name, , pool_name, custom_headers:nil)
  response = disable_auto_scale_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#disable_auto_scale_async(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Disables automatic scaling for a pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
630
631
632
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 574

def disable_auto_scale_async(resource_group_name, , pool_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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_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}/pools/{poolName}/disableAutoScale'

  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' => ,'poolName' => pool_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(: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?
    # 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_09_01::Models::Pool.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

#disable_auto_scale_with_http_info(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Disables automatic scaling for a pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



557
558
559
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 557

def disable_auto_scale_with_http_info(resource_group_name, , pool_name, custom_headers:nil)
  disable_auto_scale_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Pool

Gets information about the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



431
432
433
434
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 431

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

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

Gets information about the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 466

def get_async(resource_group_name, , pool_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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_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}/pools/{poolName}'

  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' => ,'poolName' => pool_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?
    # 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_09_01::Models::Pool.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, pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified pool.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



449
450
451
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 449

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

#list_by_batch_account(resource_group_name, account_name, maxresults: nil, select: nil, filter: nil, custom_headers: nil) ⇒ Array<Pool>

Lists all of the pools in the specified account.

contains the Batch account. response. returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection. filtering are:

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale 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

  • select (String) (defaults to: nil) —

    Comma separated list of properties that should be

  • filter (String) (defaults to: nil) —

    OData filter expression. Valid properties for

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

    A hash of custom headers that

Returns:

  • (Array<Pool>) —

    operation results.



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

def (resource_group_name, , maxresults:nil, select:nil, filter:nil, custom_headers:nil)
  first_page = (resource_group_name, , maxresults:maxresults, select:select, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_batch_account_as_lazy(resource_group_name, account_name, maxresults: nil, select: nil, filter: nil, custom_headers: nil) ⇒ ListPoolsResult

Lists all of the pools in the specified account.

contains the Batch account. response. returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection. filtering are:

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale 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

  • select (String) (defaults to: nil) —

    Comma separated list of properties that should be

  • filter (String) (defaults to: nil) —

    OData filter expression. Valid properties for

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

    A hash of custom headers that

Returns:

  • (ListPoolsResult) —

    which provide lazy access to pages of the response.



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 1120

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

#list_by_batch_account_async(resource_group_name, account_name, maxresults: nil, select: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists all of the pools in the specified account.

contains the Batch account. response. returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection. filtering are:

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale 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

  • select (String) (defaults to: nil) —

    Comma separated list of properties that should be

  • filter (String) (defaults to: nil) —

    OData filter expression. Valid properties for

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 123

def (resource_group_name, , maxresults:nil, select:nil, filter: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, '@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}/pools'

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

    result
  end

  promise.execute
end

#list_by_batch_account_next(next_page_link, custom_headers: nil) ⇒ ListPoolsResult

Lists all of the pools 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:

  • (ListPoolsResult) —

    operation results.



1012
1013
1014
1015
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 1012

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

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

Lists all of the pools 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.



1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 1041

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

    result
  end

  promise.execute
end

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

Lists all of the pools 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.



1027
1028
1029
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 1027

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

#list_by_batch_account_with_http_info(resource_group_name, account_name, maxresults: nil, select: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the pools in the specified account.

contains the Batch account. response. returned. e.g. “properties/provisioningState”. Only top level properties under properties/ are valid for selection. filtering are:

name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale 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

  • select (String) (defaults to: nil) —

    Comma separated list of properties that should be

  • filter (String) (defaults to: nil) —

    OData filter expression. Valid properties for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



89
90
91
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 89

def (resource_group_name, , maxresults:nil, select:nil, filter:nil, custom_headers:nil)
  (resource_group_name, , maxresults:maxresults, select:select, filter:filter, custom_headers:custom_headers).value!
end

#stop_resize(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Pool

Stops an ongoing resize operation on the pool.

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



656
657
658
659
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 656

def stop_resize(resource_group_name, , pool_name, custom_headers:nil)
  response = stop_resize_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#stop_resize_async(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ Concurrent::Promise

Stops an ongoing resize operation on the pool.

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 709

def stop_resize_async(resource_group_name, , pool_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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_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}/pools/{poolName}/stopResize'

  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' => ,'poolName' => pool_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(: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?
    # 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_09_01::Models::Pool.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

#stop_resize_with_http_info(resource_group_name, account_name, pool_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stops an ongoing resize operation on the pool.

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

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

  • pool_name (String) —

    The pool name. This must be unique within the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



683
684
685
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 683

def stop_resize_with_http_info(resource_group_name, , pool_name, custom_headers:nil)
  stop_resize_async(resource_group_name, , pool_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, account_name, pool_name, parameters, if_match: nil, custom_headers: nil) ⇒ Pool

Updates the properties of an existing pool.

contains the Batch account. account. that are supplied will be updated, any property not supplied will be unchanged. update. This value can be omitted or set to “*” to apply the operation unconditionally. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Pool properties that should be updated. Properties

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

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

    A hash of custom headers that

Returns:

  • (Pool) —

    operation results.



258
259
260
261
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 258

def update(resource_group_name, , pool_name, parameters, if_match:nil, custom_headers:nil)
  response = update_async(resource_group_name, , pool_name, parameters, if_match:if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Updates the properties of an existing pool.

contains the Batch account. account. that are supplied will be updated, any property not supplied will be unchanged. update. This value can be omitted or set to “*” to apply the operation unconditionally. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Pool properties that should be updated. Properties

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 305

def update_async(resource_group_name, , pool_name, parameters, if_match: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, 'pool_name is nil' if pool_name.nil?
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MaxLength': '64'" if !pool_name.nil? && pool_name.length > 64
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'MinLength': '1'" if !pool_name.nil? && pool_name.length < 1
  fail ArgumentError, "'pool_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9_-]+$'" if !pool_name.nil? && pool_name.match(Regexp.new('^^[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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::Batch::Mgmt::V2017_09_01::Models::Pool.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}/pools/{poolName}'

  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' => ,'poolName' => pool_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(: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 == 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?
    # 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_09_01::Models::Pool.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

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

Updates the properties of an existing pool.

contains the Batch account. account. that are supplied will be updated, any property not supplied will be unchanged. update. This value can be omitted or set to “*” to apply the operation unconditionally. 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.

  • pool_name (String) —

    The pool name. This must be unique within the

  • parameters (Pool) —

    Pool properties that should be updated. Properties

  • if_match (String) (defaults to: nil) —

    The entity state (ETag) version of the pool to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



282
283
284
 
# File 'lib/2017-09-01/generated/azure_mgmt_batch/pool_operations.rb', line 282

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