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

IoTHubRegistryManager 类

一个类，用于基于自动生成的 IotHub REST API 为 IoTHub 注册表管理器操作提供方便的 API

注册表管理器服务客户端的初始值设定项。

用户不应直接调用它。 相反，它们应使用 from_connection_string () 或 from_token_credential () 工厂方法。

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

继承

builtins.object

IoTHubRegistryManager

构造函数

IoTHubRegistryManager(connection_string=None, host=None, token_credential=None)

参数

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

方法

bulk_create_or_update_devices	从 IoTHub 标识注册表创建、更新或删除多个设备的标识。 从 IoTHub 标识注册表创建、更新或删除多个设备的标识。 只能在列表中指定一次设备标识。 允许在不同设备上执行不同的操作 (创建、更新、删除) 。 每次调用最多可以指定 100 个设备。 对于大规模操作，请考虑使用 blob 存储 (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) 的导入功能。
create_device_with_certificate_authority	使用证书颁发机构在 IoTHub 上创建设备标识。
create_device_with_sas	使用 SAS 身份验证在 IoTHub 上创建设备标识。
create_device_with_x509	使用 X509 身份验证在 IoTHub 上创建设备标识。
create_module_with_certificate_authority	使用证书颁发机构为 IoTHub 上的设备创建模块标识。
create_module_with_sas	使用 SAS 身份验证为 IoTHub 上的设备创建模块标识。
create_module_with_x509	使用 X509 身份验证为 IoTHub 上的设备创建模块标识。
delete_device	从 IoTHub 中删除设备标识。
delete_module	从 IoTHub 中删除设备的模块标识。
from_connection_string	Registry Manager 服务客户端的类方法初始值设定项。 从连接字符串创建注册表管理器类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。
from_token_credential	Registry Manager 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建注册表管理器类。 成功创建后，该类已通过 IoTHub 进行身份验证，并已准备好调用成员 API 以与 IoTHub 通信。
get_device	从 IoTHub 检索设备标识。
get_device_registry_statistics	检索 IoTHub 设备注册表统计信息。
get_devices	从 IoTHub 标识注册表获取多个设备的标识。 建议不要使用。 使用 IoTHub 查询语言检索设备孪生和设备标识信息。 有关更多信息，请参见https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub和https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language。
get_module	从 IoTHub 检索设备的模块标识。
get_module_twin	获取模块孪生。
get_modules	检索设备上的所有模块标识。
get_service_statistics	检索 IoTHub 服务统计信息。
get_twin	获取设备孪生。
invoke_device_method	在设备上调用直接方法。
invoke_device_module_method	在设备上调用直接方法。
query_iot_hub	查询 IoTHub 以使用类似 SQL 的语言检索有关设备孪生的信息。 有关详细信息，请参阅https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language。 支持对结果进行分页。 这仅返回有关设备孪生的信息。
replace_module_twin	替换模块孪生的标记和所需属性。
replace_twin	替换设备孪生的标记和所需属性。
send_c2d_message	将 C2D 消息发送到 IoTHub 设备。
update_device_with_certificate_authority	使用证书颁发机构在 IoTHub 上汇报设备标识。
update_device_with_sas	使用 SAS 身份验证在 IoTHub 上汇报设备标识。
update_device_with_x509	使用 X509 身份验证在 IoTHub 上汇报设备标识。
update_module_twin	汇报模块孪生的标记和所需属性。
update_module_with_certificate_authority	使用证书颁发机构汇报 IoTHub 上的设备的模块标识。
update_module_with_sas	使用 SAS 身份验证为 IoTHub 上的设备汇报模块标识。
update_module_with_x509	使用 X509 身份验证为 IoTHub 上的设备汇报模块标识。
update_twin	汇报设备孪生的标记和所需属性。

bulk_create_or_update_devices

从 IoTHub 标识注册表创建、更新或删除多个设备的标识。

