azure.azcollection.azure_rm_vmsku_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_vmsku_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
location 字符串	当前订阅支持的区域。
log_mode 字符串	父参数。
log_path 字符串	父参数。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_type 字符串	资源类型，例如“availabilitySets”、“snapshots”、“disks”等。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
size 字符串	大小名称，接受部分名称。
subscription_id 字符串	您的 Azure 订阅 ID。
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证书的路径。 证书必须附加到私钥。 在使用服务主体进行身份验证时使用。
区域 布尔值	显示支持可用性区域的SKU。 选项 false ← (默认) true

注释

注意

• 对于使用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 VM SKUs
  azure.azcollection.azure_rm_vmsku_info:
    location: "{{ rg_info.resourcegroups.0.location }}"
    resource_type: "virtualMachines"
    size: "standard_B1"
    zone: true
  register: available_skus_result

返回值

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

键	描述
available_skus 复杂的	计算相关资源SKU的列表。 返回：始终
capabilities 复杂的	描述功能的名称值对。 返回：始终
name 字符串	描述功能的不变量。 返回：始终 示例："ultrassdavailable"
value 字符串	如果功能通过数量衡量，则为不变量。 返回：始终 示例："True"
family 字符串	此特定SKU的系列。 返回：始终 示例："standardBSFamily"
location_info 复杂的	SKU 可用的位置和这些位置中的可用性区域列表。 返回：始终
location 字符串	SKU 的位置。 返回：始终 示例："eastus"
zone_details 复杂的	在特定区域中可用于 SKU 的功能的详细信息。 返回：始终
capabilities 复杂的	在指定区域列表中可用于 SKU 的功能列表。 返回：始终
name 字符串	描述功能的不变量。 返回：始终 示例："ultrassdavailable"
value 字符串	如果功能通过数量衡量，则为不变量。 返回：始终 示例："True"
zones 列表 / 元素=字符串	支持 SKU 的可用性区域列表。 返回：始终 示例：["1", "2", "3"]
locations 列表 / 元素=字符串	SKU 可用的位置集。 返回：始终 示例：["eastus"]
name 字符串	SKU 的名称。 返回：始终 示例："Standard_B1s"
resource_type 字符串	SKU 应用到的资源类型。 返回：始终 示例："virtual_machine"
restrictions 复杂的	由于哪些原因导致无法使用SKU的限制。如果没有限制，则为空。 返回：始终
reason_code 字符串	限制的原因。 返回：成功 示例："QuotaId"
restriction_info 复杂的	有关无法使用 SKU 的限制的信息。 返回：始终
locations 列表 / 元素=字符串	SKU 受限的位置。 返回：成功 示例：["location"]
zones 列表 / 元素=字符串	SKU 受限的可用性区域列表。 返回：成功 示例：["1", "2"]
type 字符串	限制的类型。 返回：始终 示例："location"
values 字符串	限制的值。如果限制类型设置为位置。这将是 SKU 受限的不同位置。 返回：始终 示例："['eastus']"
size 字符串	SKU 的大小。 返回：始终 示例："B1s"
tier 字符串	指定规模集中的虚拟机的层。 返回：始终 示例："Standard"

作者

• Nir Argaman (@nirarg)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）