AgentsOperations interface

Создаёт новую сессию для эндпоинта агента. Конечная точка разрешает версию бэкинг-агента и version_indicator обеспечивает владение сессией с помощью предоставленного ключа изоляции для операций по мутации сессии.

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

Значение свойства

Создаёт новую версию агента из кода. Загружает почтовый индекс и создаёт новую версию для существующего агента. Шестнадцатеричный дайджест zip-файла SHA-256 x-ms-code-zip-sha256 предоставлен в заголовке для обеспечения целостности и дедапа. Тело запроса — это многокомпонентные/формы-данные с JSON-метаданными и бинарной частью кода (порядок деталей не имеет значения). Максимальный размер загрузки — 250 МБ.

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

Значение свойства

Удаляет агент. Для размещённых агентов, если в любой версии есть активные сессии, запрос отклоняется с помощью HTTP 409, если force не установлен true. Когда сила реализована, все связанные сессии удаляются каскадно вместе с агентом и его версиями.

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

Значение свойства

Синхронно удаляет сессию. Возвращает 204 No Content, когда сессия удалена или не существует.

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

Значение свойства

Удаляет указанный файл или папку из песочницы сессии. Когда recursive false, удаление непустого каталога возвращает 409 Conflict.

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

Значение свойства

Удаляет определенную версию агента. Для размещённых агентов, если в версии есть активные сессии, запрос отклоняется с помощью HTTP 409, если force не установлен true. Когда сила реализована, все сессии, связанные с этой версией, удаляются по каскаду.

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

Значение свойства

Отключает указанный агент, не давая ему принимать новые сессии или обрабатывать запросы. Существующие активные сессии позволяют сливаться изящно, но новые сессии не могут быть созданы. Эта операция идемпотентна — отключение уже отключённого агента приносит успех без побочных эффектов.

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

Значение свойства

Скачивает почтовый индекс для агента, основанного на коде. Возвращает ранее загруженный zip (application/zip).

Если agent_version он предоставлен, возвращает почтовый индекс этой версии; в противном случае возвращает почтовый индекс последней версии.

Дайджест SHA-256 возвращённых байтов совпадает с content_hash . на разрешенной версии code_configuration.

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

Значение свойства

Загружает файл по указанному пути песочницы в виде бинарного потока. Путь разрешается относительно домашней директории сессии.

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

Значение свойства

Включает указанный агент, позволяющий принимать новые сессии и запросы на обработку. Эта операция идемпотентна — включение уже активного агента приносит успех без побочных эффектов.

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

Значение свойства

Извлекает агента.

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

Значение свойства

Получает данные о сессии размещённого агента по имени агента и идентификатору сессии.

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

Значение свойства

Транслирует консольные логи (stdout / stderr) для конкретной сессии размещённого агента в виде потока Server-Sent Events (SSE).

Каждый кадр SSE содержит:

• event: всегда "log"
• data: лог-линия с открытым текстом (в настоящее время в формате JSON, но схема не является контрактной и может включать дополнительные ключи или менять формат со временем — клиенты должны рассматривать её как непрозрачную строку)

Примеры кадров 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"}

Поток остаётся открытым до тех пор, пока клиент не отключится или сервер не завершит соединение. Клиенты должны заниматься переподключением по мере необходимости.

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

Значение свойства

Извлекает определенную версию агента.

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

Значение свойства

Возвращает список всех агентов.

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

Значение свойства

Возвращает файлы и каталоги по указанному пути в песочнице сессии. Ответ включает только непосредственные дочерние данные целевого каталога и по умолчанию переключается на домашний каталог сессии, если путь не поставляется.

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

Значение свойства

Возвращает страницированную коллекцию сессий, связанных с указанной конечной точкой агента.

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

Значение свойства

Возвращает список версий агента.

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

Значение свойства

Завершает указанную сессию размещённого агента и возвращает 204 No Content при успешном выполнении запроса.

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

Значение свойства

Применяет обновление merge-patch к указанной конфигурации конечной точки агента.

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

Значение свойства

Загружает содержимое бинарного файла на указанный путь в песочнице сессии. Сервис хранит файл относительно домашней папки сессии и отклоняет полезные нагрузки объемом более 50 МБ.

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

Значение свойства

Создает агент.

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

Параметры

Возвращаемое значение

Создает агента из манифеста.

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

Параметры

Возвращаемое значение

Создайте новую версию агента.

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

Параметры

Возвращаемое значение

Создайте новую версию агента из манифеста.

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

Параметры

Возвращаемое значение

Обновляет агент путем добавления новой версии, если в определение агента вносятся какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

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

Параметры

Возвращаемое значение

Обновляет агент из манифеста, добавив новую версию, если в определении агента есть какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

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

Параметры

Возвращаемое значение