Service Clients > @fluidframework/azure-client > AzureClientProps
AzureClientProps Interface
Props for initializing a new AzureClient instance
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export interface AzureClientProps
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| configProvider |
ALPHA
|
optional, readonly
|
IConfigProviderBase | Base interface for providing configurations to control experimental features. If unsure, leave this undefined. |
| connection |
ALPHA
|
readonly
|
AzureRemoteConnectionConfig | AzureLocalConnectionConfig | Configuration for establishing a connection with the Azure Fluid Relay. |
| logger |
ALPHA
|
optional, readonly
|
ITelemetryBaseLogger | Optional. A logger instance to receive diagnostic messages. |
| summaryCompression |
ALPHA
|
optional, readonly
|
boolean | ICompressionStorageConfig |
Property Details
configProvider (ALPHA)
Base interface for providing configurations to control experimental features. If unsure, leave this undefined.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
readonly configProvider?: IConfigProviderBase;
connection (ALPHA)
Configuration 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
readonly connection: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
logger (ALPHA)
Optional. A logger instance to receive diagnostic messages.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
readonly logger?: ITelemetryBaseLogger;
summaryCompression (ALPHA)
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
readonly summaryCompression?: boolean | ICompressionStorageConfig;