ComputeNodeOperations class

Create a ComputeNodeOperations.

new ComputeNodeOperations(client: BatchServiceClientContext)

Parameters

You can add a user Account to a Compute Node only when it is in the idle or running state.

function addUser(poolId: string, nodeId: string, user: ComputeNodeUser, options?: ComputeNodeAddUserOptionalParams): Promise<ComputeNodeAddUserResponse>

Parameters

Returns

Promise<Models.ComputeNodeAddUserResponse>

function addUser(poolId: string, nodeId: string, user: ComputeNodeUser, options: ComputeNodeAddUserOptionalParams, callback: ServiceCallback<void>)

Parameters

function addUser(poolId: string, nodeId: string, user: ComputeNodeUser, callback: ServiceCallback<void>)

Parameters

You can delete a user Account to a Compute Node only when it is in the idle or running state.

function deleteUser(poolId: string, nodeId: string, userName: string, options?: ComputeNodeDeleteUserOptionalParams): Promise<ComputeNodeDeleteUserResponse>

Parameters

Returns

Promise<Models.ComputeNodeDeleteUserResponse>

function deleteUser(poolId: string, nodeId: string, userName: string, options: ComputeNodeDeleteUserOptionalParams, callback: ServiceCallback<void>)

Parameters

function deleteUser(poolId: string, nodeId: string, userName: string, callback: ServiceCallback<void>)

Parameters

You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.

function disableScheduling(poolId: string, nodeId: string, options?: ComputeNodeDisableSchedulingOptionalParams): Promise<ComputeNodeDisableSchedulingResponse>

Parameters

Returns

Promise<Models.ComputeNodeDisableSchedulingResponse>

function disableScheduling(poolId: string, nodeId: string, options: ComputeNodeDisableSchedulingOptionalParams, callback: ServiceCallback<void>)

Parameters

function disableScheduling(poolId: string, nodeId: string, callback: ServiceCallback<void>)

Parameters

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

function enableScheduling(poolId: string, nodeId: string, options?: ComputeNodeEnableSchedulingOptionalParams): Promise<ComputeNodeEnableSchedulingResponse>

Parameters

Returns

Promise<Models.ComputeNodeEnableSchedulingResponse>

function enableScheduling(poolId: string, nodeId: string, options: ComputeNodeEnableSchedulingOptionalParams, callback: ServiceCallback<void>)

Parameters

function enableScheduling(poolId: string, nodeId: string, callback: ServiceCallback<void>)

Parameters

function get(poolId: string, nodeId: string, options?: ComputeNodeGetOptionalParams): Promise<ComputeNodeGetResponse>

Parameters

Returns

Promise<Models.ComputeNodeGetResponse>

function get(poolId: string, nodeId: string, options: ComputeNodeGetOptionalParams, callback: ServiceCallback<ComputeNode>)

Parameters

function get(poolId: string, nodeId: string, callback: ServiceCallback<ComputeNode>)

Parameters

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.

function getRemoteDesktop(poolId: string, nodeId: string, options?: ComputeNodeGetRemoteDesktopOptionalParams): Promise<ComputeNodeGetRemoteDesktopResponse>

Parameters

Returns

Promise<Models.ComputeNodeGetRemoteDesktopResponse>

function getRemoteDesktop(poolId: string, nodeId: string, options: ComputeNodeGetRemoteDesktopOptionalParams, callback: ServiceCallback<void>)

Parameters

function getRemoteDesktop(poolId: string, nodeId: string, callback: ServiceCallback<void>)

Parameters

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.

function getRemoteLoginSettings(poolId: string, nodeId: string, options?: ComputeNodeGetRemoteLoginSettingsOptionalParams): Promise<ComputeNodeGetRemoteLoginSettingsResponse>

Parameters

Returns

Promise<Models.ComputeNodeGetRemoteLoginSettingsResponse>

