Account

Service:: Batch Service

API Version:: 2017-09-01.6.0

Lists all node agent SKUs supported by the Azure Batch service.

GET https://batch.core.windows.net/nodeagentskus&api-version={api-version}

With optional parameters:

GET https://batch.core.windows.net/nodeagentskus?$filter={$filter}&maxresults={maxresults}&timeout={timeout}&api-version={api-version}

URI Parameters

Name	In	Required	Type	Description
$filter	query		string	An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus.
maxresults	query		integer int32	The maximum number of items to return in the response. A maximum of 1000 results will be returned.
timeout	query		integer int32	The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
api-version	query	True	string	Client API Version.

Request Headers

Name	Type	Description
client-request-id	string uuid	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-rfc1123	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	AccountListNodeAgentSkusResult	A response containing the list of node agent SKUs.
Other Status Codes	BatchError	The error from the Batch service.

Examples

Account list node agent skus

Sample Request

GET https://batch.core.windows.net/nodeagentskus&api-version=2017-09-01.6.0
client-request-id: 00000000-0000-0000-0000-000000000000

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "batch.node.centos 7",
      "verifiedImageReferences": [
        {
          "publisher": "OpenLogic",
          "offer": "CentOS",
          "sku": "7.2",
          "version": "latest"
        },
        {
          "publisher": "OpenLogic",
          "offer": "CentOS",
          "sku": "7.1",
          "version": "latest"
        }
      ],
      "osType": "linux"
    },
    {
      "id": "batch.node.debian 8",
      "verifiedImageReferences": [
        {
          "publisher": "Credativ",
          "offer": "Debian",
          "sku": "8",
          "version": "latest"
        }
      ],
      "osType": "linux"
    },
    {
      "id": "batch.node.windows amd64",
      "verifiedImageReferences": [
        {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2012-R2-Datacenter",
          "version": "latest"
        },
        {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2012-Datacenter",
          "version": "latest"
        }
      ],
      "osType": "windows"
    }
  ]
}

Definitions

AccountListNodeAgentSkusResult
BatchError
BatchErrorDetail
ErrorMessage
ImageReference
NodeAgentSku	The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

AccountListNodeAgentSkusResult

Name	Type	Description
odata.nextLink	string	The URL to get the next set of results.
value	NodeAgentSku[]	The list of supported node agent SKUs.

BatchError

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	ErrorMessage	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

Name	Type	Description
key	string	An identifier specifying the meaning of the Value property.
value	string	The additional information included with the error response.

ErrorMessage

Name	Type	Description
lang	string	The language code of the error message
value	string	The text of the message.

ImageReference

Name	Type	Description
offer	string	The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.
publisher	string	The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.
sku	string	The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
version	string	The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.
virtualMachineImageId	string	The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName} This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

NodeAgentSku

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

Name	Type	Description
id	string	The ID of the node agent SKU.
osType	enum: linux windows	The type of operating system (e.g. Windows or Linux) compatible with the node agent SKU.
verifiedImageReferences	ImageReference[]	The list of Azure Marketplace images verified to be compatible with this node agent SKU. This collection is not exhaustive (the node agent may be compatible with other images).