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

QueueMessage 类

参考

队列消息对象。

继承: azure.functions._abc.QueueMessage

QueueMessage

构造函数

QueueMessage(*, id: str | None = None, body: str | bytes | None = None, pop_receipt: str | None = None)

参数

名称	说明
id 必需	str 指定消息 ID 的可选字符串。
body 必需	指定消息正文的字符串或字节实例。
pop_receipt 必需	str 包含弹出回执令牌的可选字符串。

仅限关键字的参数

名称	说明
id 必需
body 必需
pop_receipt 必需

方法

get_body	以字节的形式返回消息内容。
get_json	解码消息内容并将其作为 JSON 对象返回。

get_body

以字节的形式返回消息内容。

get_body() -> bytes

get_json

解码消息内容并将其作为 JSON 对象返回。

get_json() -> Any

类型	说明
	解码的 JSON 数据。

例外

类型	说明
ValueError	当消息正文不包含有效的 JSON 数据时。

属性

dequeue_count

此消息取消排队的次数。

expiration_time

具有消息到期时间的 datetime 对象。

id

消息 ID。

insertion_time

具有消息队列插入时间的 datetime 对象。

pop_receipt

字符串格式的邮件弹出回执令牌。

time_next_visible

一个 datetime 对象，其中包含消息接下来可见的时间。