azure.azcollection.azure_rm_devtestlabvirtualmachine 模块 – 管理 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。

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 授权时使用。

allow_claim

字符串

指示另一个用户是否可以获取虚拟机的所有权。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公有云；将来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

append_tags

布尔值

用于控制 tags 字段是规范的还是仅附加到现有标签。

当为规范时，在 tags 参数中找不到的任何标签将从对象的元数据中删除。

选择

  • false

  • true ←（默认）

artifacts

列表 / 元素=字典

要在虚拟机上安装的工件。

parameters

列表 / 元素=字典

工件的参数。

name

字符串

工件参数的名称。

value

字符串

工件参数的值。

source_name

字符串

工件的源名称。

source_path

字符串

工件在源存储库中的路径。

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

disallow_public_ip_address

字符串

指示是否在不使用公共 IP 地址的情况下创建虚拟机。

expiration_date

字符串

虚拟机的过期日期。

image

dictionary

虚拟机的 Microsoft Azure Marketplace 映像引用。

offer

字符串

库映像的产品/服务。

os_type

字符串

库映像的操作系统类型。

publisher

字符串

库映像的发布者。

sku

字符串

库映像的 SKU。

version

字符串

库映像的版本。

is_authentication_with_ssh_key

布尔值

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

当为 ssh 身份验证设置 ssh_key 时，is_authentication_with_ssh_key=True。

选择

  • false

  • true

lab_name

string / required

实验室的名称。

lab_subnet

any

实验室虚拟网络中的现有子网。

它可以是子网的资源 ID。

它可以是一个包含 virtual_network_name 和 name 的字典。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

string / required

虚拟机的名称。

notes

字符串

虚拟机的备注。

os_type

字符串

操作系统的基本类型。

选择

  • "windows"

  • "linux"

password

字符串

虚拟机管理员的密码。

profile

字符串

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

resource_group

string / required

资源组的名称。

secret

字符串

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

ssh_key

字符串

虚拟机管理员的 SSH 密钥。

state

字符串

声明虚拟机的状态。

使用 present 创建或更新虚拟机，使用 absent 删除它。

选择

  • "absent"

  • "present" ← (默认)

storage_type

字符串

用于虚拟机的存储类型。

选择

  • "standard"

  • "premium"

subscription_id

字符串

您的 Azure 订阅 ID。

tags

dictionary

要作为元数据分配给对象的字符串:字符串对的字典。

对象的元数据标记将使用任何提供的值进行更新。

要删除标记，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

在通过服务主体进行身份验证时使用。

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

user_name

字符串

虚拟机的用户名。

vm_size

字符串

有效的 Azure VM 大小值。例如，Standard_D4。

选择列表因订阅和位置而异。检查您的订阅以获取可用选项。

可用值可以在此网站上找到，链接 https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general。

当 state=present 时为必需项。

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 和密码，或者在环境中设置 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: Create (or update) Virtual Machine
  azure_rm_devtestlabvirtualmachine:
    resource_group: myrg
    lab_name: mylab
    name: myvm
    notes: Virtual machine notes....
    os_type: linux
    vm_size: Standard_A2_v2
    user_name: vmadmin
    password: "{{ password }}"
    lab_subnet:
      name: myvnSubnet
      virtual_network_name: myvn
    disallow_public_ip_address: false
    image:
      offer: 0001-com-ubuntu-server-focal
      publisher: Canonical
      sku: 20_04-lts
      os_type: Linux
      version: latest
    artifacts:
      - source_name: myartifact
        source_path: "/Artifacts/linux-install-mongodb"
    allow_claim: false
    expiration_date: "2019-02-22T01:49:12.117974Z"

返回值

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

Key

描述

compute_id

字符串

基础计算虚拟机资源的标识符。

返回: 总是

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm"

fqdn

字符串

虚拟机的完全限定域名或 IP 地址。

返回: 总是

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

id

字符串

DTL 虚拟机资源的标识符。

返回: 总是

示例: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm"

作者

  • Zim Kalinowski (@zikalino)