从 IoTHub 标识注册表创建、更新或删除多个设备的标识。 只能在列表中指定一次设备标识。 允许在不同设备上执行不同的操作 (创建、更新、删除) 。 每次调用最多可以指定 100 个设备。 对于大规模操作，请考虑使用 blob 存储 (https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities) 的导入功能。

bulk_create_or_update_devices(devices)

参数

名称	说明
devices 必需	list[ExportImportDevice] 要操作的设备对象列表。

返回

类型	说明
	BulkRegistryOperationResult 对象。

例外

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

create_device_with_certificate_authority

使用证书颁发机构在 IoTHub 上创建设备标识。

create_device_with_certificate_authority(device_id, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”) 。
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，此值可以设置为与 device_scope 相同的值，也可以保留给服务进行复制。 默认值: None

返回

类型	说明
	包含所创建设备的设备对象。

例外

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

create_device_with_sas

使用 SAS 身份验证在 IoTHub 上创建设备标识。

create_device_with_sas(device_id, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
primary_key 必需	str 主身份验证密钥。
secondary_key 必需	str 辅助身份验证密钥。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”)
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，此值可以设置为与 device_scope 相同的值，也可以保留给服务进行复制。 默认值: None

返回

类型	说明
	包含所创建设备的设备对象。

例外

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

create_device_with_x509

使用 X509 身份验证在 IoTHub 上创建设备标识。

create_device_with_x509(device_id, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
primary_thumbprint 必需	str 主 X509 指纹。
secondary_thumbprint 必需	str 辅助 X509 指纹。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”)
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，此值可以设置为与 device_scope 相同的值，也可以保留给服务进行复制。 默认值: None

返回

类型	说明
	包含所创建设备的设备对象。

例外

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

create_module_with_certificate_authority

使用证书颁发机构为 IoTHub 上的设备创建模块标识。

