azure.azcollection.azure_rm_iothub_info 模块 – 获取 IoT 中心信息

注意

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

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

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

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

azure.azcollection 0.1.2 新增

概要

  • 获取特定 IoT 中心或所有 IoT 中心的信息。

要求

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

  • python >= 2.7

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

  • 必须通过 pip 在执行来自 azure.azcollection 模块的主机上安装集合的 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"

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 中心的密钥。

请注意，每个 IoT 中心都会有网络开销。

选择

  • false

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

名称

字符串

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

密码

字符串

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

配置文件

字符串

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

resource_group

字符串

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

密钥

字符串

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

show_endpoint_health

布尔值

获取路由终结点的运行状况。

请注意，每个 IoT 中心都会有网络开销。

选择

  • false

  • true

show_quota_metrics

布尔值

获取 IoT 中心的配额指标。

请注意，每个 IoT 中心都会有网络开销。

选择

  • false

  • true

show_stats

布尔值

显示 IoT 中心的统计信息。

请注意，每个 IoT 中心都会有网络开销。

选择

  • false

  • true

subscription_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 中的配置文件，或者在运行任务或 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 中。这是一个 ini 文件，其中包含一个 [default] 部分以及以下键：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

复杂

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

返回：始终

endpoint

字符串

与事件中心兼容的终结点。

返回：始终

示例： "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"

名称

字符串

筛选器的名称。

返回：始终

示例： "filter"

location

字符串

IoT 中心的位置。

返回：始终

示例： "eastus"

名称

字符串

IoT 中心的名称。

返回：始终

示例： "Testing"

resource_group

字符串

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"

名称

字符串

路由的名称。

返回：始终

示例： "route1"

source

字符串

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

返回：始终

示例： "device_messages"

routing_endpoints

复杂

自定义终结点。

返回：始终

event_hubs

复杂

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

返回：始终

connection_string

字符串

自定义终结点的连接字符串。

返回：始终

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

名称

字符串

自定义终结点的名称。

返回：始终

示例： "foo"

resource_group

字符串

终结点的资源组。

返回：始终

示例： "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"

名称

字符串

自定义终结点的名称。

返回：始终

示例： "foo"

resource_group

字符串

终结点的资源组。

返回：始终

示例： "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"

名称

字符串

自定义终结点的名称。

返回：始终

示例： "foo"

resource_group

字符串

终结点的资源组。

返回：始终

示例： "bar"

subscription

字符串

终结点的订阅 ID。

返回：始终

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

storage_containers

复杂

存储的自定义终结点列表。

返回：始终

connection_string

字符串

自定义终结点的连接字符串。

返回：始终

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

名称

字符串

自定义终结点的名称。

返回：始终

示例： "foo"

resource_group

字符串

终结点的资源组。

返回：始终

示例： "bar"

subscription

字符串

终结点的订阅 ID。

返回：始终

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

sku

字符串

Azure IoT 中心的定价层。

返回：始终

示例： "f1"

标签

字典

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

返回：始终

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

unit

整数

IoT 中心中的单元。

返回：始终

示例： 1

作者

  • Yuwei Zhou (@yuwzho)