azure.azcollection.azure_rm_devtestlabvirtualmachine_info 模块 – 获取 Azure DevTest Lab 虚拟机信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新功能

概要

  • 获取 Azure DevTest Lab 虚拟机的详细信息。

要求

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

  • 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 （如果存在多个订阅 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

lab_name

字符串 / 必选

实验室的名称。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

虚拟机的名称。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必选

资源组的名称。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。将标签格式化为 ‘key’ 或 ‘key:value’。

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 instance of DTL Virtual Machine
  azure_rm_devtestlabvirtualmachine_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myVm
    tags:
      - key:value

返回值

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

键

描述

virtualmachines

复杂类型

包含 DevTest Lab 虚拟机事实的字典列表。

返回: 总是

compute_vm_id

字符串

计算虚拟机的资源 ID。

返回: 总是

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

compute_vm_name

字符串

计算虚拟机的名称。

返回: 总是

示例: "myVm"

compute_vm_resource_group

字符串

创建计算虚拟机的资源组。

返回: 总是

示例: "myLab-myVm-097933"

disallow_public_ip_address

布尔值

是否不允许使用公共 IP。

返回: 总是

示例: false

expiration_date

字符串

虚拟机的到期日期。

返回: 总是

示例: "2029-02-22T01:49:12.117974Z"

fqdn

字符串

完全限定的域名。

返回: 总是

示例: "myvm.eastus.cloudapp.azure.com"

id

字符串

虚拟机的标识符。

返回: 总是

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm"

image

复杂类型

图库映像引用。

返回: 总是

offer

字符串

图库映像的提供项。

返回: 从图库映像创建时

示例: "UbuntuServer"

os_type

字符串

操作系统类型。

返回: 从图库映像创建时

示例: "Linux"

publisher

字符串

图库映像的发布者。

返回: 从图库映像创建时

示例: "Canonical"

sku

字符串

图库映像的 SKU。

返回: 从图库映像创建时

示例: "20_04-lts"

version

字符串

图库映像的版本。

返回: 从图库映像创建时

示例: "latest"

is_authentication_with_ssh_key

布尔值

指示此虚拟机是否使用 SSH 密钥进行身份验证。

返回: 总是

示例: false

lab_name

字符串

实验室的名称。

返回: 总是

示例: "myLab"

name

字符串

虚拟机的名称。

返回: 总是

示例: "myVm"

notes

字符串

虚拟机的注释。

返回: 总是

示例: "My VM notes"

os_type

字符串

操作系统类型。

返回: 总是

示例: "linux"

provisioning_state

字符串

虚拟网络的预配状态。

返回: 总是

示例: "Succeeded"

resource_group

字符串

资源组的名称。

返回: 总是

示例: "myResourceGroup"

storage_type

字符串

用于虚拟机的存储类型。

返回: 总是

示例: "standard"

tags

字典

资源的标签。

返回: 总是

示例: {"foo": "bar"}

user_name

字符串

管理员用户名。

返回: 总是

示例: "dtl_admin"

vm_size

字符串

虚拟机大小。

返回: 总是

示例: "Standard_A2_v2"

作者

  • Zim Kalinowski (@zikalino)