AgentsOperations interface

Rozhraní reprezentující operace agentů.

Vlastnosti

createSession	Vytváří novou relaci pro agentní endpoint. Koncový bod vyřeší verzi podpůrného agenta z a `version_indicator` vynucuje vlastnictví relace pomocí poskytnutého izolačního klíče pro operace mutace relací.
createVersionFromCode	Vytvoří novou verzi agenta z kódu. Nahraje kódové ZIP a vytvoří novou verzi pro stávajícího agenta. SHA-256 hexadecimální digest zipu je uveden v `x-ms-code-zip-sha256` hlavičce pro integritu a dedu. Tělo požadavku je vícedílné/formulářové data s částí metadat JSON a binárním kódem (pořadí částí není podstatné). Maximální velikost nahrávání je 250 MB.
delete	Odstraní agenta. U hostovaných agentů, pokud má nějaká verze aktivní relace, je požadavek zamítnut pomocí HTTP 409, pokud `force` není nastaven na true. Když je síla pravdivá, všechny přidružené relace jsou kaskádově smazány spolu s agentem a jeho verzemi.
deleteSession	Synchronně smaže relaci. Vrací 204 Žádný obsah, když je relace smazána nebo neexistuje.
deleteSessionFile	Smaže zadaný soubor nebo adresář ze sandboxu relace. Když `recursive` je false, smazání neprázdného adresáře vrátí konflikt 409.
deleteVersion	Odstraní konkrétní verzi agenta. U hostovaných agentů, pokud má verze aktivní relace, je požadavek zamítnut pomocí HTTP 409, pokud `force` není nastaven na true. Když je síla správná, všechny relace spojené s touto verzí jsou kaskádově smazány.
disable	Vyřadí specifikovaného agenta, čímž mu zabrání přijímat nové relace nebo zpracovávat požadavky. Stávající aktivní relace se mohou plynule vyprázdňovat, ale nelze vytvářet nové relace. Tato operace je idempotentní — vyřazení již postiženého agenta přináší úspěch bez vedlejších účinků.
downloadAgentCode	Stáhne kódový zip pro agenta hostovaného na kódu. Vrátí dříve nahraný zip (`application/zip`). Pokud `agent_version` je zadán, vrátí kód PSČ dané verze; jinak vrátí kód nejnovější verze. Digest vrácených bajtů v SHA-256 odpovídá rozlišení `content_hashcode_configuration`na rozlišení verze .
downloadSessionFile	Soubor stáhne na určené sandboxové cestě jako binární proud. Cesta je vyřešena vzhledem k domovskému adresáři relace.
enable	Umožňuje určenému agentovi, který přijímá nové relace a zpracovává požadavky. Tato operace je idempotentní — umožňuje, aby již aktivovaný agent přinesl úspěch bez vedlejších účinků.
get	Načte agenta.
getMicrosoft365Package	Generuje balíček aplikace Microsoft Teams (zip) pro agenta Foundry z dodaného požadavku na publikování, aniž by ho publikoval. Vrátí balíček aplikace jako `application/zip`.
getMicrosoft365PublishDefaults	Vrací výchozí a dříve publikované hodnoty použité k předvyplnění Microsoft 365 publikačního požadavku pro agenta Foundry.
getSession	Získává podrobnosti o hostované agentní relaci podle jména agenta a identifikátoru relace.
getSessionLogStream	Streamuje konzolové logy (stdout / stderr) pro konkrétní hostovanou agentní relaci jako stream Server-Sent Events (SSE). Každý SSE rámec obsahuje: `event`: vždy `"log"` `data`: logovací řádek v prostém textu (aktuálně formátovaný v JSON, ale schéma není smluvní a může obsahovat další klíče nebo měnit formát v průběhu času — klienti by jej měli považovat za neprůhledný řetězec) Příklady SSE rámců: `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"}` Stream zůstává otevřený, dokud se klient neodpojí nebo server neukončí připojení. Klienti by měli podle potřeby zajistit opětovné připojení.
getVersion	Načte konkrétní verzi agenta.
list	Vrátí seznam všech agentů.
listSessionFiles	Vrací soubory a adresáře na určené cestě v sandboxu relace. Odpověď zahrnuje pouze bezprostřední děti cílového adresáře a ve výchozím nastavení se přesune do adresáře relace v případě, že není poskytnuta žádná cesta.
listSessions	Vrací stránkovanou kolekci relací spojených s určeným koncovým bodem agenta.
listVersions	Vrátí seznam verzí agentu.
patchAgentObject	Upraví existujícího agenta.
publishToMicrosoft365	Publikuje agenta Foundry pro Microsoft 365 / Microsoft Teams a vrací publikovaný název a ID aplikací Teams.
stopSession	Ukončí specifikovanou hostovanou relaci agenta a vrátí 204 bez obsahu, když požadavek uspěje.
updateAgent	Aplikuje aktualizaci merge-patch na specifikovanou konfiguraci koncového bodu agenta.
uploadSessionFile	Nahraje binární obsah souboru na určenou cestu v sandboxu relace. Služba ukládá soubor vzhledem k domovskému adresáři relace a odmítá payloady větší než 50 MB.

