azure.azcollection.azure_rm_image 模块 – 管理 Azure 镜像

注意

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

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

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

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

azure.azcollection 0.0.1 中的新增功能

概要

  • 创建、删除来自虚拟机、blob uri、托管磁盘或快照的镜像。

要求

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

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

append_tags

布尔值

用于控制标签字段是规范的还是只是追加到现有标签。

如果规范，则在 tags 参数中找不到的任何标签都将从对象的元数据中删除。

选项

  • false

  • true ← (默认)

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"

data_disk_sources

列表 / 元素=字符串

数据磁盘源列表，包括非托管 Blob URI、托管磁盘 ID 或名称，或快照 ID 或名称。

默认值： []

disable_instance_discovery

布尔值

azure.azcollection 2.3.0 版本中新增

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

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

选项

  • false ← (默认)

  • true

hyper_v_generation

字符串

指定从映像创建的虚拟机的 HyperVGenerationType。

选项

  • "V1"

  • "V2"

location

字符串

映像的位置。如果未指定，则从 resource_group 派生。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必填

映像的名称。

os_type

字符串

映像的操作系统类型。

选项

  • "Windows"

  • "Linux"

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必填

资源组的名称。

secret

字符串

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

source

任意

来自同一区域的操作系统磁盘源。

它可以是虚拟机、操作系统磁盘 Blob URI、托管操作系统磁盘或操作系统快照。

除了 Blob URI 之外的每种源类型都可以作为资源 ID、名称或包含 resource_group、name 和 type 的字典给出。

如果源类型是 Blob URI，则源应为字符串类型的 Blob 的完整 URI。

如果在字典中指定 type，则可接受的值包含 disks、virtual_machines 和 snapshots。

state

字符串

声明映像的状态。使用 present 创建或更新映像，使用 absent 删除映像。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

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

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

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

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

Azure 前端门户不支持使用

Azure 自动化和 Azure CDN 资源上只支持 15 个标签。

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 中的配置文件，或者在运行任务或剧本之前使用 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: Create an image from a virtual machine
  azure_rm_image:
    resource_group: myResourceGroup
    name: myImage
    source: myVirtualMachine

- name: Create an image from os disk
  azure_rm_image:
    resource_group: myResourceGroup
    name: myImage
    source: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Compute/disks/disk001
    data_disk_sources:
      - datadisk001
      - datadisk002
    os_type: Linux

- name: Create an image from os disk via dict
  azure_rm_image:
    resource_group: myResourceGroup
    name: myImage
    source:
      type: disks
      resource_group: myResourceGroup
      name: disk001
    data_disk_sources:
      - datadisk001
      - datadisk002
    os_type: Linux

- name: Delete an image
  azure_rm_image:
    state: absent
    resource_group: myResourceGroup
    name: myImage
    source: testvm001

返回值

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

键

描述

id

字符串

映像资源路径。

返回： 成功

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

作者

  • 周宇薇 (@yuwzho)