Nodes

Adds a user Account to the specified Compute Node.

Changed on

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

post/pools/{poolId}/nodes/{nodeId}/users

Request

  • Base URL
    {endpoint}
  • Auth
    OAuth 2
    Implicithttps://login.microsoftonline.com/common/oauth2/v2.0/authorize
    Scopeshttps://batch.core.windows.net//.default

Path parameters

poolIdstring required

The ID of the Pool that contains the Compute Node.

nodeIdstring required

The ID of the machine on which you want to create a user Account.

Query parameters

api-versionstring required

The API version to use for this operation.

timeOutinteger

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

Headers

client-request-idstring

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-idboolean

Whether the server should return the client-request-id in the response.

ocp-datestring date-time-rfc7231

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.

Request body

namestring required

The user name of the Account.

isAdminboolean

Whether the Account should be an administrator on the Compute Node. The default value is false.

expiryTimestring date-time

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.

passwordstring password

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.

sshPublicKeystring

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

Response

The request has succeeded and a new resource has been created as a result.

Changes

    • warning

      deleted the query request parameter timeout

    • info

      api operation id ComputeNode_AddUser removed and replaced with Nodes_CreateNodeUser

    • info

      api tag Nodes added

    2 more changes in this revision