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

Web Pub Sub - Generate Client Token

服务:

Azure Web PubSub Service

API 版本:

2024-01-01

为客户端生成令牌以连接 Azure Web PubSub 服务。

POST {endpoint}/api/hubs/{hub}/:generateToken?api-version=2024-01-01

具有可选参数:

POST {endpoint}/api/hubs/{hub}/:generateToken?userId={userId}&role={role}&minutesToExpire={minutesToExpire}&api-version=2024-01-01&group={group}&clientType={clientType}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	Web PubSub 服务实例的 HTTP 或 HTTPS 终结点。
hub	path	True	string	目标中心名称，该名称应以字母字符开头，并且仅包含字母数字字符或下划线。 正则表达式模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	REST API 的版本。
clientType	query		WebPubSubClientType	客户端的类型。 不区分大小写。 如果未设置，则为“Default”。 对于 Socket.IO 的 Web PubSub，仅支持默认值。 对于 Web PubSub，有效值为“Default”和“MQTT”。
group	query		string[]	连接在连接时将加入的组。
minutesToExpire	query		integer int32	生成的令牌的过期时间。
role	query		string[]	与生成的令牌的连接将具有的角色。
userId	query		string	用户 ID。

响应

名称	类型	说明
200 OK	ClientTokenResponse	成功 Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	错误响应 Media Types: "text/plain", "application/json", "text/json" 标头 x-ms-error-code: string

示例

WebPubSub_GenerateClientToken

示例请求

HTTP

POST {endpoint}/api/hubs/hub1/:generateToken?userId=user1&minutesToExpire=5&api-version=2024-01-01&clientType=MQTT

示例响应

状态代码:

200

{
  "token": "ABCDEFG.ABC.ABC"
}

定义

名称	说明
ClientTokenResponse	包含客户端令牌的响应对象
ErrorDetail	错误对象。
InnerError
WebPubSubClientType	客户端的类型。 不区分大小写。 如果未设置，则为“Default”。 对于 Socket.IO 的 Web PubSub，仅支持默认值。 对于 Web PubSub，有效值为“Default”和“MQTT”。

ClientTokenResponse

包含客户端令牌的响应对象

名称	类型	说明
token	string	要连接到服务的 WebSocket 客户端的令牌值

ErrorDetail

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	ErrorDetail[]	导致此报告错误的特定错误的详细信息数组。
inner	InnerError
message	string	错误的人工可读表示形式。
target	string	错误的目标。

InnerError

名称	类型	说明
code	string	比包含的错误提供的错误代码更具体。
inner	InnerError

WebPubSubClientType

客户端的类型。 不区分大小写。 如果未设置，则为“Default”。 对于 Socket.IO 的 Web PubSub，仅支持默认值。 对于 Web PubSub，有效值为“Default”和“MQTT”。

名称	类型	说明
Default	string
MQTT	string