GenerateClientTokenOptions interface

Pacchetto:: @azure/web-pubsub

Opzioni per la generazione di un token per connettere un client al servizio Pubub Web di Azure.

Extends: OperationOptions

Proprietà

clientProtocol	Tipo di protocollo del client `default`: client WebPubSub predefinito. URL connessione client di esempio: wss://exampleHost.com/client/hubs/exampleHub `mqtt`: client MQTT. URL di connessione client di esempio: wss://exampleHost.com/client/mqtt/hubs/exampleHub
expirationTimeInMinutes	Minuti fino alla scadenza del token.
groups	Gruppi da aggiungere quando il client si connette
roles	I ruoli di cui avrà la connessione con il token generato. I ruoli assegnano al client le autorizzazioni iniziali per uscire, partecipare o pubblicare ai gruppi quando si usa pubSub subprotocol `webpubsub.joinLeaveGroup`: il client può partecipare o lasciare qualsiasi gruppo `webpubsub.sendToGroup`: il client può inviare messaggi a qualsiasi gruppo `webpubsub.joinLeaveGroup.<group>`: il client può partecipare al gruppo o lasciare `<group>` `webpubsub.sendToGroup.<group>`: il client può inviare messaggi al gruppo `<group>` https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions
userId	Id utente per il client.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
onResponse	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions	Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
serializerOptions	Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

clientProtocol

Tipo di protocollo del client

default: client WebPubSub predefinito. URL connessione client di esempio: wss://exampleHost.com/client/hubs/exampleHub
mqtt: client MQTT. URL di connessione client di esempio: wss://exampleHost.com/client/mqtt/hubs/exampleHub

clientProtocol?: WebPubSubClientProtocol

Valore della proprietà

WebPubSubClientProtocol

expirationTimeInMinutes

Minuti fino alla scadenza del token.

expirationTimeInMinutes?: number

Valore della proprietà

number

groups

Gruppi da aggiungere quando il client si connette

groups?: string[]

Valore della proprietà

string[]

roles

I ruoli di cui avrà la connessione con il token generato. I ruoli assegnano al client le autorizzazioni iniziali per uscire, partecipare o pubblicare ai gruppi quando si usa pubSub subprotocol

webpubsub.joinLeaveGroup: il client può partecipare o lasciare qualsiasi gruppo
webpubsub.sendToGroup: il client può inviare messaggi a qualsiasi gruppo
webpubsub.joinLeaveGroup.<group>: il client può partecipare al gruppo o lasciare <group>
webpubsub.sendToGroup.<group>: il client può inviare messaggi al gruppo <group>

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

roles?: string[]

Valore della proprietà

string[]

userId

Id utente per il client.

userId?: string

Valore della proprietà

string

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da OperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

RawResponseCallback

Ereditato da OperationOptions.onResponse

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

OperationRequestOptions

Ereditato da OperationOptions.requestOptions

serializerOptions

Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.

serializerOptions?: SerializerOptions

Valore della proprietà

SerializerOptions

Ereditato da OperationOptions.serializerOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da OperationOptions.tracingOptions