azure.azcollection.azure_rm_virtualmachinescaleset_info 模块 – 获取虚拟机规模集事实

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取虚拟机规模集的事实。

  • 请注意，在 Ansible 2.8 之前，此模块称为 azure.azcollection.azure_rm_virtualmachine_scaleset_facts。用法没有改变。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

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"

disable_instance_discovery

布尔值

azure.azcollection 2.3.0 版本中添加

确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← (默认)

  • true

format

字符串

返回数据的格式。

如果选择 raw，则将以 Azure Python SDK 的原始格式返回信息。

如果选择 curated，则结构将与 azure.azcollection.azure_rm_virtualmachinescaleset 模块的输入参数相同。

在 Ansible 2.5 及更低版本中，事实始终以原始格式返回。

请注意，此选项将在 2.10 版本中弃用，届时 curated 格式将成为唯一受支持的格式。

选项

  • "curated"

  • "raw" ← (默认)

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

将结果限制为特定的虚拟机规模集。

password

字符串

Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource_group

字符串

搜索所需虚拟机规模集的资源组。

secret

字符串

Azure 客户端密钥。在使用服务主体进行身份验证时使用。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。格式标签为“键”或“键：值”。

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 中。这是一个包含 [default] 部分以及以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get facts for a virtual machine scale set
  azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    name: testvmss001
    format: curated

- name: Get facts for all virtual networks
  azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    tags:
      - testing

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

vmss

复杂类型

虚拟机规模集列表。

返回：始终返回

admin_username

字符串

创建主机后用于访问主机的管理员用户名。

返回：始终返回

示例： "adminuser"

capacity

整数

VMSS 的容量。

返回：始终返回

示例： 2

data_disks

复杂类型

附加的数据磁盘列表。

返回：始终返回

caching

字符串

数据磁盘缓存类型。

返回：始终返回

示例： "ReadOnly"

disk_size_gb

整数

空白数据磁盘的初始磁盘大小（以 GB 为单位）。

返回：始终返回

示例： 64

lun

整数

数据磁盘的逻辑单元号。

返回：始终返回

示例： 0

managed_disk_type

字符串

托管数据磁盘类型。

返回：始终返回

示例： "Standard_LRS"

id

字符串

资源 ID。

返回：始终返回

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset"

identity

复杂类型

服务器的标识。

返回：如果可用

type

字符串

托管标识的类型

返回：始终返回

示例： "UserAssigned"

user_assigned_identities

复杂类型

用户分配的托管标识及其选项

返回：始终返回

id

字典

与资源关联的用户分配的标识 ID 字典

返回：始终返回

image

复杂类型

镜像规范。

返回：始终返回

字符串

用于虚拟机部署的社区库镜像唯一 ID。

返回：如果从社区库镜像创建

示例： "/CommunityGalleries/yellowbrick-fc7e81f1-87dd-4989-9ca8-03743762e873/Images/Ubuntu-5.15.0-1035-azure_22.04"

id

字符串

自定义镜像资源 ID。

返回：如果从自定义镜像创建

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage"

offer

字符串

用于创建虚拟机的平台镜像或市场镜像的产品。

返回：如果从市场镜像创建

示例： "RHEL"

publisher

字符串

发布者名称。

返回：如果从市场镜像创建

示例： "RedHat"

sku

字符串

SKU 名称。

返回：如果从市场镜像创建

示例： "7-RAW"

version

字符串

镜像版本。

返回：如果从市场镜像创建

示例： "7.5.2018050901"

load_balancer

字符串

负载均衡器名称。

返回：始终返回

示例： "testlb"

location

字符串

资源位置。

返回：始终返回

示例： "japaneast"

managed_disk_type

字符串

托管数据磁盘类型。

返回：始终返回

示例： "Standard_LRS"

name

字符串

资源名称。

返回：始终返回

示例： "myvmss"

orchestrationMode

字符串

虚拟机规模集的编排模式。

返回：始终返回

示例： "Flexible"

os_disk_caching

字符串

操作系统磁盘缓存类型。

返回：始终返回

示例： "ReadOnly"

os_type

字符串

操作系统的基本类型。

返回：始终返回

示例： "Linux"

overprovision

布尔值

指定是否应过度配置虚拟机规模集。

返回：成功

示例： true

platformFaultDomainCount

整数

每个放置组的故障域计数。

返回：始终返回

示例： 1

resource_group

字符串

资源组。

返回：始终返回

示例： "myResourceGroup"

ssh_password_enabled

布尔值

是否启用了 SSH 密码身份验证。仅对 Linux 有效。

返回：始终返回

示例： true

subnet_name

字符串

子网名称。

返回：始终返回

示例： "testsubnet"

tags

字典

分配给资源的标签。字符串：字符串对的字典。

返回：始终返回

示例： {"tag1": "abc"}

tier

字符串

SKU 层次。

返回：始终返回

示例： "Basic"

upgrade_policy

字符串

升级策略。

返回：始终返回

示例： "Manual"

virtual_network_name

字符串

关联的虚拟网络名称。

返回：始终返回

示例： "testvn"

vm_size

字符串

虚拟机大小。

返回：始终返回

示例： "Standard_D4"

作者

  • Sertac Ozercan (@sozercan)