@fluidframework/azure-client Package

Packages > @fluidframework/azure-client

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

Interfaces

Interface Description
AzureClientProps Props for initializing a new AzureClient instance
AzureConnectionConfig Parameters for establishing a connection with the Azure Fluid Relay.
AzureContainerServices AzureContainerServices is returned by the AzureClient alongside a FluidContainer. It 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. Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to use, will not be included here but rather on the FluidContainer class itself.
AzureContainerVersion Container version metadata.
AzureGetVersionsOptions Options for "Get Container Versions" API.
AzureLocalConnectionConfig Parameters for establishing a local connection with a local instance of the Azure Fluid Relay.
AzureMember 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 Parameters for establishing a remote connection with the Azure Fluid Relay.
AzureUser Since Azure provides user names for all of its members, we extend the IUser interface to include this service-specific value. *
ITokenClaims

JSON Web Token (JWT) Claims

See https://datatracker.ietf.org/doc/html/rfc7519#section-4

ITokenProvider Abstracts the token fetching mechanism for a hosting application. The hosting application is responsible for providing an implementation.
ITokenResponse
IUser Base user definition. It is valid to extend this interface when adding new details to the user object.

Classes

Class Alerts Description
AzureAudience Azure-specific ServiceAudience implementation.
AzureClient 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.
AzureFunctionTokenProvider DEPRECATED Token Provider implementation for connecting to an Azure Function endpoint for Azure Fluid Relay token resolution.

Enumerations

Enum Description
ContainerErrorType Different error types the Container may report out to the Host
ScopeType Defines scope access for a Container/Document

Types

TypeAlias Description
AzureConnectionConfigType 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 Audience object for Azure Fluid Relay containers
ICriticalContainerError Represents errors raised on container.

Enumeration Details

ContainerErrorType

Different error types the Container may report out to the Host

Signature 

export declare enum ContainerErrorType

Flags

Flag Description
clientSessionExpiredError Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and aids in safely deleting unused objects.
dataCorruptionError Data loss error detected by Container / DeltaManager. Likely points to storage issue.
dataProcessingError Error encountered when processing an operation. May correlate with data corruption.
genericError Some error, most likely an exception caught by runtime and propagated to container as critical error
throttlingError Throttling error from server. Server is busy and is asking not to reconnect for some time
usageError Error indicating an API is being used improperly resulting in an invalid operation.
clientSessionExpiredError

Error indicating an client session has expired. Currently this only happens when GC is allowed on a document and aids in safely deleting unused objects.

Signature 
clientSessionExpiredError = "clientSessionExpiredError"
dataCorruptionError

Data loss error detected by Container / DeltaManager. Likely points to storage issue.

Signature 
dataCorruptionError = "dataCorruptionError"
dataProcessingError

Error encountered when processing an operation. May correlate with data corruption.

Signature 
dataProcessingError = "dataProcessingError"
genericError

Some error, most likely an exception caught by runtime and propagated to container as critical error

Signature 
genericError = "genericError"
throttlingError

Throttling error from server. Server is busy and is asking not to reconnect for some time

Signature 
throttlingError = "throttlingError"
usageError

Error indicating an API is being used improperly resulting in an invalid operation.

Signature 
usageError = "usageError"

ScopeType

Defines scope access for a Container/Document

Signature 

export declare enum ScopeType

Flags

Flag Description
DocRead Read access is supported on the Container/Document
DocWrite Write access is supported on the Container/Document
SummaryWrite User can generate new summaries operations
DocRead

Read access is supported on the Container/Document

Signature 
DocRead = "doc:read"
DocWrite

Write access is supported on the Container/Document

Signature 
DocWrite = "doc:write"
SummaryWrite

User can generate new summaries operations

Signature 
SummaryWrite = "summary:write"

Type Details

AzureConnectionConfigType

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

Signature 

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

IAzureAudience

Audience object for Azure Fluid Relay containers

Signature 

export declare type IAzureAudience = IServiceAudience<AzureMember>;

ICriticalContainerError

Represents errors raised on container.

Signature 

export declare type ICriticalContainerError = IErrorBase;