Machine Learning 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=2019-05-01

URI Parameters

Name In Required Type Description
computeName
path True
  • string

Name of the Azure Machine Learning compute.

resourceGroupName
path True
  • string

Name of the resource group in which workspace is located.

subscriptionId
path True
  • string

Azure subscription identifier.

workspaceName
path True
  • string

Name of Azure Machine Learning workspace.

api-version
query True
  • string

Version of Azure Machine Learning resource provider API.

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=2019-05-01

Sample Response

{
  "computeType": "AmlCompute",
  "nodes": [
    {
      "nodeId": "tvm-3601533753_1-20170719t162906z",
      "ipAddress": "13.84.190.124",
      "port": 50000
    },
    {
      "nodeId": "tvm-3601533753_2-20170719t162906z",
      "ipAddress": "13.84.190.124",
      "port": 50001
    }
  ],
  "nextLink": "nextLink"
}

Definitions

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

AmlComputeNodesInformation

Compute node information related to a AmlCompute.

ComputeType

The type of compute

ErrorDetail

Error detail information.

ErrorResponse

Error response information.

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

AmlComputeNodeInformation

Compute node information related to a AmlCompute.

Name Type Description
ipAddress
  • string

IP address.
Public IP address of the compute node.

nodeId
  • string

Node ID.
ID of the compute node.

port
  • number

Port.
SSH port number of the node.

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
DataFactory
  • string
DataLakeAnalytics
  • string
Databricks
  • string
HDInsight
  • string
VirtualMachine
  • string

ErrorDetail

Error detail information.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

ErrorResponse

Error response information.

Name Type Description
code
  • string

Error code.

details

An array of error detail objects.

message
  • string

Error message.

MachineLearningServiceError

Wrapper for error response to follow ARM guidelines.

Name Type Description
error

The error response.