Machines - List

Serviço:: AKS

Versão da API:: 2025-03-01

Obtém uma lista de máquinas no pool de agentes especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	O nome do pool de agentes.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
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]$	O nome do recurso de cluster gerenciado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	MachineListResult	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

List Machines in an Agentpool by Managed Cluster

Pedido de amostra

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

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

const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets a list of machines in the specified agent pool.
 *
 * @summary Gets a list of machines in the specified agent pool.
 * x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-03-01/examples/MachineList.json
 */
async function listMachinesInAnAgentpoolByManagedCluster() {
  const subscriptionId =
    process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "26fe00f8-9173-4872-9134-bb1d2e00343a";
  const resourceGroupName = process.env["CONTAINERSERVICE_RESOURCE_GROUP"] || "rg1";
  const resourceName = "clustername1";
  const agentPoolName = "agentpool1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerServiceClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.machines.list(resourceGroupName, resourceName, agentPoolName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço de contêiner.
CloudErrorBody	Uma resposta de erro do serviço de contêiner.
IPFamily	Para determinar se o endereço pertence à família IPv4 ou IPv6
Machine	Uma máquina. Contém detalhes sobre a máquina virtual subjacente. Uma máquina pode ser visível aqui, mas não em nós kubectl get; se assim for, pode ser porque a máquina ainda não foi registrada no Kubernetes API Server.
MachineIpAddress	Os detalhes do endereço IP da máquina.
MachineListResult	A resposta da operação Listar Máquinas.
MachineNetworkProperties	Propriedades de rede da máquina
MachineProperties	As propriedades da máquina

CloudError

Object

Uma resposta de erro do serviço de contêiner.

Name	Tipo	Description
error	CloudErrorBody	Detalhes sobre o erro.

CloudErrorBody

Object

Uma resposta de erro do serviço de contêiner.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

IPFamily

Enumeração

Para determinar se o endereço pertence à família IPv4 ou IPv6

Valor	Description
IPv4	Família IPv4
IPv6	Família IPv6

Machine

Object

Uma máquina. Contém detalhes sobre a máquina virtual subjacente. Uma máquina pode ser visível aqui, mas não em nós kubectl get; se assim for, pode ser porque a máquina ainda não foi registrada no Kubernetes API Server.

Name	Tipo	Description
id	string	ID do recurso.
name	string	O nome do recurso que é exclusivo dentro de um grupo de recursos. Esse nome pode ser usado para acessar o recurso.
properties	MachineProperties	As propriedades da máquina
type	string	Tipo de recurso

MachineIpAddress

Object

Os detalhes do endereço IP da máquina.

Name	Tipo	Description
family	IPFamily	Para determinar se o endereço pertence à família IPv4 ou IPv6
ip	string	Endereço IPv4 ou IPv6 da máquina

MachineListResult

Object

A resposta da operação Listar Máquinas.

Name	Tipo	Description
nextLink	string (uri)	A URL para obter o próximo conjunto de resultados da máquina.
value	Machine[]	A lista de Máquinas em cluster.

MachineNetworkProperties

Object

Propriedades de rede da máquina

Name	Tipo	Description
ipAddresses	MachineIpAddress[]	IPv4, endereços IPv6 da máquina

MachineProperties

Object

As propriedades da máquina

Name	Tipo	Description
network	MachineNetworkProperties	Propriedades de rede da máquina
resourceId	string (arm-id)	ID de recurso do Azure da máquina. Ele pode ser usado para GET instância de VM subjacente

Partilhar via

Machines - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

List Machines in an Agentpool by Managed Cluster

Pedido de amostra

Resposta da amostra

Definições

CloudError

CloudErrorBody

IPFamily

Machine

MachineIpAddress

MachineListResult

MachineNetworkProperties

MachineProperties