AgentsOperations interface

Tworzy nową sesję dla endpointu agenta. Punkt końcowy rozwiązuje wersję agenta wspierającego i version_indicator wymusza własność sesji za pomocą dostarczonego klucza izolacyjnego dla operacji mutujących sesję.

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

Wartość właściwości

Tworzy nową wersję agenta z kodu. Przesyła kod pocztowy i tworzy nową wersję dla istniejącego agenta. W nagłówku x-ms-code-zip-sha256 znajduje się hex digest SHA-256 dla integralności i duplikacji. Ciało żądania składa się z danych wieloczęściowych/formowych z częścią metadanych JSON oraz częścią kodu binarnego (kolejność części nie ma znaczenia). Maksymalny rozmiar wysyłania to 250 MB.

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

Wartość właściwości

Usuwa agenta. Dla hostowanych agentów, jeśli jakaś wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy force jest prawdziwy, wszystkie powiązane sesje są kaskadowo usuwane wraz z agentem i jego wersjami.

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

Wartość właściwości

Usuwa sesję synchronicznie. Zwraca 204 Brak treści, gdy sesja zostanie usunięta lub nie istnieje.

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

Wartość właściwości

Usuwa określony plik lub katalog z piaskownicy sesji. Gdy recursive jest false, usunięcie niepustego katalogu zwraca 409 Conflict.

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

Wartość właściwości

Usuwa określoną wersję agenta. Dla hostowanych agentów, jeśli wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy wysiłek jest prawdziwy, wszystkie sesje związane z tą wersją są kaskadowo usuwane.

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

Wartość właściwości

Wyłącza wskazanego agenta, uniemożliwiając mu przyjmowanie nowych sesji lub przetwarzanie żądań. Istniejące aktywne sesje mogą się spokojnie odprowadzać, ale nie można tworzyć nowych sesji. Ta operacja jest idempotentna — unieruchomienie już niepełnosprawnego czynnika przynosi sukces bez skutków ubocznych.

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

Wartość właściwości

Pobiera kod pocztowy agenta hostowanego na bazie kodu. Zwraca wcześniej przesłany zip (application/zip).

Jeśli agent_version jest podany, zwraca kod pocztowe tej wersji; w przeciwnym razie zwraca kod pocztowy najnowszej wersji.

Digest SHA-256 zwróconych bajtów odpowiada wersji content_hashcode_configurationrozdzielonej.

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

Wartość właściwości

Pobiera plik na określonej ścieżce piaskownicy jako strumień binarny. Ścieżka jest rozstrzygana względem katalogu sesji macierzystej.

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

Wartość właściwości

Umożliwia wskazanego agenta, umożliwiając mu przyjmowanie nowych sesji i przetwarzanie żądań. Ta operacja jest idempotentna — umożliwiając, aby już aktywowany agent przynosił sukces bez skutków ubocznych.

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

Wartość właściwości

Pobiera agenta.

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

Wartość właściwości

Pobiera szczegóły sesji hostowanego agenta według nazwy agenta i identyfikatora sesji.

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

Wartość właściwości

Streamuje logi konsolowe (stdout / stderr) dla konkretnej hostowanej sesji agenta jako strumień Server-Sent Events (SSE).

Każda ramka SSE zawiera:

• event: zawsze "log"
• data: linia logu w formacie zwykłego tekstu (obecnie w formacie JSON, ale schemat nie jest kontraktowy i może zawierać dodatkowe klucze lub zmieniać format z czasem — klienci powinni traktować go jako nieprzezroczysty ciąg danych)

Przykładowe ramki 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"}

Strumień pozostaje otwarty, dopóki klient się nie rozłączy lub serwer nie zakończy połączenia. Klienci powinni zajmować się ponownym połączeniem w razie potrzeby.

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

Wartość właściwości

Pobiera określoną wersję agenta.

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

Wartość właściwości

Zwraca listę wszystkich agentów.

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

Wartość właściwości

Zwraca pliki i katalogi na wyznaczonej ścieżce w piaskownicy sesji. Odpowiedź zawiera tylko bezpośrednie dzieci katalogu docelowego i domyślnie przyjmuje katalog sesji, gdy nie zostanie dostarczona żadna ścieżka.

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

Wartość właściwości

Zwraca stronicowaną kolekcję sesji powiązanych z określonym punktem końcowym agenta.

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

Wartość właściwości

Zwraca listę wersji agenta.

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

Wartość właściwości

Kończy określoną sesję hostowanego agenta i zwraca 204 No Content po pomyślnym zakończeniu żądania.

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

Wartość właściwości

Stosuje aktualizację merge-patch do określonej konfiguracji endpoint agenta.

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

Wartość właściwości

Przesyła zawartość pliku binarnego na określoną ścieżkę w sandboxie sesji. Usługa przechowuje plik względem katalogu sesji macierzystej i odrzuca ładunki większe niż 50 MB.

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

Wartość właściwości

Tworzy agenta.

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

Parametry

Zwraca

Tworzy agenta na podstawie manifestu.

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

Parametry

Zwraca

Utwórz nową wersję agenta.

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

Parametry

Zwraca

Utwórz nową wersję agenta na podstawie manifestu.

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

Parametry

Zwraca

Aktualizuje agenta, dodając nową wersję, jeśli nastąpią jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

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

Parametry

Zwraca

Aktualizuje agenta z manifestu, dodając nową wersję, jeśli istnieją jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

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

Parametry

Zwraca