function getRemoteLoginSettings(poolId: string, nodeId: string, options: ComputeNodeGetRemoteLoginSettingsOptionalParams, callback: ServiceCallback<ComputeNodeGetRemoteLoginSettingsResult>)

Parameters

function getRemoteLoginSettings(poolId: string, nodeId: string, callback: ServiceCallback<ComputeNodeGetRemoteLoginSettingsResult>)

Parameters

function list(poolId: string, options?: ComputeNodeListOptionalParams): Promise<ComputeNodeListResponse>

Parameters

Returns

Promise<Models.ComputeNodeListResponse>

function list(poolId: string, options: ComputeNodeListOptionalParams, callback: ServiceCallback<ComputeNodeListResult>)

Parameters

function list(poolId: string, callback: ServiceCallback<ComputeNodeListResult>)

Parameters

function listNext(nextPageLink: string, options?: ComputeNodeListNextOptionalParams): Promise<ComputeNodeListResponse>

Parameters

Returns

Promise<Models.ComputeNodeListResponse>

function listNext(nextPageLink: string, options: ComputeNodeListNextOptionalParams, callback: ServiceCallback<ComputeNodeListResult>)

Parameters

function listNext(nextPageLink: string, callback: ServiceCallback<ComputeNodeListResult>)

Parameters

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

function reboot(poolId: string, nodeId: string, options?: ComputeNodeRebootOptionalParams): Promise<ComputeNodeRebootResponse>

Parameters

Returns

Promise<Models.ComputeNodeRebootResponse>

function reboot(poolId: string, nodeId: string, options: ComputeNodeRebootOptionalParams, callback: ServiceCallback<void>)

Parameters

function reboot(poolId: string, nodeId: string, callback: ServiceCallback<void>)

Parameters

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.

function reimage(poolId: string, nodeId: string, options?: ComputeNodeReimageOptionalParams): Promise<ComputeNodeReimageResponse>

Parameters

Returns

Promise<Models.ComputeNodeReimageResponse>

function reimage(poolId: string, nodeId: string, options: ComputeNodeReimageOptionalParams, callback: ServiceCallback<void>)

Parameters

function reimage(poolId: string, nodeId: string, callback: ServiceCallback<void>)

Parameters

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.

function updateUser(poolId: string, nodeId: string, userName: string, nodeUpdateUserParameter: NodeUpdateUserParameter, options?: ComputeNodeUpdateUserOptionalParams): Promise<ComputeNodeUpdateUserResponse>

Parameters

Returns

Promise<Models.ComputeNodeUpdateUserResponse>

function updateUser(poolId: string, nodeId: string, userName: string, nodeUpdateUserParameter: NodeUpdateUserParameter, options: ComputeNodeUpdateUserOptionalParams, callback: ServiceCallback<void>)

Parameters

function updateUser(poolId: string, nodeId: string, userName: string, nodeUpdateUserParameter: NodeUpdateUserParameter, callback: ServiceCallback<void>)

Parameters

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.

function uploadBatchServiceLogs(poolId: string, nodeId: string, uploadBatchServiceLogsConfiguration: UploadBatchServiceLogsConfiguration, options?: ComputeNodeUploadBatchServiceLogsOptionalParams): Promise<ComputeNodeUploadBatchServiceLogsResponse>

Parameters

Returns

Promise<Models.ComputeNodeUploadBatchServiceLogsResponse>

function uploadBatchServiceLogs(poolId: string, nodeId: string, uploadBatchServiceLogsConfiguration: UploadBatchServiceLogsConfiguration, options: ComputeNodeUploadBatchServiceLogsOptionalParams, callback: ServiceCallback<UploadBatchServiceLogsResult>)

Parameters

function uploadBatchServiceLogs(poolId: string, nodeId: string, uploadBatchServiceLogsConfiguration: UploadBatchServiceLogsConfiguration, callback: ServiceCallback<UploadBatchServiceLogsResult>)

Parameters