replace_pool_properties
Creates, updates, deletes, gets or lists a replace_pool_properties resource.
Overview
| Name | replace_pool_properties |
| Type | Resource |
| Id | azure.batch_dataplane.replace_pool_properties |
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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
replace_pool_properties | exec | pool_id, endpoint, applicationPackageReferences, metadata | timeOut, ocp-date | Updates the properties of the specified Pool. This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask. |
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.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
pool_id | string | The ID of the Pool to update. Required. |
ocp-date | string | The 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. |
timeOut | integer | The 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
- replace_pool_properties
Updates the properties of the specified Pool. This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.
EXEC azure.batch_dataplane.replace_pool_properties.replace_pool_properties
@pool_id='{{ pool_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}'
@@json=
'{
"startTask": "{{ startTask }}",
"applicationPackageReferences": "{{ applicationPackageReferences }}",
"metadata": "{{ metadata }}"
}'
;