azure.azcollection.azure_rm_virtualmachine_info 模块 – 获取虚拟机信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 了解详情。

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_virtualmachine_info。

azure.azcollection 0.1.2 中的新功能

概要

  • 获取资源组中一个或所有虚拟机的详细信息。

要求

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

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

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。

tags

list / elements=string

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

tenant

字符串

Azure 租户 ID。当使用服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

当使用服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必需项。

x509_certificate_path

path

在 azure.azcollection 1.14.0 中添加

用于以 PEM 格式创建服务主体的 X509 证书的路径。

证书必须附加到私钥。

当使用服务主体进行身份验证时使用。

备注

注意

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

  • 还可以使用服务主体或 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 all virtual machines of a resource group
  azure_rm_virtualmachine_info:
    resource_group: myResourceGroup

- name: Get facts by name
  azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    name: myVm

- name: Get facts by tags
  azure_rm_virtualmachine_info:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

返回值

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

Key

描述

vms

complex

虚拟机列表。

返回: 始终

additional_capabilities

dictionary

启用或禁用虚拟机上的功能。

返回: 始终

示例: {"ultra_ssd_enabled": false}

admin_username

字符串

管理员用户名。

返回: 始终

示例: "admin"

boot_diagnostics

complex

有关启动诊断设置的信息。

返回: 始终

console_screenshot_uri

字符串

包含用于抓取控制台屏幕截图的 URI。

仅在启用时显示。

返回: 始终

示例: "https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp"

enabled

布尔值

指示是否启用启动诊断。

返回: 始终

示例: true

serial_console_log_uri

字符串

包含用于抓取串行控制台日志的 URI。

仅在启用时显示。

返回: 始终

示例: "https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log"

storage_uri

字符串

指示启动诊断使用的存储帐户。

返回: 始终

示例: "https://mystorageaccountname.blob.core.windows.net/"

CapacityReservation

dictionary

要关联的容量预留组的名称或 ID。

返回: 始终

示例: {}

data_disks

complex

附加的数据磁盘列表。

返回: 始终

caching

字符串

数据磁盘缓存类型。

返回: 始终

示例: "ReadOnly"

disk_size_gb

integer

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

返回: 始终

示例: 64

lun

integer

数据磁盘的逻辑单元号。

返回: 始终

示例: 0

managed_disk_id

字符串

托管数据磁盘 ID。

返回: 始终

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Compute/disks/diskName"

managed_disk_type

字符串

托管数据磁盘类型。

返回: 始终

示例: "Standard_LRS"

display_status

字符串

状态的简短可本地化标签。

返回: 始终

示例: "VM running"

id

字符串

资源 ID。

返回: 始终

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm"

idenity

dictionary

虚拟机的标识。

返回: 始终

示例: {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned, UserAssigned", "user_assigned_identities": {"/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test": {"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}

image

complex

映像规范。

返回: 始终

字符串

用于虚拟机部署的社区库映像唯一 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"

location

字符串

资源位置。

返回: 始终

示例: "japaneast"

name

字符串

资源名称。

返回: 始终

示例: "myVm"

network_interface_names

list / elements=string

附加的网络接口列表。

返回: 始终

示例: ["myNetworkInterface"]

os_disk_caching

字符串

OS 磁盘缓存类型。

返回: 始终

示例: "ReadOnly"

os_type

字符串

操作系统的基本类型。

返回: 始终

示例: "Linux"

power_state

字符串

虚拟机的电源状态。

返回: 始终

示例: "running"

provisioning_state

字符串

预配状态，仅在响应中显示。

返回: 始终

示例: "running"

proximityPlacementGroup

dictionary

虚拟机应关联的邻近放置组的名称或 ID。

返回: 始终

示例: {"id": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Compute/proximityPlacementGroups/testid13"}

resource_group

字符串

资源组。

返回: 始终

示例: "myResourceGroup"

security_profile

complex

指定虚拟机安全相关的配置文件设置。

返回: 当使用时

encryption_at_host

布尔值

用户可以在请求中使用此属性来启用或禁用虚拟机的主机加密。

这将启用主机本身所有磁盘（包括资源/临时磁盘）的加密。

返回: 当启用时

示例: true

security_type

字符串

指定虚拟机的 SecurityType。

设置为 TrustedLaunch 以启用 UefiSettings。

返回: 当启用时

示例: "TrustedLaunch"

uefi_settings

complex

指定创建虚拟机时使用的安全设置，如安全启动和 vTPM。

返回: 当启用时

secure_boot_enabled

布尔值

指定是否应在虚拟机上启用安全启动。

返回: 当启用时

示例: true

v_tpm_enabled

布尔值

指定是否应在虚拟机上启用 vTPM。

返回: 当启用时

示例: true

state

字符串

资源的状态。

返回: 始终

示例: "present"

tags

dictionary

资源标签。

返回: 始终

示例: {"key1": "value1"}

vm_agent_version

字符串

虚拟机内部运行的 Azure VM 代理 (waagent) 的版本。

返回: 始终

示例: "2.9.1.1"

vm_size

字符串

虚拟机大小。

返回: 始终

示例: "Standard_D4"

zones

list / elements=string

虚拟机的可用区列表。

返回: 成功

示例: [1]

作者

  • Gustavo Muniz do Carmo (@gustavomcarmo)

  • Zim Kalinowski (@zikalino)