disable_node_schedulings
Creates, updates, deletes, gets or lists a disable_node_schedulings resource.
Overview
| Name | disable_node_schedulings |
| Type | Resource |
| Id | azure.batch_dataplane.disable_node_schedulings |
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 |
|---|---|---|---|---|
disable_node_scheduling | exec | pool_id, node_id, endpoint | timeOut, ocp-date | Disables Task scheduling on the specified Compute Node. You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled. |
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: ) |
node_id | string | The ID of the Compute Node on which you want to disable Task scheduling. Required. |
pool_id | string | The ID of the Pool that contains the Compute Node. 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
- disable_node_scheduling
Disables Task scheduling on the specified Compute Node. You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.
EXEC azure.batch_dataplane.disable_node_schedulings.disable_node_scheduling
@pool_id='{{ pool_id }}' --required,
@node_id='{{ node_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}'
@@json=
'{
"nodeDisableSchedulingOption": "{{ nodeDisableSchedulingOption }}"
}'
;