replace_node_users
Creates, updates, deletes, gets or lists a replace_node_users resource.
Overview
| Name | replace_node_users |
| Type | Resource |
| Id | azure.batch_dataplane.replace_node_users |
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_node_user | exec | pool_id, node_id, user_name, endpoint | timeOut, ocp-date | Updates the password and expiration time of a user Account on the specified Compute Node. This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state. |
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 machine on which you want to update a user Account. Required. |
pool_id | string | The ID of the Pool that contains the Compute Node. Required. |
user_name | string | The name of the user Account 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_node_user
Updates the password and expiration time of a user Account on the specified Compute Node. This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.
EXEC azure.batch_dataplane.replace_node_users.replace_node_user
@pool_id='{{ pool_id }}' --required,
@node_id='{{ node_id }}' --required,
@user_name='{{ user_name }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeOut='{{ timeOut }}',
@ocp-date='{{ ocp-date }}'
@@json=
'{
"password": "{{ password }}",
"expiryTime": "{{ expiryTime }}",
"sshPublicKey": "{{ sshPublicKey }}"
}'
;