Share via


AgentAdministrationClient Class

Definition

The AgentAdministrationClient sub-client.

public class AgentAdministrationClient
type AgentAdministrationClient = class
Public Class AgentAdministrationClient
Inheritance
AgentAdministrationClient

Constructors

Name Description
AgentAdministrationClient()

Initializes a new instance of AgentAdministrationClient for mocking.

AgentAdministrationClient(AgentAdministrationClientSettings)

Initializes a new instance of AgentAdministrationClient from a AgentAdministrationClientSettings.

AgentAdministrationClient(Uri, AgentAdministrationClientOptions)

Initializes a new instance of AgentsClient.

AgentAdministrationClient(Uri, AuthenticationTokenProvider, AgentAdministrationClientOptions)
AgentAdministrationClient(Uri, AuthenticationTokenProvider)

Initializes a new instance of AgentAdministrationClient.

Properties

Name Description
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name Description
CreateAgentVersion(String, ProjectsAgentDefinition, IDictionary<String, String>, String, AgentBlueprintReference, Nullable<AgentDefinitionOptInKeys>, CancellationToken)

Create a new agent version.

CreateAgentVersion(String, ProjectsAgentVersionCreationOptions, String, CancellationToken)

Create a new agent version.

CreateAgentVersionAsync(String, ProjectsAgentDefinition, IDictionary<String, String>, String, AgentBlueprintReference, Nullable<AgentDefinitionOptInKeys>, CancellationToken)

Create a new agent version.

CreateAgentVersionAsync(String, ProjectsAgentVersionCreationOptions, String, CancellationToken)

Create a new agent version.

CreateAgentVersionFromManifest(String, String, AgentManifestOptions, CancellationToken)
CreateAgentVersionFromManifestAsync(String, String, AgentManifestOptions, CancellationToken)
CreateSession(String, String, VersionIndicator, String, CancellationToken)

Creates a new session for an agent endpoint. The endpoint resolves the backing agent version from version_indicator and enforces session ownership using the provided isolation key for session-mutating operations.

CreateSessionAsync(String, String, VersionIndicator, String, CancellationToken)

Creates a new session for an agent endpoint. The endpoint resolves the backing agent version from version_indicator and enforces session ownership using the provided isolation key for session-mutating operations.

DeleteAgent(String, CancellationToken)

Deletes an agent.

DeleteAgentAsync(String, CancellationToken)

Deletes an agent.

DeleteAgentVersion(String, String, CancellationToken)

Deletes a specific version of an agent.

DeleteAgentVersionAsync(String, String, CancellationToken)

Deletes a specific version of an agent.

DeleteSession(String, String, String, CancellationToken)

Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist.

DeleteSessionAsync(String, String, String, CancellationToken)

Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist.

GetAgent(String, CancellationToken)

Retrieves the agent.

GetAgentAsync(String, CancellationToken)

Retrieves the agent.

GetAgents(Nullable<ProjectsAgentKind>, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns the list of all agents.

GetAgentsAsync(Nullable<ProjectsAgentKind>, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns the list of all agents.

GetAgentSessionFiles()
GetAgentSkills()
GetAgentToolboxes()
GetAgentVersion(String, String, CancellationToken)

Retrieves a specific version of an agent.

GetAgentVersionAsync(String, String, CancellationToken)

Retrieves a specific version of an agent.

GetAgentVersions(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns the list of versions of an agent.

GetAgentVersionsAsync(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns the list of versions of an agent.

GetSession(String, String, CancellationToken)

Retrieves a session by ID.

GetSessionAsync(String, String, CancellationToken)

Retrieves a session by ID.

GetSessionLogStream(String, String, String, CancellationToken)

Streams console logs (stdout / stderr) for a specific hosted agent session as a Server-Sent Events (SSE) stream. Each SSE frame contains:

  • `event`: always `"log"`
  • `data`: a plain-text log line (currently JSON-formatted, but the schema
is not contractual and may include additional keys or change format over time — clients should treat it as an opaque string) Example SSE frames: ``` event: log data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"} event: log data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."} event: log data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"} event: log data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"} ``` The stream remains open until the client disconnects or the server terminates the connection. Clients should handle reconnection as needed.
GetSessionLogStreamAsync(String, String, String, CancellationToken)

Streams console logs (stdout / stderr) for a specific hosted agent session as a Server-Sent Events (SSE) stream. Each SSE frame contains:

  • `event`: always `"log"`
  • `data`: a plain-text log line (currently JSON-formatted, but the schema
is not contractual and may include additional keys or change format over time — clients should treat it as an opaque string) Example SSE frames: ``` event: log data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"} event: log data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."} event: log data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"} event: log data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"} ``` The stream remains open until the client disconnects or the server terminates the connection. Clients should handle reconnection as needed.
GetSessions(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns a list of sessions for the specified agent.

GetSessionsAsync(String, Nullable<Int32>, Nullable<AgentListOrder>, String, String, CancellationToken)

Returns a list of sessions for the specified agent.

PatchAgentObject(String, PatchAgentOptions, CancellationToken)

Updates an agent endpoint.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
PatchAgentObjectAsync(String, PatchAgentOptions, CancellationToken)

Updates an agent endpoint.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to