azure.azcollection.azure_rm_aksagentpool_info 模块 – 显示托管 Kubernetes 集群中节点池的详细信息

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_aksagentpool_info。

azure.azcollection 1.14.0 中的新增功能

概要

• 获取托管 Kubernetes 集群中节点池的详细信息。

要求

执行此模块的主机需要以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

• 完整的安装说明可在https://galaxy.ansible.com/azure/azcollection中找到

参数

参数	注释
ad_user 字符串	Active Directory 用户名。使用 Active Directory 用户而非服务主体进行身份验证时使用。
adfs_authority_url 字符串 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。使用用户名/密码进行身份验证时，并具有您自己的 ADFS 授权时使用。
api_profile 字符串 在 azure.azcollection 0.0.1 中添加	选择在与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
auth_source 字符串 在 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据的来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。 设置为 env 时，凭据将从环境变量中读取 设置为 credential_file 时，它将从 ~/.azure/credentials 中读取配置文件。 设置为 cli 时，凭据将从 Azure CLI 配置文件中获取。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。 设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果该资源被授予对多个订阅的访问权限），否则将选择第一个订阅。 msi 在 Ansible 2.6 中添加。 选项 "auto" ←（默认） "cli" "credential_file" "env" "msi"
cert_validation_mode 字符串 在 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 "ignore" "validate"
client_id 字符串	Azure 客户端 ID。使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，可以使用环境名称（由 Azure Python SDK 定义，例如，AzureChinaCloud，AzureUSGovernment），或者元数据发现终结点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
cluster_name 字符串 / 必需	群集名称。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 中检索授权元数据以验证授权。通过将此项设置为 **True**，将禁用授权验证。因此，至关重要的是要确保配置的授权主机是有效且可信的。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← （默认） true
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串	节点池名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端机密。当使用服务主体进行身份验证时使用。
subscription_id 字符串	你的 Azure 订阅 ID。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	在 *x509_certificate_path* 中指定的私钥指纹。 当使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则为必需。
x509_certificate_path 路径 在 azure.azcollection 1.14.0 中添加	PEM 格式用于创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 当使用服务主体进行身份验证时使用。

备注

注意

• 对于 Azure 身份验证，你可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 playbook 之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，可以将凭据存储在 ~/.azure/credentials 中。这是一个 ini 文件，其中包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get node agent pool by cluster name
  azure_rm_aksagentpool_info:
    resource_group: myRG
    cluster_name: testcluster

- name: Get node agent pool by name
  azure_rm_aksagentpool_info:
    resource_group: myRG
    cluster_name: testcluster
    name: default

返回值

通用返回值在此处记录 此处，以下是此模块独有的字段

