azure.azcollection.azure_rm_imagesku_info 模块 – 获取与计算相关的镜像 SKU 列表

注意

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

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

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

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

azure.azcollection 2.4.0 中的新增功能

概要 

获取与计算相关的资源镜像 SKU 的详细信息。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 中模块的主机上
完整的安装说明可在 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，否则选择第一个订阅。 Ansible 2.6 中添加了 `msi`。选项 `"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`
位置字符串	当前订阅支持的区域。
日志模式字符串	父参数。
日志路径字符串	父参数。
产品字符串	“产品”指的是操作系统的特定产品线或软件。产品通常包含多个版本的或配置的产品。
密码字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
发布者字符串	“发布者”是提供操作系统映像的实体。它可能是 Microsoft、Canonical（对于 Ubuntu）、Red Hat 等。这是一个必填字段，用于标识映像提供商。
密钥字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
订阅 ID 字符串	您的 Azure 订阅 ID。
租户字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
指纹字符串 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: Gather Resource Group info
  azure.azcollection.azure_rm_resourcegroup_info:
    name: "{{ resource_group }}"
  register: rg_info

- name: List available Image SKUs for 0001-com-ubuntu-server-focal
  azure.azcollection.azure_rm_imagesku_info:
    location: westus
    offer: 0001-com-ubuntu-server-focal
    publisher: Canonical
  register: available_image_skus_results

返回值 

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

键	描述
available_skus 复杂	用于配置虚拟机的 Azure 映像 SKU 列表。返回：始终
automatic_os_upgrade_supported 布尔值	此 SKU 是否支持自动操作系统升级。返回：始终示例： `false`
id 字符串	SKU 的完整 Azure 资源 ID。返回：始终示例： `"0001-com-ubuntu-server-focal/Skus/20_04-lts"`
位置字符串	SKU 可用的 Azure 区域。返回：始终示例： `"westus"`
名称字符串	特定的 SKU 名称或版本。返回：始终示例： `"20_04-lts"`
限制复杂	可能适用于使用此映像 SKU 的限制，例如区域限制或功能不兼容。返回：始终
原因代码字符串	限制的原因，例如配额限制或特定硬件要求。返回：成功示例： `"NotSupported"`
限制信息复杂	有关限制的附加信息，例如不受支持的区域或功能。返回：始终
位置列表 / 元素=字符串	此 SKU 受限或不可用的位置。返回：成功示例： `["eastus"]`
区域列表 / 元素=字符串	此 SKU 受限的区域内的可用性区域。返回：成功示例： `["1", "2"]`
类型字符串	限制的类型，可能包括基于位置的限制或硬件兼容性问题。返回：始终示例： `"location"`
值列表 / 元素=字符串	受限位置、区域或区域的列表，在这些位置、区域或区域中无法使用映像 SKU。返回：始终示例： `["eastus", "westeurope"]`

作者

Hen Yaish (@hyaish)