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 集合

• 集合 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"
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（如果存在多个），否则使用默认的 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 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
provider 字符串	提供程序类型，如果未提供 URL，则应指定。
resource_group 字符串	要使用的资源组。 如果未指定 URL，则为必填项。
resource_name 字符串	资源名称。
resource_type 字符串	资源类型。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
subresource 列表 / 元素=字典	子资源列表。 默认： []
name 字符串	子资源名称。
namespace 字符串	子资源命名空间。
type 字符串	子资源类型。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	用于过滤的标签字典。 字典中的每个键值对指定一个标签名称及其值，用于过滤不同的资源。 默认： {}
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 新增于 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 中的配置文件，或在运行任务或剧本之前使用 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: 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

返回值

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

键	描述
response 复杂类型	特定于资源类型的响应。 返回：始终
id 字符串	Azure 资源的 ID。 返回：始终 示例： "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM"
location 字符串	资源位置。 返回：始终 示例： "eastus"
name 字符串	资源名称。 返回：始终 示例： "myVM"
properties 复杂类型	指定虚拟机的属性。 返回：始终
diagnosticsProfile 复杂类型	指定引导诊断设置状态。 返回：始终
bootDiagnostics 字典	一个调试功能，用于查看控制台输出和屏幕截图以诊断虚拟机状态。 返回：始终 示例： {"enabled": true, "storageUri": "https://vxisurgdiag.blob.core.windows.net/"}
hardwareProfile 字典	指定虚拟机的硬件设置。 返回：始终 示例： {"vmSize": "Standard_D2s_v3"}
networkProfile 复杂类型	指定虚拟机的网络接口。 返回：始终
networkInterfaces 列表 / 元素=字符串	描述网络接口引用。 返回：始终 示例： [{"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
secrets 列表 / 元素=字符串	指定应安装到虚拟机上的证书集。 返回：始终 示例： []
provisioningState 字符串	预配状态。 返回：始终 示例： "Succeeded"
storageProfile 复杂类型	指定托管磁盘的存储帐户类型。 返回：始终
dataDisks 列表 / 元素=字符串	指定用于向虚拟机添加数据磁盘的参数。 返回：始终 示例： [{"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"
type 字符串	虚拟机使用的身份类型。 返回：始终 示例： "Microsoft.Compute/virtualMachines"

作者

• Zim Kalinowski (@zikalino)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)