Service Clients > @fluidframework/azure-client

@fluidframework/azure-client Package

A simple and powerful way to consume collaborative Fluid data with the Azure Fluid Relay.

Interfaces

Interface Alerts Description
AzureClientProps ALPHA Props for initializing a new AzureClient instance
AzureConnectionConfig ALPHA Parameters for establishing a connection with the Azure Fluid Relay.
AzureContainerServices ALPHA Holds the functionality specifically tied to the Azure Fluid Relay, and how the data stored in the FluidContainer is persisted in the backend and consumed by users.
AzureContainerVersion ALPHA Container version metadata.
AzureGetVersionsOptions ALPHA Options for "Get Container Versions" API.
AzureLocalConnectionConfig ALPHA Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
AzureMember ALPHA Since Azure provides user names for all of its members, we extend the @fluidframework/protocol-definitions#IMember interface to include this service-specific value. It will be returned for all audience members connected to Azure.
AzureRemoteConnectionConfig ALPHA Parameters for establishing a remote connection with the Azure Fluid Relay.

Classes

Class Alerts Description
AzureClient ALPHA AzureClient provides the ability to have a Fluid object backed by the Azure Fluid Relay or, when running with local tenantId, have it be backed by a local Azure Fluid Relay instance.

Types

TypeAlias Alerts Description
AzureConnectionConfigType ALPHA

The type of connection.

- "local" for local connections to a Fluid relay instance running on the localhost

- "remote" for client connections to the Azure Fluid Relay service

IAzureAudience ALPHA Audience object for Azure Fluid Relay containers

Type Details

AzureConnectionConfigType (ALPHA)

The type of connection.

  • “local” for local connections to a Fluid relay instance running on the localhost

  • “remote” for client connections to the Azure Fluid Relay service

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

Signature

export type AzureConnectionConfigType = "local" | "remote";

IAzureAudience (ALPHA)

Audience object for Azure Fluid Relay containers

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

Signature

export type IAzureAudience = IServiceAudience<AzureMember>;