generate_client_tokens
Creates, updates, deletes, gets or lists a generate_client_tokens resource.
Overview​
| Name | generate_client_tokens |
| Type | Resource |
| Id | azure.messaging_webpubsubservice.generate_client_tokens |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
generate_client_token | exec | hub, endpoint | userId, minutesToExpire, clientType | Generate token for the client to connect Azure Web PubSub service. Generate token for the client to connect Azure Web PubSub service. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
hub | string | |
clientType | string | The type of client. Case-insensitive. If not set, it's "Default". For Web PubSub for Socket.IO, only the default value is supported. For Web PubSub, the valid values are 'Default' and 'MQTT'. Known values are: "Default" and "MQTT". Default value is None. |
minutesToExpire | integer | The expire time of the generated token. Default value is None. |
userId | string | User Id. Default value is None. |
Lifecycle Methods​
- generate_client_token
Generate token for the client to connect Azure Web PubSub service. Generate token for the client to connect Azure Web PubSub service.
EXEC azure.messaging_webpubsubservice.generate_client_tokens.generate_client_token
@hub='{{ hub }}' --required,
@endpoint='{{ endpoint }}' --required,
@userId='{{ userId }}',
@minutesToExpire='{{ minutesToExpire }}',
@clientType='{{ clientType }}'
;