AgentsOperations interface

Interface die de operaties van een agent vertegenwoordigt.

Eigenschappen

createSession	Maakt een nieuwe sessie aan voor een agent-endpoint. Het eindpunt lost de backingagentversie op en `version_indicator` dwingt sessie-eigendom af met behulp van de meegeleverde isolatiesleutel voor sessiemutatiebewerkingen.
createVersionFromCode	Maakt een nieuwe agentversie aan vanuit code. Uploadt de code postcode en maakt een nieuwe versie aan voor een bestaande agent. De SHA-256 hex-digest van de zip wordt in de `x-ms-code-zip-sha256` header geleverd voor integriteit en dedup. De request body bestaat uit multipart/form-data met een JSON-metadata-gedeelte en een binaire code-deel (partvolgorde is niet relevant). De maximale uploadgrootte is 250 MB.
delete	Hiermee verwijdert u een agent. Voor gehoste agenten, als een versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij `force` het op true is gezet. Wanneer force waar is, worden alle bijbehorende sessies samen met de agent en zijn versies gecascade-verwijderd.
deleteSession	Verwijdert een sessie synchroon. Retournert 204 Geen inhoud wanneer de sessie is verwijderd of niet bestaat.
deleteSessionFile	Verwijdert het opgegeven bestand of de map uit de sessiesandbox. Wanneer `recursive` is false, geeft het verwijderen van een niet-lege map 409 Conflict terug.
deleteVersion	Hiermee verwijdert u een specifieke versie van een agent. Voor gehoste agenten, als de versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij `force` het op true is gezet. Wanneer force waar is, worden alle sessies die aan deze versie zijn gekoppeld gecascade-verwijderd.
disable	Schakelt de opgegeven agent uit, waardoor deze geen nieuwe sessies accepteert of verzoeken verwerkt. Bestaande actieve sessies mogen soepel aflopen, maar er kunnen geen nieuwe sessies worden aangemaakt. Deze operatie is idempotent — het uitschakelen van een al uitgeschakeld middel levert succes op zonder bijwerkingen.
downloadAgentCode	Download de code-zip voor een code-gebaseerde gehoste agent. Retourneert de eerder geüploade zipcode (`application/zip`). Als `agent_version` is geleverd, wordt de postcode van die versie teruggegeven; anders wordt de postcode van de nieuwste versie teruggegeven. De SHA-256-digest van de teruggestuurde bytes komt overeen met die `content_hash` op de opgeloste versie van `code_configuration`.
downloadSessionFile	Downloadt het bestand op het opgegeven sandboxpad als een binaire stroom. Het pad wordt opgelost ten opzichte van de sessie-homemap.
enable	Maakt de opgegeven agent mogelijk, zodat deze nieuwe sessies kan accepteren en verzoeken kan verwerken. Deze operatie is idempotent — waardoor een reeds ingeschakelde agent succes oplevert zonder bijwerkingen.
get	Haalt de agent op.
getSession	Haalt de details van een gehoste agentsessie op via agentnaam en sessie-identificatie.
getSessionLogStream	Streams consolelogs (stdout / stderr) voor een specifieke gehoste agentsessie als een Server-Sent Events (SSE) stream. Elk SSE-frame bevat: `event`: altijd `"log"` `data`: een platte loglijn (momenteel JSON-opgemaakt, maar het schema is niet contractueel en kan extra sleutels bevatten of het formaat in de loop van de tijd wijzigen — clients moeten het behandelen als een ondoorzichtige string) Voorbeeldframes van SSE: `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"}` De stream blijft open totdat de client de verbinding verbreekt of de server de verbinding beëindigt. Klanten moeten de herverbinding indien nodig regelen.
getVersion	Haalt een specifieke versie van een agent op.
list	Geeft de lijst met alle agenten terug.
listSessionFiles	Retourneert bestanden en mappen op het opgegeven pad in de sessiesandbox. De respons bevat alleen de directe kinderen van de doelmap en schakelt standaard terug naar de sessie-homemap wanneer er geen pad wordt opgegeven.
listSessions	Geeft een gepagineerde verzameling sessies terug die gekoppeld zijn aan het opgegeven agent-eindpunt.
listVersions	Retourneert de lijst met versies van een agent.
patchAgentObject	Hiermee wijzigt u een bestaande agent.
stopSession	Beëindigt de gespecificeerde sessie van de gehoste agent en geeft 204 Geen Inhoud terug wanneer het verzoek succesvol is.
updateAgent	Past een merge-patch update toe op de opgegeven agent-endpointconfiguratie.
uploadSessionFile	Uploadt binaire bestandsinhoud naar het opgegeven pad in de sessiesandbox. De service slaat het bestand op ten opzichte van de sessie-thuismap en weigert payloads groter dan 50 MB.

