Machines - List

服務:

AKS

API 版本:

2025-03-01

取得指定之代理程式集區中的機器清單。

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

URI 參數

名稱	位於	必要	類型	Description
agentPoolName	path	True	string minLength: 1 maxLength: 12 pattern: ^[a-z][a-z0-9]{0,11}$	代理程式集區的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
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]$	受控叢集資源的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	MachineListResult	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List Machines in an Agentpool by Managed Cluster

範例要求

HTTP

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

Python

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

JavaScript

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

範例回覆

狀態碼:

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"
}

定義

名稱	Description
CloudError	來自容器服務的錯誤回應。
CloudErrorBody	來自容器服務的錯誤回應。
IPFamily	判斷位址是否屬於 IPv4 或 IPv6 系列
Machine	計算機。 包含基礎虛擬機的詳細數據。 計算機可能在這裡可見，但無法在 kubectl 取得節點中顯示;如果是，可能是因為計算機尚未向 Kubernetes API Server 註冊。
MachineIpAddress	計算機IP位址詳細數據。
MachineListResult	清單機器作業的回應。
MachineNetworkProperties	計算機的網路屬性
MachineProperties	機器的屬性

CloudError

Object

來自容器服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	錯誤的詳細數據。

CloudErrorBody

Object

來自容器服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

IPFamily

列舉型別

判斷位址是否屬於 IPv4 或 IPv6 系列

值	Description
IPv4	IPv4 系列
IPv6	IPv6 系列

Machine

Object

計算機。 包含基礎虛擬機的詳細數據。 計算機可能在這裡可見，但無法在 kubectl 取得節點中顯示;如果是，可能是因為計算機尚未向 Kubernetes API Server 註冊。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源群組內唯一的資源名稱。 此名稱可用來存取資源。
properties	MachineProperties	機器的屬性
type	string	資源類型

MachineIpAddress

Object

計算機IP位址詳細數據。

名稱	類型	Description
family	IPFamily	判斷位址是否屬於 IPv4 或 IPv6 系列
ip	string	計算機的 IPv4 或 IPv6 位址

MachineListResult

Object

清單機器作業的回應。

名稱	類型	Description
nextLink	string (uri)	要取得下一組計算機結果的URL。
value	Machine[]	叢集中的機器清單。

MachineNetworkProperties

Object

計算機的網路屬性

名稱	類型	Description
ipAddresses	MachineIpAddress[]	計算機的 IPv4、IPv6 位址

MachineProperties

Object

機器的屬性

名稱	類型	Description
network	MachineNetworkProperties	計算機的網路屬性
resourceId	string (arm-id)	計算機的 Azure 資源識別碼。 它可用來取得基礎 VM 實例