v1

latestSwagger 2.02026-07-1477151580.2 KB

ComputeNodes

Deletes a user account from the specified compute node.

You can delete a user account to a node only when it is in the idle or running state.

delete/pools/{poolId}/nodes/{nodeId}/users/{userName}

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 delete a user account.

userNamestring required

The name of the user account to delete.

Query parameters

timeoutinteger

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

api-versionstring required

Client API Version.

Headers

client-request-idstring uuid

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-rfc1123

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.

Response

The request to the Batch service was successful.