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

GenerateClientTokenOptions interface

参考

包:: @azure/web-pubsub

用于生成令牌以将客户端连接到 Azure Web Pubsub 服务的选项。

扩展: OperationOptions

属性

clientProtocol	客户端的协议类型 `default`：默认 WebPubSub 客户端。客户端连接 URL 示例：wss://exampleHost.com/client/hubs/exampleHub `mqtt`：MQTT 客户端。客户端连接 URL 示例：wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	令牌过期前的分钟数。
groups	客户端连接时要加入的组
roles	与生成的令牌的连接将具有的角色。使用 PubSub 子协议时，角色为客户端提供离开、加入或发布到组的初始权限 `webpubsub.joinLeaveGroup`：客户端可以加入或离开任何组 `webpubsub.sendToGroup`：客户端可以将消息发送到任何组 `webpubsub.joinLeaveGroup.<group>`：客户端可以加入或离开组 `<group>` `webpubsub.sendToGroup.<group>`：客户端可以将消息发送到组 `<group>` https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	客户端的 userId。

继承属性

abortSignal	可用于中止请求的信号。
onResponse	在执行请求的操作时，每次从服务器接收响应时调用的函数。可以多次调用。
requestOptions	为此操作创建和发送 HTTP 请求时使用的选项。
serializerOptions	用于替代序列化/取消序列化行为的选项。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

clientProtocol

客户端的协议类型

default：默认 WebPubSub 客户端。客户端连接 URL 示例：wss://exampleHost.com/client/hubs/exampleHub
mqtt：MQTT 客户端。客户端连接 URL 示例：wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

属性值

WebPubSubClientProtocol

expirationTimeInMinutes

令牌过期前的分钟数。

expirationTimeInMinutes?: number

属性值

number

groups

客户端连接时要加入的组

groups?: string[]

属性值

string[]

roles

与生成的令牌的连接将具有的角色。使用 PubSub 子协议时，角色为客户端提供离开、加入或发布到组的初始权限

webpubsub.joinLeaveGroup：客户端可以加入或离开任何组
webpubsub.sendToGroup：客户端可以将消息发送到任何组
webpubsub.joinLeaveGroup.<group>：客户端可以加入或离开组 <group>
webpubsub.sendToGroup.<group>：客户端可以将消息发送到组 <group>

https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions

roles?: string[]

属性值

string[]

userId

客户端的 userId。

userId?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 OperationOptions.abortSignal 的

onResponse

在执行请求的操作时，每次从服务器接收响应时调用的函数。可以多次调用。

onResponse?: RawResponseCallback

属性值

RawResponseCallback

继承自 OperationOptions.onResponse

requestOptions

为此操作创建和发送 HTTP 请求时使用的选项。

requestOptions?: OperationRequestOptions

属性值

OperationRequestOptions

继承自 OperationOptions.requestOptions

serializerOptions

用于替代序列化/取消序列化行为的选项。

serializerOptions?: SerializerOptions

属性值

SerializerOptions

继承自 OperationOptions.serializerOptions

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 OperationOptions.tracingOptions

通过