Class ManagementClient

Namespace

FoundationaLLM.Client.Management

Assembly

FoundationaLLM.Client.Management.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class ManagementClient : IManagementClient

Inheritance

object

ManagementClient

Implements

IManagementClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

ManagementClient()

Constructor for mocking. This does not initialize the clients.

public ManagementClient()

ManagementClient(string, TokenCredential, string)

Initializes a new instance of the ManagementClient class with the specified Management API URI, TokenCredential, and Instance ID.

public ManagementClient(string managementUri, TokenCredential credential, string instanceId)

Parameters

managementUri string

The base URI of the Core API.

credential TokenCredential

A TokenCredential of an authenticated user or service principle from which the client library can generate auth tokens.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

ManagementClient(string, TokenCredential, string, APIClientSettings)

Initializes a new instance of the CoreClient class with the specified Core API URI, TokenCredential, and optional client settings.

public ManagementClient(string managementUri, TokenCredential credential, string instanceId, APIClientSettings options)

Parameters

managementUri string

The base URI of the Core API.

credential TokenCredential

A TokenCredential of an authenticated user or service principle from which the client library can generate auth tokens.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

options APIClientSettings

Additional options to configure the HTTP Client.

Properties

AIModels

Contains methods to interact with AIModel resources.

public IAIModelManagementClient AIModels { get; }

Property Value

IAIModelManagementClient

Agents

Contains methods to interact with Agent resources.

public IAgentManagementClient Agents { get; }

Property Value

IAgentManagementClient

Attachments

Contains methods to interact with Attachment resources.

public IAttachmentManagementClient Attachments { get; }

Property Value

IAttachmentManagementClient

Configuration

Contains methods to interact with Configuration resources.

public IConfigurationManagementClient Configuration { get; }

Property Value

IConfigurationManagementClient

DataSources

Contains methods to interact with DataSource resources.

public IDataSourceManagementClient DataSources { get; }

Property Value

IDataSourceManagementClient

Prompts

Contains methods to interact with Prompt resources.

public IPromptManagementClient Prompts { get; }

Property Value

IPromptManagementClient

Vectorization

Contains methods to interact with Vectorization resources.

public IVectorizationManagementClient Vectorization { get; }

Property Value

IVectorizationManagementClient

Methods

GetResourceByObjectId<T>(string)

Retrieves a resource by its ObjectId.

public Task<T> GetResourceByObjectId<T>(string objectId) where T : ResourceBase

Parameters

objectId string

The resource's Object ID (full resource path).

Returns

Task<T>

Returns a deserialized resource object.

Type Parameters

T

The type of resource to retrieve. It must be derived from ResourceBase.

GetResourceWithActionsAndRolesByObjectId<T>(string)

Retrieves a resource by its ObjectId, including actions and roles.

public Task<ResourceProviderGetResult<T>> GetResourceWithActionsAndRolesByObjectId<T>(string objectId) where T : ResourceBase

Parameters

objectId string

The resource's Object ID (full resource path).

Returns

Task<ResourceProviderGetResult<T>>

Returns a deserialized resource object and its list of allowed actions and roles.

Type Parameters

T

The type of resource to retrieve. It must be derived from ResourceBase.