Skip to main content

evaluate_pool_auto_scales

Creates, updates, deletes, gets or lists an evaluate_pool_auto_scales resource.

Overview

Nameevaluate_pool_auto_scales
TypeResource
Idazure.batch_dataplane.evaluate_pool_auto_scales

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
evaluate_pool_auto_scaleexecpool_id, endpoint, autoScaleFormulatimeOut, ocp-dateGets the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
pool_idstringThe ID of the Pool on which to evaluate the automatic scaling formula. Required.
ocp-datestringThe time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. Default value is None.
timeOutintegerThe maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.". Default value is None.

Lifecycle Methods

Gets the result of evaluating an automatic scaling formula on the Pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.

EXEC azure.batch_dataplane.evaluate_pool_auto_scales.evaluate_pool_auto_scale 
@pool_id='{{ pool_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}'
@@json=
'{
"autoScaleFormula": "{{ autoScaleFormula }}"
}'
;