azure.azcollection.azure_rm_iothub_info 模块 – 获取 IoT Hub 事实信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取特定 IoT Hub 或所有 IoT Hub 的事实信息。

要求

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

  • 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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

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

list_consumer_groups

布尔值

列出内置事件中心的使用者组。

选项

  • false

  • true

list_keys

布尔值

列出 IoT Hub 的密钥。

请注意，这将对每个 IoT Hub 产生网络开销。

选项

  • false

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

将结果限制到特定的资源组。

password

字符串

Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到安全配置文件。

资源组

字符串

搜索所需 IoT 中心所在的资源组。

密钥

字符串

Azure 客户端密钥。使用服务主体进行身份验证时使用。

show_endpoint_health

布尔值

获取路由端点的健康状况。

请注意，这将对每个 IoT Hub 产生网络开销。

选项

  • false

  • true

show_quota_metrics

布尔值

获取 IoT 中心的配额指标。

请注意，这将对每个 IoT Hub 产生网络开销。

选项

  • false

  • true

show_stats

布尔值

显示 IoT 中心的统计信息。

请注意，这将对每个 IoT Hub 产生网络开销。

选项

  • false

  • true

订阅 ID

字符串

您的 Azure 订阅 ID。

标签

列表 / 元素=字符串

通过提供标签列表来限制结果。标签格式为“键”或“键:值”。

租户

字符串

Azure 租户 ID。使用服务主体进行身份验证时使用。

test_route_message

字符串

测试路由消息。它将用于测试所有路由。

指纹

字符串

在 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: Get facts for one IoT Hub
  azure_rm_iothub_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all IoT Hubs
  azure_rm_iothub_info:

- name: Get facts for all IoT Hubs in a specific resource group
  azure_rm_iothub_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_iothub_info:
    tags:
      - testing

返回值

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

键

描述

azure_iothubs

复杂类型

IoT 中心字典列表。

返回值：始终返回

cloud_to_device

复杂类型

云到设备消息属性。

返回值：始终返回

max_delivery_count

整数

IoT 中心尝试在反馈队列中传递消息的次数。

请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。

返回值：始终返回

示例： 10

ttl_as_iso8601

字符串

消息在被 IoT 中心过期之前可供使用的时间段。

请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages。

返回值：始终返回

示例： "1:00:00"

enable_file_upload_notifications

字符串

是否启用文件上传通知。

返回值：始终返回

示例： "True"

event_endpoints

复杂类型

用于传递设备消息的内置端点。

返回值：始终返回

端点

字符串

与事件中心兼容的端点。

返回值：始终返回

示例： "sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/"

partition_count

整数

在与事件中心兼容的端点中接收设备到云消息的分区数。

请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages。

返回值：始终返回

示例： 2

partition_ids

列表 / 元素=字符串

事件端点的分区 ID 列表。

返回值：始终返回

示例： ["0", "1"]

retention_time_in_days

整数

设备到云消息的保留时间（天）。

请参阅 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages。

返回值：始终返回

示例： 1

host_name

字符串

IoT 中心的主机。

返回值：始终返回

示例： "testing.azure-devices.net"

id

字符串

IoT 中心的资源 ID。

返回值：始终返回

示例： "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing"

identity

复杂类型

服务器的身份。

返回值：如果可用则返回

type

字符串

托管身份的类型

返回值：始终返回

示例： "UserAssigned"

user_assigned_identities

复杂类型

用户分配的托管身份及其选项

返回值：始终返回

id

字典

与资源关联的用户分配身份 ID 字典

返回值：始终返回

ip_filters

复杂类型

配置规则，用于拒绝或接受来自特定 IPv4 地址的流量。

返回值：始终返回

action

字符串

此规则捕获的请求所需的操作。

返回值：始终返回

示例： "Reject"

ip_mask

字符串

包含规则的 CIDR 表示法中的 IP 地址范围的字符串。

返回值：始终返回

示例： "40.54.7.3"

name

字符串

过滤器的名称。

返回值：始终返回

示例： "filter"

location

字符串

IoT 中心的位置。

返回值：始终返回

示例： "eastus"

name

字符串

IoT 中心的名称。

返回值：始终返回

示例： "Testing"

资源组

字符串

IoT 中心的资源组。

返回值：始终返回

示例： "myResourceGroup."

routes

复杂类型

将设备到云的消息路由到面向服务的端点。

返回值：始终返回

condition

布尔值

针对消息应用程序属性、系统属性、消息正文、设备孪生标签和设备孪生属性运行的路由查询的查询表达式，用于确定它是否与端点匹配。

有关构建查询的更多信息，请参阅 https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax

返回值：始终返回

示例： true

enabled

布尔值

是否启用路由。

返回值：始终返回

示例： true

endpoint_name

字符串

在 *routing_endpoints* 中，IoT 中心将匹配查询的消息发送到的端点的名称。

返回值：始终返回

示例： "foo"

name

字符串

路由的名称。

返回值：始终返回

示例： "route1"

source

字符串

要对其进行操作的数据流的来源。

返回值：始终返回

示例： "device_messages"

routing_endpoints

复杂类型

自定义端点。

返回值：始终返回

event_hubs

复杂类型

事件中心的自定义端点列表。

返回值：始终返回

connection_string

字符串

自定义端点的连接字符串。

返回值：始终返回

示例： "Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"

name

字符串

自定义端点的名称。

返回值：始终返回

示例： "foo"

资源组

字符串

端点的资源组。

返回值：始终返回

示例： "bar"

subscription

字符串

端点的订阅 ID。

返回值：始终返回

示例： "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

service_bus_queues

复杂类型

服务总线队列的自定义端点列表。

返回值：始终返回

connection_string

字符串

自定义端点的连接字符串。

返回值：始终返回

示例： "Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"

name

字符串

自定义端点的名称。

返回值：始终返回

示例： "foo"

资源组

字符串

端点的资源组。

返回值：始终返回

示例： "bar"

subscription

字符串

端点的订阅 ID。

返回值：始终返回

示例： "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

service_bus_topics

复杂类型

服务总线主题的自定义端点列表。

返回值：始终返回

connection_string

字符串

自定义端点的连接字符串。

返回值：始终返回

示例： "Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"

name

字符串

自定义端点的名称。

返回值：始终返回

示例： "foo"

资源组

字符串

端点的资源组。

返回值：始终返回

示例： "bar"

subscription

字符串

端点的订阅 ID。

返回值：始终返回

示例： "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

storage_containers

复杂类型

存储的自定义端点列表。

返回值：始终返回

connection_string

字符串

自定义端点的连接字符串。

返回值：始终返回

示例： "Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"

name

字符串

自定义端点的名称。

返回值：始终返回

示例： "foo"

资源组

字符串

端点的资源组。

返回值：始终返回

示例： "bar"

subscription

字符串

端点的订阅 ID。

返回值：始终返回

示例： "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

sku

字符串

Azure IoT Hub 的定价层。

返回值：始终返回

示例： "f1"

标签

字典

通过提供标签列表来限制结果。标签格式为“键”或“键:值”。

返回值：始终返回

示例： {"key1": "value1"}

unit

整数

IoT 中心的单位。

返回值：始终返回

示例： 1

作者

  • 周宇威 (@yuwzho)