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

QueueSendMessageOptions interface

配置 sendMessage 操作的选项

扩展

属性

abortSignal

AbortSignalLike 接口的实现,用于向请求发出取消操作的信号。 例如,使用 @azure/abort-controller 创建 AbortSignal

继承属性

messageTimeToLive

自选。 指定消息的生存时间间隔(以秒为单位)。 在版本 2017-07-29 之前,允许的最大生存时间为 7 天。 对于版本 2017-07-29 或更高版本,最长生存时间可以是任何正数,以及指示消息未过期的 -1。 如果省略此参数,则默认生存时间为 7 天。

requestId

提供客户端生成的不透明值,该值在启用存储分析日志记录时,在分析日志中记录了 1 KB 字符限制。

timeoutInSeconds

超时参数以秒为单位表示。 有关详细信息,请参阅 为队列服务操作设置超时。

tracingOptions

用于配置启用跟踪时创建的跨度的选项。

visibilityTimeout

自选。 如果指定,则必须使用 x-ms-version of 2011-08-18 或更高版本发出请求。 如果未指定,则默认值为 0。 指定相对于服务器时间的新可见性超时值(以秒为单位)。 新值必须大于或等于 0,并且不能大于 7 天。 消息的可见性超时不能设置为晚于到期时间的值。 visibilitytimeout 应设置为小于生存时间值的值。

属性详细信息

abortSignal

AbortSignalLike 接口的实现,用于向请求发出取消操作的信号。 例如,使用 @azure/abort-controller 创建 AbortSignal

abortSignal?: AbortSignalLike

属性值

继承属性详细信息

messageTimeToLive

自选。 指定消息的生存时间间隔(以秒为单位)。 在版本 2017-07-29 之前,允许的最大生存时间为 7 天。 对于版本 2017-07-29 或更高版本,最长生存时间可以是任何正数,以及指示消息未过期的 -1。 如果省略此参数,则默认生存时间为 7 天。

messageTimeToLive?: number

属性值

number

继承自messagesEnqueueOptionalParams.messageTimeToLive

requestId

提供客户端生成的不透明值,该值在启用存储分析日志记录时,在分析日志中记录了 1 KB 字符限制。

requestId?: string

属性值

string

继承自 messagesEnqueueOptionalParams.requestId 的

timeoutInSeconds

超时参数以秒为单位表示。 有关详细信息,请参阅 为队列服务操作设置超时。

timeoutInSeconds?: number

属性值

number

继承自messagesEnqueueOptionalParams.timeoutInSeconds

tracingOptions

用于配置启用跟踪时创建的跨度的选项。

tracingOptions?: OperationTracingOptions

属性值

继承自CommonOptions.tracingOptions

visibilityTimeout

自选。 如果指定,则必须使用 x-ms-version of 2011-08-18 或更高版本发出请求。 如果未指定,则默认值为 0。 指定相对于服务器时间的新可见性超时值(以秒为单位)。 新值必须大于或等于 0,并且不能大于 7 天。 消息的可见性超时不能设置为晚于到期时间的值。 visibilitytimeout 应设置为小于生存时间值的值。

visibilityTimeout?: number

属性值

number

继承自messagesEnqueueOptionalParams.visibilityTimeout