Share via

Nodes - List Node Extensions

Service:
Batch Service
API Version:
2025-06-01

Lists the Compute Nodes Extensions in the specified Pool.

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01
With optional parameters: 
GET {endpoint}/pools/{poolId}/nodes/{nodeId}/extensions?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$select={$select}

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).
nodeId
 path True

string

The ID of the Compute Node that you want to list extensions.
poolId
 path True

string

The ID of the Pool that contains Compute Node.
api-version
 query True

string

minLength: 1

The API version to use for this operation.
$select
 query

string[]

An OData $select clause.
maxresults
 query

integer (int32)

minimum: 1
maximum: 1000

The maximum number of items to return in the response. A maximum of 1000 applications can be returned.
timeOut
 query

integer (int32)

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.".

Request Header

Name Required Type Description
client-request-id

string

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

boolean

Whether the server should return the client-request-id in the response.
ocp-date

string (date-time-rfc7231)

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.

Responses

Name Type Description
200 OK

BatchNodeVMExtensionListResult

The request has succeeded.

Headers

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name Description
https://batch.core.windows.net//.default

Examples

List compute node extensions

Sample request

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z/extensions?api-version=2025-06-01

Sample response

Status code:
200 
{
  "value": [
    {
      "instanceView": {
        "name": "batchNodeExtension",
        "statuses": [
          {
            "code": "ProvisioningState/succeeded",
            "level": "Info",
            "displayStatus": "Provisioning succeeded",
            "message": "Enable succeeded: Enabling and starting agent and controller"
          }
        ]
      },
      "vmExtension": {
        "name": "batchNodeExtension",
        "publisher": "Microsoft.Azure.Extensions",
        "type": "CustomScript",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true
      }
    },
    {
      "instanceView": {
        "name": "customExtension",
        "statuses": [
          {
            "code": "ProvisioningState/succeeded",
            "level": "Info",
            "displayStatus": "Provisioning succeeded",
            "message": "ExtensionOperation:enable. Status:Success"
          }
        ]
      },
      "vmExtension": {
        "name": "customExtension",
        "publisher": "Microsoft.Azure.Geneva",
        "type": "GenevaMonitoring",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true
      }
    }
  ]
}

Definitions

Name Description
BatchError

An error response received from the Azure Batch service.
BatchErrorDetail

An item of additional information included in an Azure Batch error response.
BatchErrorMessage

An error message received in an Azure Batch error response.
BatchNodeVMExtension

The configuration for virtual machine extension instance view.
BatchNodeVMExtensionListResult

The result of listing the Compute Node extensions in a Node.
InstanceViewStatus

The instance view status.
StatusLevelTypes

Level code.
VMExtension

The configuration for virtual machine extensions.
VMExtensionInstanceView

The vm extension instance view.

BatchError

Object

An error response received from the Azure Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message

BatchErrorMessage

A message describing the error, intended to be suitable for display in a user interface.
values

BatchErrorDetail[]

A collection of key-value pairs containing additional details about the error.

BatchErrorDetail

Object

An item of additional information included in an Azure Batch error response.

Name Type Description
key

string

An identifier specifying the meaning of the Value property.
value

string

The additional information included with the error response.

BatchErrorMessage

Object

An error message received in an Azure Batch error response.

Name Type Description
lang

string

The language code of the error message.
value

string

The text of the message.

BatchNodeVMExtension

Object

The configuration for virtual machine extension instance view.

Name Type Description
instanceView

VMExtensionInstanceView

The vm extension instance view.
provisioningState

string

The provisioning state of the virtual machine extension.
vmExtension

VMExtension

The virtual machine extension.

BatchNodeVMExtensionListResult

Object

The result of listing the Compute Node extensions in a Node.

Name Type Description
odata.nextLink

string (uri)

The URL to get the next set of results.
value

BatchNodeVMExtension[]

The list of Compute Node extensions.

InstanceViewStatus

Object

The instance view status.

Name Type Description
code

string

The status code.
displayStatus

string

The localized label for the status.
level

StatusLevelTypes

Level code.
message

string

The detailed status message.
time

string (date-time)

The time of the status.

StatusLevelTypes

Enumeration

Level code.

Value Description
Error

Error
Info

Info
Warning

Warning

VMExtension

Object

The configuration for virtual machine extensions.

Name Type Description
autoUpgradeMinorVersion

boolean

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade

boolean

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
name

string

The name of the virtual machine extension.
protectedSettings

object

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisionAfterExtensions

string[]

The collection of extension names. Collection of extension names after which this extension needs to be provisioned.
publisher

string

The name of the extension handler publisher.
settings

object

JSON formatted public settings for the extension.
type

string

The type of the extension.
typeHandlerVersion

string

The version of script handler.

VMExtensionInstanceView

Object

The vm extension instance view.

Name Type Description
name

string

The name of the vm extension instance view.
statuses

InstanceViewStatus[]

The resource status information.
subStatuses

InstanceViewStatus[]

The resource status information.