键	描述
aks_agent_pools 复杂	托管 Kubernetes 群集中节点池的详细信息。 返回值： 始终
availability_zones 列表 / 元素=字符串	节点的可用性区域。必须使用 VirtualMachineScaleSets AgentPoolType。 返回值： 始终 示例： [1, 2]
cluster_name 字符串	群集名称。 返回值： 始终 示例： "testcluster"
count 整数	用于托管 docker 容器的代理（VM）的数量。 返回值： 始终 示例： 2
enable_auto_scaling 布尔值	是否启用自动缩放器。 返回值： 始终
enable_encryption_at_host 布尔值	仅在某些 VM 大小和某些 Azure 区域中支持此功能。 返回值： 始终 示例： false
enable_node_public_ip 布尔值	为节点启用公用 IP。 返回值： 始终 示例： true
enable_ultra_ssd 布尔值	是否启用 FIPS 节点池。 返回值： 始终 示例： false
gpu_instance_profile 字符串	GPUInstanceProfile 用于指定支持的 GPU VM SKU 的 GPU MIG 实例配置文件。 返回值： 始终 示例： "MIG1g"
id 字符串	资源 ID。 返回值： 始终 示例： "/subscriptions/xxx-xxxf/resourcegroups/myRG/providers/Microsoft.ContainerService/managedClusters/cluster/agentPools/default"
kubelet_config 字典	代理池节点上的 Kubelet 配置。 返回值： 始终 示例： {"cpu_cfs_quota": true, "cpu_cfs_quota_period": "100ms", "cpu_manager_policy": "static", "fail_swap_on": false, "image_gc_high_threshold": 85, "image_gc_low_threshold": 80, "topology_manager_policy": "none"}
kubelet_disk_type 字符串	确定 emptyDir 卷、容器运行时数据根和 Kubelet 临时存储的位置。 返回值： 始终 示例： "OS"
linux_os_config 字典	Linux 代理节点的操作系统配置。 返回值： 始终 示例： {"swap_file_size_mb": 1500, "sysctls": {}, "transparent_huge_page_defrag": "defer+madvise", "transparent_huge_page_enabled": "madvise"}
max_count 整数	自动缩放的最大节点数。 返回值： 始终 示例： 10
max_pods 整数	一个节点上可以运行的最大 pod 数。 返回值： 始终 示例： 42
min_count 整数	自动缩放的最小节点数。 返回值： 始终 示例： 1
mode 字符串	AgentPoolMode 表示代理池的模式。 返回值： 始终 示例： "System"
name 字符串	资源名称。 返回值： 始终 示例： "default"
node_image_version 字符串	节点映像的版本。 返回值： 始终 示例： "AKSUbuntu-1804gen2containerd-2022.08.23"
node_labels 列表 / 元素=字符串	在代理池中的所有节点上持久化的代理池节点标签。 返回值： 始终 示例： [{"release": "stable"}]
node_public_ip_prefix_id 字符串	Azure 公用 IP 前缀的 ID。 返回值： 始终
node_taints 列表 / 元素=字符串	在节点池创建和缩放期间添加到新节点的污点。 返回值： 始终 示例： ["CriticalAddonsOnly=false:NoSchedule"]
orchestrator_version 字符串	创建托管群集时指定的编排器版本。 返回值： 始终 示例： "1.22.11"
os_disk_size_gb 整数	OS 磁盘大小（以 GB 为单位），用于指定此主代理池中每台计算机的磁盘大小。 返回值： 始终 示例： 128
os_sku 字符串	OS SKU 用于指定 OS 类型。 返回值： 始终 示例： "Windows2022"
os_type 字符串	OsType 用于指定 OS 类型。 返回值： 始终 示例： "Linux"
power_state 字典	代理池的电源状态。 返回值： 始终 示例： {"code": "Running"}
provisioning_state 字符串	当前部署或预配状态，仅显示在响应中。 返回值： 始终 示例: "Succeeded"
proximity_placement_group_id 字符串	用于邻近放置组的 ID。 返回值： 始终 示例: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/proximityPlacementGroups/proxi01"
resource_group 字符串	资源组名称。 返回值： 始终 示例: "myRG"
scale_down_mode 字符串	这也会影响集群自动缩放器的行为。 返回值： 始终 示例: "Delete"
scale_set_eviction_policy 字符串	ScaleSetEvictionPolicy，用于指定 Spot 虚拟机规模集的驱逐策略。 返回值： 始终
scale_set_priority 字符串	ScaleSetPriority，用于指定虚拟机规模集的优先级。 返回值： 始终
security_profile 复杂	代理池的安全设置。 返回: success
enable_secure_boot 布尔值	是否启用安全启动。 返回值： 始终 示例： true
enable_vtpm 布尔值	是否启用 vTPM。 返回值： 始终 示例： true
spot_max_price 浮点数	SpotMaxPrice，用于指定您愿意支付的最高美元价格。 返回值： 始终
tags 字典	节点代理池的标签。 返回值： 始终 示例: {"key1": "value1", "key2": "value2"}
type 字符串	资源类型。 返回值： 始终 示例: "Microsoft.ContainerService/managedClusters/agentPools"
type_properties_type 字符串	AgentPoolType 表示代理池的类型。 返回值： 始终 示例: "VirtualMachineScaleSets"
upgrade_settings 字符串	用于升级代理池的设置。 返回值： 始终
vm_size 字符串	代理 VM 的大小。 返回值： 始终 示例: "Standard_B2s"
vnet_subnet_id 字符串	VNet SubnetID 指定 VNet 的子网标识符。 返回值： 始终
workload_runtime 字符串	确定节点可以运行的工作负载类型。 返回值： 始终 示例: "OCIContainer"

作者

• xuzhang3 (@xuzhang3)

• Fred Sun (@Fred-sun)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）