node_users

Creates, updates, deletes, gets or lists a node_users resource.

Overview

Name	node_users
Type	Resource
Id	azure.batch_dataplane.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
create_node_user	insert	pool_id, node_id, endpoint, name	timeOut, ocp-date	Adds a user Account to the specified Compute Node. You can add a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration _.
delete_node_user	delete	pool_id, node_id, user_name, endpoint	timeOut, ocp-date	Deletes a user Account from the specified Compute Node. You can delete a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration _.

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 delete 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 delete. 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.

INSERT examples

create_node_user

Adds a user Account to the specified Compute Node. You can add a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration _.

INSERT INTO azure.batch_dataplane.node_users (
name,
isAdmin,
expiryTime,
password,
sshPublicKey,
pool_id,
node_id,
endpoint,
timeOut,
ocp-date
)
SELECT 
'{{ name }}' /* required */,
{{ isAdmin }},
'{{ expiryTime }}',
'{{ password }}',
'{{ sshPublicKey }}',
'{{ pool_id }}',
'{{ node_id }}',
'{{ endpoint }}',
'{{ timeOut }}',
'{{ ocp-date }}'
;

Manifest

# Description fields are for documentation purposes
- name: node_users
props:
  - name: pool_id
    value: "{{ pool_id }}"
    description: Required parameter for the node_users resource.
  - name: node_id
    value: "{{ node_id }}"
    description: Required parameter for the node_users resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the node_users resource.
  - name: name
    value: "{{ name }}"
    description: |
      The user name of the Account. Required.
  - name: isAdmin
    value: {{ isAdmin }}
    description: |
      Whether the Account should be an administrator on the Compute Node. The default value is false.
  - name: expiryTime
    value: "{{ expiryTime }}"
    description: |
      The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.
  - name: password
    value: "{{ password }}"
    description: |
      The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.
  - name: sshPublicKey
    value: "{{ sshPublicKey }}"
    description: |
      The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  - name: timeOut
    value: {{ timeOut }}
    description: 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.
    description: 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.
  - name: ocp-date
    value: "{{ ocp-date }}"
    description: 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.
    description: 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.

DELETE examples

delete_node_user

Deletes a user Account from the specified Compute Node. You can delete a user Account to a Compute Node only when it is in the idle or running state. Before you can remotely login to a Compute Node you must configure access ports for SSH and RDP. For more information, see https://learn.microsoft.com/azure/batch/pool-endpoint-configuration _.

DELETE FROM azure.batch_dataplane.node_users
WHERE pool_id = '{{ pool_id }}' --required
AND node_id = '{{ node_id }}' --required
AND user_name = '{{ user_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND timeOut = '{{ timeOut }}'
AND ocp-date = '{{ ocp-date }}'
;