azure.azcollection.azure_rm_iotdevice 模块 – 管理 Azure IoT 中心设备

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

• 创建和删除 Azure IoT 中心设备。

要求

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

• 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"
append_tags 布尔值	用于控制标签字段是规范的还是只是附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项 false true ← (默认)
auth_method 字符串	要使用其创建实体的授权类型。 选项 "sas" ← (默认) "certificate_authority" "self_signed"
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"
desired 字典	与报告的属性一起使用，以同步设备配置或状态。 标签可以是嵌套字典，键中不允许使用 ‘.’、’$’、’#’、’ '。 不支持列表。 在使用基本层的 IoT Hub 中不支持。
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 版本中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从https://login.microsoft.com/检索权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或环境变量 AZURE_DISABLE_INSTANCE_DISCOVERY 设置。 选项 false ← (默认) true
edge_enabled 布尔值	指示边缘启用状态的标志。 在使用基本层的 IoT Hub 中不支持。 选项 false true
hub 字符串 / 必需	IoT Hub 的名称。
hub_policy_key 字符串 / 必需	hub_policy_name 的密钥。
hub_policy_name 字符串 / 必需	将用于从 IoT Hub 查询的 IoT Hub 的策略名称。 此策略应具有“RegistryWrite、ServiceConnect、DeviceConnect”访问权限。缺少任何权限都可能导致 401 错误。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	IoT Hub 设备标识的名称。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
primary_key 别名：primary_thumbprint 字符串	用于主密钥的显式自签名证书指纹。 用于主密钥的显式共享私钥。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
secondary_key 别名：secondary_thumbprint 字符串	用于辅助密钥的显式自签名证书指纹。 用于辅助密钥的显式共享私钥。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
state 字符串	IoT Hub 的状态。使用 present 创建或更新 IoT Hub 设备，使用 absent 删除 IoT Hub 设备。 选项 "absent" "present" ← (默认)
status 布尔值	创建时设置设备状态。 选项 false true
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*，则需要此参数。
twin_tags 字典	解决方案后端可以从中读取和写入的部分。 设备应用程序无法看到这些标签。 标签可以是嵌套字典，键中不允许使用 ‘.’、’$’、’#’、’ '。 不支持列表。 在使用基本层的 IoT Hub 中不支持。
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 simplest Azure IoT Hub device
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    primary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    secondary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

- name: Create Azure IoT Edge device
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    primary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    secondary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    edge_enabled: true

- name: Create Azure IoT Hub device with device twin properties and tag
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    primary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    secondary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    twin_tags:
      location:
        country: US
        city: Redmond
      sensor: humidity
    desired:
      period: 100

返回值

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

键

描述

device 字典

IoT Hub 设备。 返回值： 始终返回 示例： {"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "capabilities": {"iotEdge": false}, "changed": true, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "Testing", "etag": "NzA2NjU2ODc=", "failed": false, "generationId": "636903014505613307", "lastActivityTime": "0001-01-01T00:00:00", "modules": [{"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "testdevice", "etag": "MjgxOTE5ODE4", "generationId": "636903840872788074", "lastActivityTime": "0001-01-01T00:00:00", "managedBy": null, "moduleId": "test"}], "properties": {"desired": {"$metadata": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8, "period": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8}}, "$version": 1, "period": 100}, "reported": {"$metadata": {"$lastUpdated": "2019-04-08T06:24:10.5613307Z"}, "$version": 1}}, "status": "enabled", "statusReason": null, "statusUpdatedTime": "0001-01-01T00:00:00", "tags": {"location": {"city": "Redmond", "country": "us"}, "sensor": "humidity"}}

作者

• 周雨薇 (@yuwzho)

收藏链接

• 问题追踪器
• 主页
• 代码仓库