AzureFunctionTokenProvider Class
Token Provider implementation for connecting to an Azure Function endpoint for Azure Fluid Relay token resolution.
This API is deprecated and will be removed in a future release.
1.2.0, This API will be removed in 2.0.0 No replacement since it is not expected anyone will use this token provider as is See https://github.com/microsoft/FluidFramework/issues/13693 for context
Signature
export declare class AzureFunctionTokenProvider implements ITokenProvider
Implements: ITokenProvider
Constructors
| Constructor | Description |
|---|---|
| (constructor)(azFunctionUrl, user) | Creates a new instance using configuration parameters. |
Methods
| Method | Return Type | Description |
|---|---|---|
| fetchOrdererToken(tenantId, documentId) | Promise<ITokenResponse> | |
| fetchStorageToken(tenantId, documentId) | Promise<ITokenResponse> |
Constructor Details
(constructor)
Creates a new instance using configuration parameters.
Signature
constructor(azFunctionUrl: string, user?: Pick<AzureMember<any>, "userId" | "userName" | "additionalDetails"> | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| azFunctionUrl | string | URL to Azure Function endpoint | |
| user | optional | Pick<AzureMember<any>, "userId" | "userName" | "additionalDetails"> | undefined | User object |
Method Details
fetchOrdererToken
Signature
fetchOrdererToken(tenantId: string, documentId?: string): Promise<ITokenResponse>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| tenantId | string | ||
| documentId | optional | string |
Returns
Return type: Promise<ITokenResponse>
fetchStorageToken
Signature
fetchStorageToken(tenantId: string, documentId: string): Promise<ITokenResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| tenantId | string | |
| documentId | string |
Returns
Return type: Promise<ITokenResponse>