Interface IManagementProviderService

Namespace

FoundationaLLM.Common.Interfaces

Assembly

FoundationaLLM.Common.dll

Provides core services required by the Management API.

public interface IManagementProviderService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

HandleDeleteAsync(string, UnifiedUserIdentity, Func<HttpMethod, ResourcePath, bool>?)

Handles a HTTP DELETE request for a specified resource path.

Task HandleDeleteAsync(string resourcePath, UnifiedUserIdentity userIdentity, Func<HttpMethod, ResourcePath, bool>? resourcePathAvailabilityChecker = null)

Parameters

resourcePath string

The resource path.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity with details about the identity of the user.

resourcePathAvailabilityChecker Func<HttpMethod, ResourcePath, bool>

An optional resource path availability checker used to block certain resource providers and resource types.

Returns

Task

HandleGetAsync(string, UnifiedUserIdentity, ResourceProviderGetOptions?, Func<HttpMethod, ResourcePath, bool>?)

Handles a HTTP GET request for a specified resource path.

Task<object> HandleGetAsync(string resourcePath, UnifiedUserIdentity userIdentity, ResourceProviderGetOptions? options = null, Func<HttpMethod, ResourcePath, bool>? resourcePathAvailabilityChecker = null)

Parameters

resourcePath string

The resource path.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity with details about the identity of the user.

options ResourceProviderGetOptions

The ResourceProviderGetOptions which provides operation parameters.

resourcePathAvailabilityChecker Func<HttpMethod, ResourcePath, bool>

An optional resource path availability checker used to block certain resource providers and resource types.

Returns

Task<object>

The serialized form of the result of handling the request.

HandlePostAsync(string, string?, ResourceProviderFormFile?, UnifiedUserIdentity, Func<HttpMethod, ResourcePath, bool>?, Func<object, bool>?)

Handles a HTTP POST request for a specified resource path.

Task<object> HandlePostAsync(string resourcePath, string? requestPayload, ResourceProviderFormFile? formFile, UnifiedUserIdentity userIdentity, Func<HttpMethod, ResourcePath, bool>? resourcePathAvailabilityChecker = null, Func<object, bool>? requestPayloadValidator = null)

Parameters

resourcePath string

The resource path.

requestPayload string

The optional request payload.

formFile ResourceProviderFormFile

The optional file attached to the request.

userIdentity UnifiedUserIdentity

The UnifiedUserIdentity with details about the identity of the user.

resourcePathAvailabilityChecker Func<HttpMethod, ResourcePath, bool>

An optional resource path availability checker used to block certain resource providers and resource types.

requestPayloadValidator Func<object, bool>

An optional function to validate the request payload after deserialization.

Returns

Task<object>

The serialized form of the result of handling the request.