create_module_with_certificate_authority(device_id, module_id, managed_by)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 边缘) (管理器设备的名称。

返回

类型	说明
	包含已创建模块的 Module 对象。

例外

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

create_module_with_sas

使用 SAS 身份验证为 IoTHub 上的设备创建模块标识。

create_module_with_sas(device_id, module_id, managed_by, primary_key, secondary_key)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 边缘) (管理器设备的名称。
primary_key 必需	str 主身份验证密钥。
secondary_key 必需	str 辅助身份验证密钥。

返回

类型	说明
	包含已创建模块的 Module 对象。

例外

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

create_module_with_x509

使用 X509 身份验证为 IoTHub 上的设备创建模块标识。

create_module_with_x509(device_id, module_id, managed_by, primary_thumbprint, secondary_thumbprint)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 边缘) (管理器设备的名称。
primary_thumbprint 必需	str 主 X509 指纹。
secondary_thumbprint 必需	str 辅助 X509 指纹。

返回

类型	说明
	包含已创建模块的 Module 对象。

例外

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

delete_device

从 IoTHub 中删除设备标识。

delete_device(device_id, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
etag	str etag (if_match) 用于删除操作的值。 默认值: None

返回

类型	说明
	无。

例外

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

delete_module

从 IoTHub 中删除设备的模块标识。

delete_module(device_id, module_id, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
etag	str etag (if_match) 用于删除操作的值。 默认值: None

返回

类型	说明
	无。

例外

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

from_connection_string

Registry Manager 服务客户端的类方法初始值设定项。 从连接字符串创建注册表管理器类。

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

from_connection_string(connection_string)

参数

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

返回

类型	说明
IoTHubRegistryManager

例外

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

from_token_credential

Registry Manager 服务客户端的类方法初始值设定项。 从主机名 URL 和 Azure 令牌凭据创建注册表管理器类。

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

from_token_credential(url, token_credential)

参数

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

返回

类型	说明
IoTHubRegistryManager

例外

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

get_device

从 IoTHub 检索设备标识。

get_device(device_id)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。

返回

类型	说明
	包含所请求设备的 Device 对象。

例外

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

get_device_registry_statistics

检索 IoTHub 设备注册表统计信息。

get_device_registry_statistics()

返回

类型	说明
	RegistryStatistics 对象。

例外

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

get_devices

从 IoTHub 标识注册表获取多个设备的标识。 建议不要使用。 使用 IoTHub 查询语言检索设备孪生和设备标识信息。 有关更多信息，请参见https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub和https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language。

get_devices(max_number_of_devices=None)

参数

名称	说明
max_number_of_devices	int 指定此参数时，定义返回的最大设备标识数。 超出 1-1000 范围的任何值都被视为 1000 默认值: None

返回

类型	说明
	设备信息列表。

例外

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

get_module

从 IoTHub 检索设备的模块标识。

get_module(device_id, module_id)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。

返回

类型	说明
	包含所请求模块的 Module 对象。

例外

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

get_module_twin

获取模块孪生。

get_module_twin(device_id, module_id)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。

返回

类型	说明
	Twin 对象。

例外

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

get_modules

检索设备上的所有模块标识。

get_modules(device_id)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。

返回

类型	说明
	包含设备上所有模块的列表[模块]。

例外

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

get_service_statistics

检索 IoTHub 服务统计信息。

get_service_statistics()

返回

类型	说明
	ServiceStatistics 对象。

例外

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

get_twin

获取设备孪生。

get_twin(device_id)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。

返回

类型	说明
	Twin 对象。

例外

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

invoke_device_method

在设备上调用直接方法。

invoke_device_method(device_id, direct_method_request)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
direct_method_request 必需	CloudToDeviceMethod 方法请求。

返回

类型	说明
	CloudToDeviceMethodResult 对象。

例外

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

invoke_device_module_method

在设备上调用直接方法。

invoke_device_module_method(device_id, module_id, direct_method_request)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
direct_method_request 必需	CloudToDeviceMethod 方法请求。

返回

类型	说明
	CloudToDeviceMethodResult 对象。

例外

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

query_iot_hub

查询 IoTHub 以使用类似 SQL 的语言检索有关设备孪生的信息。 有关详细信息，请参阅https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language。 支持对结果进行分页。 这仅返回有关设备孪生的信息。

query_iot_hub(query_specification, continuation_token=None, max_item_count=None)

参数

名称	说明
query 必需	QuerySpecification 查询规范。
continuation_token	str 分页的继续标记 默认值: None
max_item_count	str 请求的设备孪生数上限 默认值: None
query_specification 必需

返回

类型	说明
	QueryResult 对象。

例外

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

replace_module_twin

替换模块孪生的标记和所需属性。

replace_module_twin(device_id, module_id, module_twin, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
module_twin 必需	Twin 模块的孪生体信息。
etag	str etag (if_match) 用于替换操作的值。 默认值: None

返回

类型	说明
	Twin 对象。

例外

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

replace_twin

替换设备孪生的标记和所需属性。

replace_twin(device_id, device_twin, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
device_twin 必需	Twin 设备的孪生体信息。
etag	str etag (if_match) 用于替换操作的值。 默认值: None

返回

类型	说明
	Twin 对象。

例外

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

send_c2d_message

将 C2D 消息发送到 IoTHub 设备。

send_c2d_message(device_id, message, properties={})

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
message 必需	str 要传递到设备的消息。
properties	dict 要随消息一起发送的属性。 可以包含应用程序属性和系统属性 默认值: {}

例外

类型	说明
Exception if the Send command is not able to send the message

update_device_with_certificate_authority

使用证书颁发机构在 IoTHub 上汇报设备标识。

update_device_with_certificate_authority(device_id, etag, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
etag 必需	str etag (if_match) 用于更新操作的值。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”) 。
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无 自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性中检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，可以将其设置为与 device_scope 相同的值，也可以保留供服务复制。 默认值: None

返回

类型	说明
	包含所创建设备的已更新 Device 对象。

例外

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

update_device_with_sas

使用 SAS 身份验证在 IoTHub 上汇报设备标识。

update_device_with_sas(device_id, etag, primary_key, secondary_key, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
etag 必需	str etag (if_match) 用于更新操作的值。
primary_key 必需	str 主身份验证密钥。
secondary_key 必需	str 辅助身份验证密钥。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”) 。
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无 自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性中检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，可以将其设置为与 device_scope 相同的值，也可以保留供服务复制。 默认值: None

返回

类型	说明
	包含所创建设备的已更新 Device 对象。

例外

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

update_device_with_x509

使用 X509 身份验证在 IoTHub 上汇报设备标识。

update_device_with_x509(device_id, etag, primary_thumbprint, secondary_thumbprint, status, iot_edge=False, status_reason=None, device_scope=None, parent_scopes=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
etag 必需	str etag (if_match) 用于更新操作的值。
primary_thumbprint 必需	str 主要 X509 指纹。
secondary_thumbprint 必需	str 辅助 X509 指纹。
status 必需	str 已创建设备的初始状态。 (可能的值：“enabled”或“disabled”) 。
iot_edge	bool 创建的设备是否为IoT Edge设备。 默认值：False 默认值: False
status_reason	str 设备标识状态的原因。 默认值： 无 默认值: None
device_scope	str 设备的范围。 默认值：无 自动生成，边缘设备不可变，在叶设备中可修改以创建子/父关系。 对于叶设备，可以从父边缘设备的 device_scope 属性中检索用于设置父边缘设备的值。 默认值: None
parent_scopes	Union[list[str], str] 上层边缘设备的范围（如果适用）。 默认值：无 对于边缘设备，可以从父边缘设备的 device_scope 属性检索用于设置父边缘设备的值。 对于叶设备，可以将其设置为与 device_scope 相同的值，也可以保留供服务复制。 默认值: None

返回

类型	说明
	包含所创建设备的已更新 Device 对象。

例外

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

update_module_twin

汇报模块孪生的标记和所需属性。

update_module_twin(device_id, module_id, module_twin, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
module_twin 必需	Twin 模块的孪生体信息。
etag	str etag (if_match) 用于更新操作的值。 默认值: None

返回

类型	说明
	Twin 对象。

例外

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

update_module_with_certificate_authority

使用证书颁发机构汇报 IoTHub 上的设备的模块标识。

update_module_with_certificate_authority(device_id, module_id, managed_by, etag)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 管理器设备的名称 (边缘) 。
etag 必需	str etag (if_match) 用于更新操作的值。

返回

类型	说明
	包含所创建模块的已更新的 Module 对象。

例外

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

update_module_with_sas

使用 SAS 身份验证为 IoTHub 上的设备汇报模块标识。

update_module_with_sas(device_id, module_id, managed_by, etag, primary_key, secondary_key)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 管理器设备的名称 (边缘) 。
etag 必需	str etag (if_match) 用于更新操作的值。
primary_key 必需	str 主身份验证密钥。
secondary_key 必需	str 辅助身份验证密钥。

返回

类型	说明
	包含所创建模块的已更新的 Module 对象。

例外

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

update_module_with_x509

使用 X509 身份验证为 IoTHub 上的设备汇报模块标识。

update_module_with_x509(device_id, module_id, managed_by, etag, primary_thumbprint, secondary_thumbprint)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
module_id 必需	str 模块的名称 (ID) 。
managed_by 必需	str 管理器设备的名称 (边缘) 。
etag 必需	str etag (if_match) 用于更新操作的值。
primary_thumbprint 必需	str 主要 X509 指纹。
secondary_thumbprint 必需	str 辅助 X509 指纹。

返回

类型	说明
	包含所创建模块的已更新的 Module 对象。

例外

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

update_twin

汇报设备孪生的标记和所需属性。

update_twin(device_id, device_twin, etag=None)

参数

名称	说明
device_id 必需	str 设备的名称 (ID) 。
device_twin 必需	Twin 设备的孪生体信息。
etag	str etag (if_match) 用于更新操作的值。 默认值: None

返回

类型	说明
	Twin 对象。

例外

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