How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure ComputeNodes API

The ComputeNodes API from Microsoft Azure — 14 operation(s) for computenodes.

Microsoft Azure ComputeNodes API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ComputeNodes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 15 operations across 14 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

15 operations 14 paths 46 schemas 1 DELETE6 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 1 DELETE, 6 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ComputeNodes 15
POST
/pools/{poolId}/removenodes
Microsoft Azure Removes Compute Nodes From The Specified Pool
microsoftAzurePoolRemovenodes 10 params body → 202default
POST
/pools/{poolId}/nodes/{nodeId}/users
Microsoft Azure Adds A User Account To The Specified Compute Node
microsoftAzureComputenodeAdduser 7 params body → 201default
DELETE
/pools/{poolId}/nodes/{nodeId}/users/{userName}
Microsoft Azure Deletes A User Account From The Specified Compute Node
microsoftAzureComputenodeDeleteuser 8 params → 200default
PUT
/pools/{poolId}/nodes/{nodeId}/users/{userName}
Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node
microsoftAzureComputenodeUpdateuser 8 params body → 200default
GET
/pools/{poolId}/nodes/{nodeId}
Microsoft Azure Gets Information About The Specified Compute Node
microsoftAzureComputenodeGet 8 params → 200default
POST
/pools/{poolId}/nodes/{nodeId}/reboot
Microsoft Azure Restarts The Specified Compute Node
microsoftAzureComputenodeReboot 7 params body → 202default
POST
/pools/{poolId}/nodes/{nodeId}/reimage
Microsoft Azure Reinstalls The Operating System On The Specified Compute Node
microsoftAzureComputenodeReimage 7 params body → 202default
POST
/pools/{poolId}/nodes/{nodeId}/disablescheduling
Microsoft Azure Disables Task Scheduling On The Specified Compute Node
microsoftAzureComputenodeDisablescheduling 7 params body → 200default
POST
/pools/{poolId}/nodes/{nodeId}/enablescheduling
Microsoft Azure Enables Task Scheduling On The Specified Compute Node
microsoftAzureComputenodeEnablescheduling 7 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/remoteloginsettings
Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node
microsoftAzureComputenodeGetremoteloginsettings 7 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/rdp
Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node
microsoftAzureComputenodeGetremotedesktop 7 params → 200default
POST
/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs
Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure Blob Storage
microsoftAzureComputenodeUploadbatchservicelogs 7 params body → 200default
GET
/pools/{poolId}/nodes
Microsoft Azure Lists The Compute Nodes In The Specified Pool
microsoftAzureComputenodeList 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}
Microsoft Azure Gets Information About The Specified Compute Node Extension
microsoftAzureComputenodeextensionGet 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/extensions
Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool
microsoftAzureComputenodeextensionList 9 params → 200default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ComputeNode (22 properties), TaskExecutionInformation (10 properties), StartTaskInformation (9 properties), VMExtension (9 properties). Each schema is shown below with its type and property counts.

TaskExecutionInformation
object
10 properties 2 required
NodeAgentInformation
object
The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.
2 properties 2 required
ErrorMessage
object
2 properties
BatchErrorDetail_2
object
2 properties
ComputeNode
object
22 properties
InboundEndpointProtocol
string
ComputeNodeDeallocationOption
string
The default value is requeue.
TaskFailureInformation
object
4 properties 1 required
ComputeNodeEndpointConfiguration
object
1 property 1 required
AutoUserSpecification
object
2 properties
StartTask
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
7 properties 1 required
ContainerRegistry
object
3 properties 2 required
StartTaskInformation
object
9 properties 3 required
CertificateReference
object
5 properties 2 required
NodeRemoveParameter
object
3 properties 1 required
NodeRebootParameter
object
1 property
BatchError_2
object
3 properties
TaskInformation
object
6 properties 1 required
UploadBatchServiceLogsResult
object
2 properties 2 required
NodeVMExtension
object
3 properties
EnvironmentSetting
object
2 properties 1 required
TaskContainerSettings
object
4 properties 1 required
BatchError
object
3 properties
VMExtensionInstanceView
object
3 properties
ResourceFile
object
6 properties
UserIdentity
object
Specify either the userName or autoUser property, but not both.
2 properties
NodeReimageParameter
object
1 property
ComputeNodeListResult
object
2 properties
NodeDisableSchedulingParameter
object
1 property
ErrorMessage_2
object
2 properties
ComputeNodeError
object
3 properties
TaskState
string
VMExtension
object
9 properties 3 required
ComputeNodeGetRemoteLoginSettingsResult
object
2 properties 2 required
ErrorCategory
string
TaskExecutionResult
string
InstanceViewStatus
object
5 properties
UploadBatchServiceLogsConfiguration
object
3 properties 2 required
NameValuePair
object
2 properties
TaskContainerExecutionInformation
object
3 properties
BatchErrorDetail
object
2 properties
NodeVMExtensionList
object
2 properties
NodeUpdateUserParameter
object
3 properties
ElevationLevel
string
ComputeNodeUser
object
5 properties 1 required
InboundEndpoint
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-computenodes-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure ComputeNodes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.