@fluidframework/azure-client Package

Packages > @fluidframework/azure-client

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

Classes

List of classes contained in this package or namespace
Class Description
AzureAudience
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 Token Provider implementation for connecting to an Azure Function endpoint for Azure Fluid Relay token resolution.

Enumerations

List of enums contained in this package or namespace
Enumeration Description
ScopeType Defines scope access for a Container/Document

Interfaces

List of interfaces contained in this package or namespace
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 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 interface to include this service-specific value. *
ITokenClaims JSON Web Token (JWT) ClaimsSee 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.

Type Aliases

List of type aliases contained in this package or namespace
Type Alias 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

Enumerations

ScopeType enum

Defines scope access for a Container/Document

Signature:

export declare enum ScopeType 

Enumeration Members

List of members in use in this enum
Member Value Description
DocRead "doc:read" Read access is supported on the Container/Document
DocWrite "doc:write" Write access is supported on the Container/Document
SummaryWrite "summary:write" User can generate new summaries operations

Type Aliases

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>;