Machines - List

Service:: AKS

API Version:: 2025-02-01

Gets a list of machines in the specified agent pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	The name of the agent pool.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	The name of the managed cluster resource.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	MachineListResult	OK
Other Status Codes	CloudError	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

List Machines in an Agentpool by Managed Cluster

Sample request

GET https://management.azure.com/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines?api-version=2025-02-01


/**
 * Samples for Machines List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-02-01/examples/
     * MachineList.json
     */
    /**
     * Sample code: List Machines in an Agentpool by Managed Cluster.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listMachinesInAnAgentpoolByManagedCluster(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getMachines().list("rg1", "clustername1", "agentpool1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python machine_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="26fe00f8-9173-4872-9134-bb1d2e00343a",
    )

    response = client.machines.list(
        resource_group_name="rg1",
        resource_name="clustername1",
        agent_pool_name="agentpool1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-02-01/examples/MachineList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcontainerservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/62d827e6c0f471fe0828b517f481f7485a676ffb/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-02-01/examples/MachineList.json
func ExampleMachinesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewMachinesClient().NewListPager("rg1", "clustername1", "agentpool1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MachineListResult = armcontainerservice.MachineListResult{
		// 	Value: []*armcontainerservice.Machine{
		// 		{
		// 			Name: to.Ptr("aks-nodepool1-25481572-vmss000000"),
		// 			Type: to.Ptr("Microsoft.ContainerService/managedClusters/agentPools/machines"),
		// 			ID: to.Ptr("/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000"),
		// 			Properties: &armcontainerservice.MachineProperties{
		// 				Network: &armcontainerservice.MachineNetworkProperties{
		// 					IPAddresses: []*armcontainerservice.MachineIPAddress{
		// 						{
		// 							Family: to.Ptr(armcontainerservice.IPFamilyIPv4),
		// 							IP: to.Ptr("172.20.2.4"),
		// 						},
		// 						{
		// 							Family: to.Ptr(armcontainerservice.IPFamilyIPv4),
		// 							IP: to.Ptr("10.0.0.1"),
		// 					}},
		// 				},
		// 				ResourceID: to.Ptr("/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000",
      "name": "aks-nodepool1-25481572-vmss000000",
      "type": "Microsoft.ContainerService/managedClusters/agentPools/machines",
      "properties": {
        "network": {
          "ipAddresses": [
            {
              "ip": "172.20.2.4",
              "family": "IPv4"
            },
            {
              "ip": "10.0.0.1",
              "family": "IPv4"
            }
          ]
        },
        "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0"
      }
    }
  ],
  "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE"
}

Definitions

Name	Description
CloudError	An error response from the Container service.
CloudErrorBody	An error response from the Container service.
IPFamily	To determine if address belongs IPv4 or IPv6 family
Machine	A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.
MachineIpAddress	The machine IP address details.
MachineListResult	The response from the List Machines operation.
MachineNetworkProperties	network properties of the machine
MachineProperties	The properties of the machine

CloudError

Object

An error response from the Container service.

Name	Type	Description
error	CloudErrorBody	Details about the error.

CloudErrorBody

Object

An error response from the Container service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

IPFamily

Enumeration

To determine if address belongs IPv4 or IPv6 family

Value	Description
IPv4	IPv4 family
IPv6	IPv6 family

Machine

Object

A machine. Contains details about the underlying virtual machine. A machine may be visible here but not in kubectl get nodes; if so it may be because the machine has not been registered with the Kubernetes API Server yet.

Name	Type	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
properties	MachineProperties	The properties of the machine
type	string	Resource type

MachineIpAddress

Object

The machine IP address details.

Name	Type	Description
family	IPFamily	To determine if address belongs IPv4 or IPv6 family
ip	string	IPv4 or IPv6 address of the machine

MachineListResult

Object

The response from the List Machines operation.

Name	Type	Description
nextLink	string (uri)	The URL to get the next set of machine results.
value	Machine[]	The list of Machines in cluster.

MachineNetworkProperties

Object

network properties of the machine

Name	Type	Description
ipAddresses	MachineIpAddress[]	IPv4, IPv6 addresses of the machine

MachineProperties

Object

The properties of the machine

Name	Type	Description
network	MachineNetworkProperties	network properties of the machine
resourceId	string (arm-id)	Azure resource id of the machine. It can be used to GET underlying VM Instance

Share via

Machines - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Machines in an Agentpool by Managed Cluster

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

IPFamily

Machine

MachineIpAddress

MachineListResult

MachineNetworkProperties

MachineProperties