你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IoTHubConfigurationManager 类

一个类，用于基于自动生成的 IotHub REST API，为 IoTHub Configuration Manager操作提供便捷 API

Configuration Manager服务客户端的初始值设定项。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。

继承

builtins.object

IoTHubConfigurationManager

构造函数

IoTHubConfigurationManager(connection_string=None, host=None, auth=None)

参数

名称	说明
connection_string	str 如果使用的是connection_str身份验证，则用于对与 IoTHub 的连接进行身份验证的 IoTHub 连接字符串。 默认值： 无 默认值: None
host	str 如果使用的是令牌凭据身份验证，则为 Azure 服务 URL。 默认值： 无 默认值: None
auth	str 如果使用的是令牌凭据身份验证，则为 Azure 身份验证对象。 默认值： 无 默认值: None

方法

apply_configuration_on_edge_device	将提供的配置内容应用于指定的边缘设备。 模块内容是必需的。
create_configuration	为 IoTHub 的设备或模块创建配置。
delete_configuration	从 IoTHub 中删除配置。
from_connection_string	IoTHubConfigurationManager 服务客户端的类方法初始值设定项。 从连接字符串创建 IoTHubConfigurationManager 类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。
from_token_credential	IoTHubConfigurationManager 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建 IoTHubConfigurationManager 类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。
get_configuration	检索特定设备的 IoTHub 配置。
get_configurations	检索 IoTHub 的设备和模块的多个配置。 返回指定的配置数。 不支持分页。
test_configuration_queries	验证配置的目标条件查询和自定义指标查询。
update_configuration	汇报 IoTHub 的设备或模块的配置。 注意：用户无法更新配置 ID 和内容。

apply_configuration_on_edge_device

将提供的配置内容应用于指定的边缘设备。 模块内容是必需的。

apply_configuration_on_edge_device(device_id, configuration_content)

参数

名称	说明
configuration_content 必需	ConfigurationContent 边缘设备的名称 (ID) 。
device_id 必需

返回

类型	说明
	一个对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

create_configuration

为 IoTHub 的设备或模块创建配置。

create_configuration(configuration)

参数

名称	说明
configuration_id 必需	str 配置的 ID。
configuration 必需	Configuration 要创建的配置。

返回

类型	说明
	包含已创建配置的配置对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

delete_configuration

从 IoTHub 中删除配置。

delete_configuration(configuration_id, etag=None)

参数

名称	说明
configuration_id 必需	str 配置的 ID。
configuration 必需	Configuration 要创建的配置。
etag	str etag (if_match) 用于删除操作的值。 默认值: None

返回

类型	说明
	包含更新的配置的配置对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_connection_string

IoTHubConfigurationManager 服务客户端的类方法初始值设定项。 从连接字符串创建 IoTHubConfigurationManager 类。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。

from_connection_string(connection_string)

参数

名称	说明
connection_string 必需	str 用于对 IoTHub 的连接进行身份验证的 IoTHub 连接字符串。

返回

类型	说明
IoTHubConfigurationManager

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

from_token_credential

IoTHubConfigurationManager 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建 IoTHubConfigurationManager 类。

成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 来与 IoTHub 通信。

from_token_credential(url, token_credential)

参数

名称	说明
url 必需	str ) (主机名的 Azure 服务 URL。
token_credential 必需	<xref:azure.core.TokenCredential> Azure 令牌凭据对象

返回

类型	说明
IoTHubConfigurationManager

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configuration

检索特定设备的 IoTHub 配置。

get_configuration(configuration_id)

参数

名称	说明
configuration_id 必需	str 配置的 ID。

返回

类型	说明
	Configuration 对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

get_configurations

检索 IoTHub 的设备和模块的多个配置。 返回指定的配置数。 不支持分页。

get_configurations(max_count=None)

参数

名称	说明
max_count	int 请求的最大配置数。 默认值: None

返回

类型	说明
	list[Configuration] 对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

test_configuration_queries

验证配置的目标条件查询和自定义指标查询。

test_configuration_queries(configuration_queries_test_input)

参数

名称	说明
configuration_queries_test_input 必需	ConfigurationQueriesTestInput 查询测试输入。

返回

类型	说明
	ConfigurationQueriesTestResponse 对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>

update_configuration

汇报 IoTHub 的设备或模块的配置。 注意：用户无法更新配置 ID 和内容。

update_configuration(configuration, etag)

参数

名称	说明
configuration_id 必需	str 配置的 ID。
configuration 必需	Configuration 配置包含更新的配置。
etag 必需	str etag (if_match) 用于更新操作的值。

返回

类型	说明
	包含更新的配置的配置对象。

例外

类型	说明
<xref:if the HTTP response status is not in >[<xref:200>]<xref:.>