Before you can access a node by using the RDP file, you must create a user account on the 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.
643 matches
69 actions
BatchService
69 actions
- Account_ListPoolNodeCountsGETv1.0.0
- Adds a certificate to the specified account.POSTv1.0.0
- Adds a collection of tasks to the specified job.POSTv1.0.0
- Adds a job schedule to the specified account.POSTv1.0.0
- Adds a job to the specified account.POSTv1.0.0
- Adds a pool to the specified account.POSTv1.0.0
- Adds a task to the specified job.POSTv1.0.0
- Adds a user account to the specified compute node.POSTv1.0.0
- Cancels a failed deletion of a certificate from the specified account.POSTv1.0.0
- Certificate_GetGETv1.0.0
- Changes the number of compute nodes that are assigned to a pool.POSTv1.0.0
- Deletes a certificate from the specified account.DELETEv1.0.0
- Deletes a job schedule from the specified account.DELETEv1.0.0
- Deletes a job.DELETEv1.0.0
- Deletes a pool from the specified account.DELETEv1.0.0
- Deletes a task from the specified job.DELETEv1.0.0
- Deletes a user account from the specified compute node.DELETEv1.0.0
- Deletes the specified file from the compute node.DELETEv1.0.0
- Deletes the specified task file from the compute node where the task ran.DELETEv1.0.0
- Disables a job schedule.POSTv1.0.0
- Disables automatic scaling for a pool.POSTv1.0.0
- Disables task scheduling on the specified compute node.POSTv1.0.0
- Disables the specified job, preventing new tasks from running.POSTv1.0.0
- Enables a job schedule.POSTv1.0.0
- Enables automatic scaling for a pool.POSTv1.0.0
- Enables task scheduling on the specified compute node.POSTv1.0.0
- Enables the specified job, allowing new tasks to run.POSTv1.0.0
- File_GetFromComputeNodeGETv1.0.0
- File_GetFromTaskGETv1.0.0
- Gets information about the specified application.GETv1.0.0
- Gets information about the specified compute node.GETv1.0.0
- Gets information about the specified job.GETv1.0.0
- Gets information about the specified task.GETv1.0.0
- Gets lifetime summary statistics for all of the jobs in the specified account.GETv1.0.0
- Gets lifetime summary statistics for all of the pools in the specified account.GETv1.0.0
- Gets the Remote Desktop Protocol file for the specified compute node.GETv1.0.0
- Gets the result of evaluating an automatic scaling formula on the pool.POSTv1.0.0
- Gets the settings required for remote login to a compute node.GETv1.0.0
- Gets the task counts for the specified job.GETv1.0.0
- JobSchedule_GetGETv1.0.0
- Lists all of the applications available in the specified account.GETv1.0.0
- Lists all of the certificates that have been added to the specified account.GETv1.0.0
- Lists all of the files in task directories on the specified compute node.GETv1.0.0
- Lists all of the job schedules in the specified account.GETv1.0.0
- Lists all of the jobs in the specified account.GETv1.0.0
- Lists all of the pools in the specified account.GETv1.0.0
- Lists all of the subtasks that are associated with the specified multi-instance task.GETv1.0.0
- Lists all of the tasks that are associated with the specified job.GETv1.0.0
- Lists the compute nodes in the specified pool.GETv1.0.0
- Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.GETv1.0.0
- Lists the files in a task's directory on its compute node.GETv1.0.0
- Lists the jobs that have been created under the specified job schedule.GETv1.0.0
- Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.GETv1.0.0
- Pool_GetGETv1.0.0
- Reactivates a task, allowing it to run again even if its retry count has been exhausted.POSTv1.0.0
- Reinstalls the operating system on the specified compute node.POSTv1.0.0
- Restarts the specified compute node.POSTv1.0.0
- Stops an ongoing resize operation on the pool.POSTv1.0.0
- Terminates a job schedule.POSTv1.0.0
- Terminates the specified job, marking it as completed.POSTv1.0.0
- Terminates the specified task.POSTv1.0.0
- Updates the password and expiration time of a user account on the specified compute node.PUTv1.0.0
- Updates the properties of the specified job schedule.PATCHv1.0.0
- Updates the properties of the specified job schedule.PUTv1.0.0
- Updates the properties of the specified job.PATCHv1.0.0
- Updates the properties of the specified job.PUTv1.0.0
- Updates the properties of the specified pool.PATCHv1.0.0
- Updates the properties of the specified pool.POSTv1.0.0
- Upgrades the operating system of the specified pool.POSTv1.0.0
Infrastructure/BatchService
Gets the Remote Desktop Protocol file for the specified compute node.
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
{
"type": "object",
"properties": {
"api-version": {
"type": "string"
},
"client-request-id": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"ocp-date": {
"type": "string"
},
"poolId": {
"type": "string"
},
"return-client-request-id": {
"type": "string"
},
"timeout": {
"type": "string"
}
},
"required": [
"api-version",
"nodeId",
"poolId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}