azure.azcollection.azure_rm_resource_info 模块 – Azure 资源的通用信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 使用 Azure REST API 获取任何资源的 信息。

• 此模块允许访问 Ansible 模块不支持的资源。

• 有关特定资源 REST API 的详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/。

要求

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

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 必须在执行来自 azure.azcollection 的模块的主机上通过 pip 安装集合的 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"
api_version 字符串	要使用的特定 API 版本。
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
log_mode 字符串	父参数。
log_path 字符串	父参数。
method 字符串	请求或响应的 HTTP 方法。必须大写。 选项 "GET" ← (默认) "PUT" "POST" "HEAD" "PATCH" "DELETE" "MERGE"
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
配置文件 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
提供程序 字符串	提供程序类型，如果未提供 URL，则应指定。
资源组 字符串	要使用的资源组。 如果未指定 URL，则为必需。
资源名称 字符串	资源名称。
资源类型 字符串	资源类型。
密钥 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
子资源 列表 / 元素=字典	子资源列表。 默认值: []
名称 字符串	子资源名称。
命名空间 字符串	子资源命名空间。
类型 字符串	子资源类型。
订阅 ID 字符串	您的 Azure 订阅 ID。
标签 字典	用于筛选的标签字典。 字典中的每个键值对都指定一个标签名称及其值，以筛选不同的资源。 默认值: {}
租户 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
指纹 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
URL 字符串	Azure RM 资源 URL。
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。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Get scaleset info
  azure_rm_resource_info:
    resource_group: myResourceGroup
    provider: compute
    resource_type: virtualmachinescalesets
    resource_name: myVmss
    api_version: "2017-12-01"

- name: Query all the resources in the resource group
  azure_rm_resource_info:
    resource_group: "{{ resource_group }}"
    resource_type: resources

- name: Get all snapshots of all resource groups of a subscription but filtering with two tags.
  azure_rm_resource_info:
    provider: compute
    resource_type: snapshots
    tags:
      enviroment: dev
      department: hr

返回值

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

键	描述
响应 复杂	特定于资源类型的响应。 返回: 始终
ID 字符串	Azure 资源的 ID。 返回: 始终 示例: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM"
位置 字符串	资源位置。 返回: 始终 示例: "eastus"
名称 字符串	资源名称。 返回: 始终 示例: "myVM"
属性 复杂	指定虚拟机的属性。 返回: 始终
diagnosticsProfile 复杂	指定启动诊断设置状态。 返回: 始终
bootDiagnostics 字典	一种调试功能，用于查看控制台输出和屏幕截图以诊断 VM 状态。 返回: 始终 示例: {"enabled": true, "storageUri": "https://vxisurgdiag.blob.core.windows.net/"}
hardwareProfile 字典	指定虚拟机的硬件设置。 返回: 始终 示例: {"vmSize": "Standard_D2s_v3"}
networkProfile 复杂	指定虚拟机的网络接口。 返回: 始终
网络接口 列表 / 元素=字符串	描述网络接口引用。 返回: 始终 示例: [{"id": "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441"}]
osProfile 复杂	指定虚拟机的操作系统设置。 返回: 始终
adminUsername 字符串	指定管理员帐户的名称。 返回: 始终 示例: "azureuser"
allowExtensionOperations 布尔值	指定是否应允许在虚拟机上执行扩展操作。 只有在虚拟机上不存在任何扩展时，才能将其设置为 False。 返回: 始终 示例: true
computerName 字符串	指定虚拟机的宿主操作系统名称。 返回: 始终 示例: "myVM"
linuxConfiguration 字典	指定虚拟机上的 Linux 操作系统设置。 返回: 当操作系统类型为 Linux 时 示例: {"disablePasswordAuthentication": false, "provisionVMAgent": true}
requireGuestProvisionSignale 布尔值	指定宿主是否需要来宾预配信号。 返回: 始终 示例: true
机密 列表 / 元素=字符串	指定应安装到虚拟机上的一组证书。 返回: 始终 示例: []
provisioningState 字符串	预配状态。 返回: 始终 示例: "Succeeded"
storageProfile 复杂	指定托管磁盘的存储帐户类型。 返回: 始终
数据磁盘 列表 / 元素=字符串	指定用于向虚拟机添加数据磁盘的参数。 返回: 始终 示例: [{"caching": "None", "createOption": "Attach", "diskSizeGB": 1023, "lun": 2, "managedDisk": {"id": "/subscriptions/xxxx....xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk2", "storageAccountType": "StandardSSD_LRS"}, "name": "testdisk2"}, {"caching": "None", "createOption": "Attach", "diskSizeGB": 1023, "lun": 1, "managedDisk": {"id": "/subscriptions/xxxx...xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk3", "storageAccountType": "StandardSSD_LRS"}, "name": "testdisk3"}]
imageReference 字典	指定有关要使用的映像的信息。 返回: 始终 示例: {"offer": "UbuntuServer", "publisher": "Canonical", "sku": "20_04-lts", "version": "latest"}
osDisk 字典	指定有关虚拟机使用的操作系统磁盘的信息。 返回: 始终 示例: {"caching": "ReadWrite", "createOption": "FromImage", "diskSizeGB": 30, "managedDisk": {"id": "/subscriptions/xxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/disks/myVM_disk1_xxx", "storageAccountType": "Premium_LRS"}, "name": "myVM_disk1_xxx", "osType": "Linux"}
vmID 字符串	指定 VM 唯一 ID，它是一个 128 位标识符，在所有 Azure laaS VM SMBIOS 中进行编码和存储。 可以使用平台 BIOS 命令读取它。 返回: 始终 示例: "eb86d9bb-6725-4787-a487-2e497d5b340c"
类型 字符串	用于虚拟机的身份类型。 返回: 始终 示例: "Microsoft.Compute/virtualMachines"

作者

• Zim Kalinowski (@zikalino)

集合链接

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