Service Clients > @fluidframework/azure-client > AzureConnectionConfig

AzureConnectionConfig Interface

Parameters for establishing a connection with the Azure Fluid Relay.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export interface AzureConnectionConfig

Properties

Property Alerts Type Description
endpoint ALPHA string URI to the Azure Fluid Relay service discovery endpoint.
tokenProvider ALPHA ITokenProvider Instance that provides Azure Fluid Relay endpoint tokens.
type ALPHA AzureConnectionConfigType The type of connection. Whether we're connecting to a remote Fluid relay server or a local instance.

Property Details

endpoint (ALPHA)

URI to the Azure Fluid Relay service discovery endpoint.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

endpoint: string;

tokenProvider (ALPHA)

Instance that provides Azure Fluid Relay endpoint tokens.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

tokenProvider: ITokenProvider;

type (ALPHA)

The type of connection. Whether we’re connecting to a remote Fluid relay server or a local instance.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

type: AzureConnectionConfigType;