Metody

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Vytvoří agenta.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Vytvoří agenta z manifestu.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Vytvořte novou verzi agenta.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Vytvořte novou verzi agenta z manifestu.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Aktualizuje agenta přidáním nové verze, pokud dojde k nějakým změnám v definici agenta. Pokud se nic nezmění, vrátí existující verzi agenta.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Aktualizuje agenta z manifestu přidáním nové verze, pokud dojde k nějakým změnám definice agenta. Pokud se nic nezmění, vrátí existující verzi agenta.

createSession

Vytváří novou relaci pro agentní endpoint. Koncový bod vyřeší verzi podpůrného agenta z a version_indicator vynucuje vlastnictví relace pomocí poskytnutého izolačního klíče pro operace mutace relací.

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

Hodnota vlastnosti

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

createVersionFromCode

Vytvoří novou verzi agenta z kódu. Nahraje kódové ZIP a vytvoří novou verzi pro stávajícího agenta. SHA-256 hexadecimální digest zipu je uveden v x-ms-code-zip-sha256 hlavičce pro integritu a dedu. Tělo požadavku je vícedílné/formulářové data s částí metadat JSON a binárním kódem (pořadí částí není podstatné). Maximální velikost nahrávání je 250 MB.

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

Hodnota vlastnosti

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

delete

Odstraní agenta. U hostovaných agentů, pokud má nějaká verze aktivní relace, je požadavek zamítnut pomocí HTTP 409, pokud force není nastaven na true. Když je síla pravdivá, všechny přidružené relace jsou kaskádově smazány spolu s agentem a jeho verzemi.

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

Hodnota vlastnosti

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

deleteSession

Synchronně smaže relaci. Vrací 204 Žádný obsah, když je relace smazána nebo neexistuje.

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

Hodnota vlastnosti

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

deleteSessionFile

Smaže zadaný soubor nebo adresář ze sandboxu relace. Když recursive je false, smazání neprázdného adresáře vrátí konflikt 409.

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

Hodnota vlastnosti

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

deleteVersion

Odstraní konkrétní verzi agenta. U hostovaných agentů, pokud má verze aktivní relace, je požadavek zamítnut pomocí HTTP 409, pokud force není nastaven na true. Když je síla správná, všechny relace spojené s touto verzí jsou kaskádově smazány.

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

Hodnota vlastnosti

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

disable

Vyřadí specifikovaného agenta, čímž mu zabrání přijímat nové relace nebo zpracovávat požadavky. Stávající aktivní relace se mohou plynule vyprázdňovat, ale nelze vytvářet nové relace. Tato operace je idempotentní — vyřazení již postiženého agenta přináší úspěch bez vedlejších účinků.

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

Hodnota vlastnosti

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

downloadAgentCode

Stáhne kódový zip pro agenta hostovaného na kódu. Vrátí dříve nahraný zip (application/zip).

Pokud agent_version je zadán, vrátí kód PSČ dané verze; jinak vrátí kód nejnovější verze.

Digest vrácených bajtů v SHA-256 odpovídá rozlišení content_hashcode_configurationna rozlišení verze .

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

Hodnota vlastnosti

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

downloadSessionFile

Soubor stáhne na určené sandboxové cestě jako binární proud. Cesta je vyřešena vzhledem k domovskému adresáři relace.

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

Hodnota vlastnosti

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

enable

Umožňuje určenému agentovi, který přijímá nové relace a zpracovává požadavky. Tato operace je idempotentní — umožňuje, aby již aktivovaný agent přinesl úspěch bez vedlejších účinků.

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

Hodnota vlastnosti

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

get

Načte agenta.

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

Hodnota vlastnosti

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

getMicrosoft365Package

Generuje balíček aplikace Microsoft Teams (zip) pro agenta Foundry z dodaného požadavku na publikování, aniž by ho publikoval. Vrátí balíček aplikace jako application/zip.

