GenerateClientTokenOptions interface

用戶端的通訊協議類型

• default：預設 WebPubSub 用戶端。 範例用戶端連線 URL：wss://exampleHost.com/client/hubs/exampleHub
• mqtt：MQTT 用戶端。 範例用戶端連線 URL：wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

屬性值

令牌到期前的分鐘數。

expirationTimeInMinutes?: number

屬性值

用戶端連線時要加入的群組

groups?: string[]

屬性值

與所產生令牌連接的角色。 角色可讓用戶端在使用 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[]

屬性值

用戶端的userId。

userId?: string

屬性值

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

繼承自 OperationOptions.abortSignal

每次從伺服器收到回應時，要呼叫的函式，同時執行要求的作業。 可以多次呼叫。

onResponse?: RawResponseCallback

屬性值

繼承自 OperationOptions.onResponse

建立和傳送此作業之 HTTP 要求時所使用的選項。

requestOptions?: OperationRequestOptions

屬性值

繼承自 OperationOptions.requestOptions

覆寫串行化/取消串行化行為的選項。

serializerOptions?: SerializerOptions

屬性值

繼承自 OperationOptions.serializerOptions

啟用追蹤時所使用的選項。

tracingOptions?: OperationTracingOptions

屬性值

繼承自 OperationOptions.tracingOptions