你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Message 类
表示向 IoTHub 发送或传出的消息
消息的初始值设定项
- 继承
-
builtins.objectMessage
构造函数
Message(data, message_id=None, content_encoding=None, content_type=None, output_name=None)
参数
名称 | 说明 |
---|---|
data
必需
|
构成有效负载的数据 |
message_id
|
用户可设置的消息标识符,用于请求-答复模式。 格式:区分大小写的字符串 (最多 128 个字符,) ASCII 7 位字母数字字符 + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ' (', ') ', ',', '=', '@', ';', '$', '''} 默认值: None
|
content_encoding
|
消息数据的内容编码。 其他值可以是 utf-16“或”utf-32” 默认值: None
|
content_type
|
用于路由消息正文的内容类型属性。 默认值: None
|
output_name
|
要发送到的输出的名称。 默认值: None
|
变量
名称 | 说明 |
---|---|
data
|
构成有效负载的数据 |
custom_properties
|
自定义消息属性的字典。 这些属性的键和值将始终为字符串。 |
id
|
<xref:message>
用户可设置的消息标识符,用于请求-答复模式。 格式:区分大小写的字符串 (最多 128 个字符,) ASCII 7 位字母数字字符 + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ' (', ') ', ',', '=', '@', ';', '$', '''} |
expiry_time_utc
|
UTC 格式的邮件过期日期和时间 |
correlation_id
|
响应消息中的属性,该属性通常包含请求message_id(采用请求-答复模式) |
user_id
|
用于指定消息来源的 ID |
content_encoding
|
消息数据的内容编码。 可以是“utf-8”、“utf-16”或“utf-32” |
content_type
|
用于通过消息正文路由消息的内容类型属性。 可以是“application/json” |
output_name
|
消息要发送到的输出的名称。 |
input_name
|
接收消息的输入的名称。 |
方法
get_size | |
set_as_security_message |
将消息设置为安全消息。 这是一个临时 API。 尚不保证功能。 |
get_size
get_size()
set_as_security_message
将消息设置为安全消息。
这是一个临时 API。 尚不保证功能。
set_as_security_message()