Methoden

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Hiermee maakt u de agent.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Maakt een agent van een manifest.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Maak een nieuwe agentversie.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Maak een nieuwe agentversie op basis van een manifest.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Werkt de agent bij door een nieuwe versie toe te voegen als er wijzigingen zijn in de agentdefinitie. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Hiermee werkt u de agent bij vanuit een manifest door een nieuwe versie toe te voegen als er wijzigingen in de agentdefinitie zijn. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

createSession

Maakt een nieuwe sessie aan voor een agent-endpoint. Het eindpunt lost de backingagentversie op en version_indicator dwingt sessie-eigendom af met behulp van de meegeleverde isolatiesleutel voor sessiemutatiebewerkingen.

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Waarde van eigenschap

(agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

createVersionFromCode

Maakt een nieuwe agentversie aan vanuit code. Uploadt de code postcode en maakt een nieuwe versie aan voor een bestaande agent. De SHA-256 hex-digest van de zip wordt in de x-ms-code-zip-sha256 header geleverd voor integriteit en dedup. De request body bestaat uit multipart/form-data met een JSON-metadata-gedeelte en een binaire code-deel (partvolgorde is niet relevant). De maximale uploadgrootte is 250 MB.

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

Waarde van eigenschap

(agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

delete

Hiermee verwijdert u een agent. Voor gehoste agenten, als een versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij force het op true is gezet. Wanneer force waar is, worden alle bijbehorende sessies samen met de agent en zijn versies gecascade-verwijderd.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Waarde van eigenschap

(agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

deleteSession

Verwijdert een sessie synchroon. Retournert 204 Geen inhoud wanneer de sessie is verwijderd of niet bestaat.

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

Waarde van eigenschap

(agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

deleteSessionFile

Verwijdert het opgegeven bestand of de map uit de sessiesandbox. Wanneer recursive is false, geeft het verwijderen van een niet-lege map 409 Conflict terug.

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

Waarde van eigenschap

(agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

deleteVersion

Hiermee verwijdert u een specifieke versie van een agent. Voor gehoste agenten, als de versie actieve sessies heeft, wordt het verzoek afgewezen met HTTP 409, tenzij force het op true is gezet. Wanneer force waar is, worden alle sessies die aan deze versie zijn gekoppeld gecascade-verwijderd.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Waarde van eigenschap

(agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

disable

Schakelt de opgegeven agent uit, waardoor deze geen nieuwe sessies accepteert of verzoeken verwerkt. Bestaande actieve sessies mogen soepel aflopen, maar er kunnen geen nieuwe sessies worden aangemaakt. Deze operatie is idempotent — het uitschakelen van een al uitgeschakeld middel levert succes op zonder bijwerkingen.

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

Waarde van eigenschap

(agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

downloadAgentCode

Download de code-zip voor een code-gebaseerde gehoste agent. Retourneert de eerder geüploade zipcode (application/zip).

Als agent_version is geleverd, wordt de postcode van die versie teruggegeven; anders wordt de postcode van de nieuwste versie teruggegeven.

De SHA-256-digest van de teruggestuurde bytes komt overeen met die content_hash op de opgeloste versie van code_configuration.

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

Waarde van eigenschap

(agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

downloadSessionFile

Downloadt het bestand op het opgegeven sandboxpad als een binaire stroom. Het pad wordt opgelost ten opzichte van de sessie-homemap.

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Waarde van eigenschap

(agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

enable

Maakt de opgegeven agent mogelijk, zodat deze nieuwe sessies kan accepteren en verzoeken kan verwerken. Deze operatie is idempotent — waardoor een reeds ingeschakelde agent succes oplevert zonder bijwerkingen.

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

Waarde van eigenschap

(agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

get

Haalt de agent op.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Waarde van eigenschap

(agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

getSession

Haalt de details van een gehoste agentsessie op via agentnaam en sessie-identificatie.

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

Waarde van eigenschap

(agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

getSessionLogStream

Streams consolelogs (stdout / stderr) voor een specifieke gehoste agentsessie als een Server-Sent Events (SSE) stream.

Elk SSE-frame bevat:

event: altijd "log"
data: een platte loglijn (momenteel JSON-opgemaakt, maar het schema is niet contractueel en kan extra sleutels bevatten of het formaat in de loop van de tijd wijzigen — clients moeten het behandelen als een ondoorzichtige string)

Voorbeeldframes van SSE:

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"}

De stream blijft open totdat de client de verbinding verbreekt of de server de verbinding beëindigt. Klanten moeten de herverbinding indien nodig regelen.

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Waarde van eigenschap

(agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

getVersion

Haalt een specifieke versie van een agent op.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Waarde van eigenschap

(agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

list

Geeft de lijst met alle agenten terug.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Waarde van eigenschap

(options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

listSessionFiles

Retourneert bestanden en mappen op het opgegeven pad in de sessiesandbox. De respons bevat alleen de directe kinderen van de doelmap en schakelt standaard terug naar de sessie-homemap wanneer er geen pad wordt opgegeven.

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

Waarde van eigenschap

(agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

listSessions

Geeft een gepagineerde verzameling sessies terug die gekoppeld zijn aan het opgegeven agent-eindpunt.

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

Waarde van eigenschap

(agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

listVersions

Retourneert de lijst met versies van een agent.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Waarde van eigenschap

(agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

patchAgentObject

Hiermee wijzigt u een bestaande agent.

patchAgentObject: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Waarde van eigenschap

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

stopSession

Beëindigt de gespecificeerde sessie van de gehoste agent en geeft 204 Geen Inhoud terug wanneer het verzoek succesvol is.

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

Waarde van eigenschap

(agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

updateAgent

Past een merge-patch update toe op de opgegeven agent-endpointconfiguratie.

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Waarde van eigenschap

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

uploadSessionFile

Uploadt binaire bestandsinhoud naar het opgegeven pad in de sessiesandbox. De service slaat het bestand op ten opzichte van de sessie-thuismap en weigert payloads groter dan 50 MB.

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

Waarde van eigenschap

(agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Hiermee maakt u de agent.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parameters

name: string

definition: AgentDefinitionUnion

options: AgentsCreateOptionalParams

Retouren

Promise<Agent>

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Maakt een agent van een manifest.

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parameters

name: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentFromManifestOptionalParams

Retouren

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Maak een nieuwe agentversie.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

Parameters

agentName: string

definition: AgentDefinitionUnion

options: AgentsCreateVersionOptionalParams

Retouren

Promise<AgentVersion>

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

Maak een nieuwe agentversie op basis van een manifest.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parameters

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentVersionFromManifestOptionalParams

Retouren

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Werkt de agent bij door een nieuwe versie toe te voegen als er wijzigingen zijn in de agentdefinitie. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parameters

agentName: string

definition: AgentDefinitionUnion

options: AgentsUpdateOptionalParams

Retouren

Promise<Agent>

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

Hiermee werkt u de agent bij vanuit een manifest door een nieuwe versie toe te voegen als er wijzigingen in de agentdefinitie zijn. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parameters

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsUpdateAgentFromManifestOptionalParams

Retouren

Promise<Agent>

AgentsOperations interface

Eigenschappen

Methoden

Eigenschapdetails

createSession

Waarde van eigenschap

createVersionFromCode

Waarde van eigenschap

delete

Waarde van eigenschap

deleteSession

Waarde van eigenschap

deleteSessionFile

Waarde van eigenschap

deleteVersion

Waarde van eigenschap

disable

Waarde van eigenschap

downloadAgentCode

Waarde van eigenschap

downloadSessionFile

Waarde van eigenschap

enable

Waarde van eigenschap

get

Waarde van eigenschap

getSession

Waarde van eigenschap

getSessionLogStream

Waarde van eigenschap

getVersion

Waarde van eigenschap

list

Waarde van eigenschap

listSessionFiles

Waarde van eigenschap

listSessions

Waarde van eigenschap

listVersions

Waarde van eigenschap

patchAgentObject

Waarde van eigenschap

stopSession

Waarde van eigenschap

updateAgent

Waarde van eigenschap

uploadSessionFile

Waarde van eigenschap

Methodedetails

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Parameters

Retouren

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Parameters

Retouren

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Parameters

Retouren

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

Parameters

Retouren

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Parameters

Retouren

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

Parameters

Retouren