AzureClientProps Interface

Props for initializing a new AzureClient instance

Signature

export interface AzureClientProps

Properties

Property	Modifiers	Type	Description
configProvider	optional, readonly	IConfigProviderBase	Base interface for providing configurations to control experimental features. If unsure, leave this undefined.
connection	readonly	AzureRemoteConnectionConfig | AzureLocalConnectionConfig	Configuration for establishing a connection with the Azure Fluid Relay.
logger	optional, readonly	ITelemetryBaseLogger	Optional. A logger instance to receive diagnostic messages.
summaryCompression	optional, readonly	boolean | ICompressionStorageConfig

Property Details

configProvider

Base interface for providing configurations to control experimental features. If unsure, leave this undefined.

Signature

readonly configProvider?: IConfigProviderBase;

Type: IConfigProviderBase

connection

Configuration for establishing a connection with the Azure Fluid Relay.

Signature

readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;

Type: AzureRemoteConnectionConfig | AzureLocalConnectionConfig

logger

Optional. A logger instance to receive diagnostic messages.

Signature

readonly logger?: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

summaryCompression

Signature

readonly summaryCompression?: boolean | ICompressionStorageConfig;

Type: boolean | ICompressionStorageConfig