getMicrosoft365Package: (agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

Hodnota vlastnosti

(agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

getMicrosoft365PublishDefaults

Vrací výchozí a dříve publikované hodnoty použité k předvyplnění Microsoft 365 publikačního požadavku pro agenta Foundry.

getMicrosoft365PublishDefaults: (agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

Hodnota vlastnosti

(agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

getSession

Získává podrobnosti o hostované agentní relaci podle jména agenta a identifikátoru relace.

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

Hodnota vlastnosti

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

getSessionLogStream

Streamuje konzolové logy (stdout / stderr) pro konkrétní hostovanou agentní relaci jako stream Server-Sent Events (SSE).

Každý SSE rámec obsahuje:

event: vždy "log"
data: logovací řádek v prostém textu (aktuálně formátovaný v JSON, ale schéma není smluvní a může obsahovat další klíče nebo měnit formát v průběhu času — klienti by jej měli považovat za neprůhledný řetězec)

Příklady SSE rámců:

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

Stream zůstává otevřený, dokud se klient neodpojí nebo server neukončí připojení. Klienti by měli podle potřeby zajistit opětovné připojení.

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

Hodnota vlastnosti

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

getVersion

Načte konkrétní verzi agenta.

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

Hodnota vlastnosti

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

list

Vrátí seznam všech agentů.

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

Hodnota vlastnosti

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

listSessionFiles

Vrací soubory a adresáře na určené cestě v sandboxu relace. Odpověď zahrnuje pouze bezprostřední děti cílového adresáře a ve výchozím nastavení se přesune do adresáře relace v případě, že není poskytnuta žádná cesta.

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

Hodnota vlastnosti

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

listSessions

Vrací stránkovanou kolekci relací spojených s určeným koncovým bodem agenta.

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

Hodnota vlastnosti

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

listVersions

Vrátí seznam verzí agentu.

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

Hodnota vlastnosti

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

patchAgentObject

Upraví existujícího agenta.

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

Hodnota vlastnosti

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

publishToMicrosoft365

Publikuje agenta Foundry pro Microsoft 365 / Microsoft Teams a vrací publikovaný název a ID aplikací Teams.

publishToMicrosoft365: (agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

Hodnota vlastnosti

(agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

stopSession

Ukončí specifikovanou hostovanou relaci agenta a vrátí 204 bez obsahu, když požadavek uspěje.

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

Hodnota vlastnosti

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

updateAgent

Aplikuje aktualizaci merge-patch na specifikovanou konfiguraci koncového bodu agenta.

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

Hodnota vlastnosti

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

uploadSessionFile

Nahraje binární obsah souboru na určenou cestu v sandboxu relace. Služba ukládá soubor vzhledem k domovskému adresáři relace a odmítá payloady větší než 50 MB.

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

Hodnota vlastnosti

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

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Vytvoří agenta.

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

Parametry

name: string

definition: AgentDefinitionUnion

options: AgentsCreateOptionalParams

Návraty

Promise<Agent>

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

Vytvoří agenta z manifestu.

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

Parametry

name: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentFromManifestOptionalParams

Návraty

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Vytvořte novou verzi agenta.

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

Parametry

agentName: string

definition: AgentDefinitionUnion

options: AgentsCreateVersionOptionalParams

Návraty

Promise<AgentVersion>

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

Vytvořte novou verzi agenta z manifestu.

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

Parametry

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentVersionFromManifestOptionalParams

Návraty

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Aktualizuje agenta přidáním nové verze, pokud dojde k nějakým změnám v definici agenta. Pokud se nic nezmění, vrátí existující verzi agenta.

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

Parametry

agentName: string

definition: AgentDefinitionUnion

options: AgentsUpdateOptionalParams

Návraty

Promise<Agent>

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

Aktualizuje agenta z manifestu přidáním nové verze, pokud dojde k nějakým změnám definice agenta. Pokud se nic nezmění, vrátí existující verzi agenta.

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

Parametry

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsUpdateAgentFromManifestOptionalParams

Návraty

Promise<Agent>

AgentsOperations interface

Vlastnosti

Metody

Podrobnosti vlastnosti

createSession

Hodnota vlastnosti

createVersionFromCode

Hodnota vlastnosti

delete

Hodnota vlastnosti

deleteSession

Hodnota vlastnosti

deleteSessionFile

Hodnota vlastnosti

deleteVersion

Hodnota vlastnosti

disable

Hodnota vlastnosti

downloadAgentCode

Hodnota vlastnosti

downloadSessionFile

Hodnota vlastnosti

enable

Hodnota vlastnosti

get

Hodnota vlastnosti

getMicrosoft365Package

Hodnota vlastnosti

getMicrosoft365PublishDefaults

Hodnota vlastnosti

getSession

Hodnota vlastnosti

getSessionLogStream

Hodnota vlastnosti

getVersion

Hodnota vlastnosti

list

Hodnota vlastnosti

listSessionFiles

Hodnota vlastnosti

listSessions

Hodnota vlastnosti

listVersions

Hodnota vlastnosti

patchAgentObject

Hodnota vlastnosti

publishToMicrosoft365

Hodnota vlastnosti

stopSession

Hodnota vlastnosti

updateAgent

Hodnota vlastnosti

uploadSessionFile

Hodnota vlastnosti

Podrobnosti metody

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Parametry

Návraty

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

Parametry

Návraty

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Parametry

Návraty

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

Parametry

Návraty

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Parametry

Návraty

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

Parametry

Návraty