Compute Node

Operations

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

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

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

Enable Scheduling

Enables Task scheduling on the specified Compute Node.
You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled

Get

Gets information about the specified Compute Node.

Get Remote Desktop

Gets the Remote Desktop Protocol file for the specified Compute Node.
Before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API.

Get Remote Login Settings

Gets the settings required for remote login to a Compute Node.
Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.

List

Lists the Compute Nodes in the specified Pool.

Reboot

Restarts the specified Compute Node.
You can restart a Compute Node only if it is in an idle or running state.

Reimage

Reinstalls the operating system on the specified Compute Node.
You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.

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

Upload Batch Service Logs

Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.
This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.