AgentsOperations interface

Cria uma nova sessão para um endpoint agente. O endpoint resolve a versão do agente de backup a partir version_indicator e faz cumprir a propriedade da sessão usando a chave de isolamento fornecida para operações de mutação de sessão.

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

Valor de Propriedade

Cria uma nova versão do agente a partir do código. Carrega o código postal e cria uma nova versão para um agente existente. O digest hexadecimal SHA-256 do zip é fornecido no x-ms-code-zip-sha256 cabeçalho para integridade e deduplicação. O corpo do pedido é multipart/form-data com uma parte de metadados JSON e uma parte de código binário (a ordem das peças é irrelevante). O tamanho máximo de upload é de 250 MB.

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

Valor de Propriedade

Exclui um agente. Para agentes alojados, se alguma versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que force esteja definido como true. Quando a força é verdadeira, todas as sessões associadas são eliminadas em cascata, juntamente com o agente e as suas versões.

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

Valor de Propriedade

Apaga uma sessão de forma síncrona. Devolve 204 Sem Conteúdo quando a sessão é eliminada ou não existe.

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

Valor de Propriedade

Apaga o ficheiro ou diretório especificado do sandbox da sessão. Quando recursive é falso, eliminar um diretório não vazio devolve 409 Conflito.

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

Valor de Propriedade

Exclui uma versão específica de um agente. Para agentes alojados, se a versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que force esteja definido como true. Quando a força é verdadeira, todas as sessões associadas a esta versão são eliminadas em cascata.

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

Valor de Propriedade

Desativa o agente especificado, impedindo-o de aceitar novas sessões ou processar pedidos. As sessões ativas existentes podem drenar com graça, mas não podem ser criadas novas sessões. Esta operação é idempotente — desativar um agente já incapacitado traz sucesso sem efeitos secundários.

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

Valor de Propriedade

Descarrega o código postal de um agente hospedado baseado em código. Devolve o código postal previamente carregado (application/zip).

Se agent_version for fornecido, devolve o código zip dessa versão; caso contrário, devolve o código zip da versão mais recente.

O resumo SHA-256 dos bytes devolvidos corresponde ao content_hash da versão code_configurationresolvida .

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

Valor de Propriedade

Descarrega o ficheiro pelo caminho sandbox especificado como um fluxo binário. O caminho é resolvido em relação ao diretório inicial da sessão.

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

Valor de Propriedade

Ativa o agente especificado, permitindo-lhe aceitar novas sessões e processar pedidos. Esta operação é idempotente — permitir que um agente já habilitado retorne sucesso sem efeitos secundários.

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

Valor de Propriedade

Recupera o agente.

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

Valor de Propriedade

Recupera os detalhes de uma sessão de agente hospedada pelo nome do agente e identificador da sessão.

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

Valor de Propriedade

Transmite logs de consola (stdout / stderr) para uma sessão de agente alojada específica como um fluxo de Server-Sent Eventos (SSE).

Cada quadro SSE contém:

• event: sempre "log"
• data: uma linha de registo em texto simples (atualmente formatada em JSON, mas o esquema não é contratual e pode incluir chaves adicionais ou alterar o formato ao longo do tempo — os clientes devem tratá-la como uma cadeia opaca)

Exemplos de quadros 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"}

O fluxo permanece aberto até que o cliente se desconecte ou que o servidor termine a ligação. Os clientes devem tratar da reconexão conforme necessário.

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

Valor de Propriedade

Recupera uma versão específica de um agente.

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

Valor de Propriedade

Retorna a lista de todos os agentes.

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

Valor de Propriedade

Devolve ficheiros e diretórios no caminho especificado no sandbox da sessão. A resposta inclui apenas os filhos imediatos do diretório de destino e passa por defeito ao diretório principal da sessão quando não há caminho fornecido.

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

Valor de Propriedade

Devolve uma coleção paginada de sessões associadas ao endpoint do agente especificado.

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

Valor de Propriedade

Retorna a lista de versões de um agente.

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

Valor de Propriedade

Modifica um agente existente.

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

Valor de Propriedade

Termina a sessão do agente hospedado especificada e devolve 204 Sem Conteúdo quando o pedido tem sucesso.

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

Valor de Propriedade

Aplica uma atualização de fusão e patch à configuração de endpoint agente especificada.

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

Valor de Propriedade

Carrega o conteúdo binário do ficheiro para o caminho especificado no sandbox da sessão. O serviço armazena o ficheiro em relação ao diretório principal da sessão e rejeita cargas úteis superiores a 50 MB.

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

Valor de Propriedade

Cria o agente.

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

Parâmetros

Devoluções

Cria um agente a partir de um manifesto.

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

Parâmetros

Devoluções

Crie uma nova versão do agente.

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

Parâmetros

Devoluções

Crie uma nova versão do agente a partir de um manifesto.

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

Parâmetros

Devoluções

Atualiza o agente adicionando uma nova versão se houver alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

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

Parâmetros

Devoluções

Atualiza o agente a partir de um manifesto adicionando uma nova versão caso haja alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

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

Parâmetros

Devoluções