Compute - List Nodes

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes?api-version=2021-03-01-preview

URI Parameters

Name In Required Type Description
computeName
path True
  • string

Name of the Azure Machine Learning compute.

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

subscriptionId
path True
  • string

The ID of the target subscription.

workspaceName
path True
  • string

Name of Azure Machine Learning workspace.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

The operation was successful. The response contains the list of IP addresses.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get compute nodes information for a compute

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123/listNodes?api-version=2021-03-01-preview

Sample Response

{
  "computeType": "AmlCompute",
  "nodes": [
    {
      "nodeId": "tvm-3601533753_1-20170719t162906z",
      "privateIpAddress": "13.84.190.124",
      "publicIpAddress": "13.84.190.134",
      "port": 50000,
      "nodeState": "running",
      "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890"
    },
    {
      "nodeId": "tvm-3601533753_2-20170719t162906z",
      "privateIpAddress": "13.84.190.124",
      "publicIpAddress": "13.84.190.134",
      "port": 50001,
      "nodeState": "idle"
    }
  ],
  "nextLink": "nextLink"
}

Definitions

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

AmlComputeNodesInformation

Compute node information related to a AmlCompute.

ComputeType

The type of compute

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

nodeState

State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

Name Type Description
nodeId
  • string

Node ID.
ID of the compute node.

nodeState

State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.

port
  • number

Port.
SSH port number of the node.

privateIpAddress
  • string

Private IP address.
Private IP address of the compute node.

publicIpAddress
  • string

Public IP address.
Public IP address of the compute node.

runId
  • string

Run ID.
ID of the Experiment running on the node, if any else null.

AmlComputeNodesInformation

Compute node information related to a AmlCompute.

Name Type Description
computeType string:
  • AmlCompute

The type of compute

nextLink
  • string

The continuation token.

nodes

The collection of returned AmlCompute nodes details.

ComputeType

The type of compute

Name Type Description
AKS
  • string
AmlCompute
  • string
ComputeInstance
  • string
DataFactory
  • string
DataLakeAnalytics
  • string
Databricks
  • string
HDInsight
  • string
SynapseSpark
  • string
VirtualMachine
  • string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

nodeState

State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.

Name Type Description
idle
  • string
leaving
  • string
preempted
  • string
preparing
  • string
running
  • string
unusable
  • string