Language

WebPubSubChatServiceClient.GetClientAccessUriAsync Method

Definition

Generates a client access URI that a client can use to connect to the Web PubSub Chat service. The URI includes a JWT access token as a query parameter.

public virtual System.Threading.Tasks.Task<Uri> GetClientAccessUriAsync(Azure.Messaging.WebPubSub.Chat.ClientAccessUriOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetClientAccessUriAsync : Azure.Messaging.WebPubSub.Chat.ClientAccessUriOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Uri>
override this.GetClientAccessUriAsync : Azure.Messaging.WebPubSub.Chat.ClientAccessUriOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Uri>
Public Overridable Function GetClientAccessUriAsync (Optional options As ClientAccessUriOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Uri)

Parameters

options
ClientAccessUriOptions

Options controlling the generated token. Pass null to use defaults.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

A Uri that a client can use to connect, with the access token included.

Applies to