AgentsOperations interface

Solicita o cancelamento de um trabalho em execução ou em fila. Retorna 409 de Conflito se o trabalho já estiver em estado terminal.

cancelOptimizationJob: (jobId: string, options?: AgentsCancelOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor da propriedade

Cria um trabalho de otimização e retorna o trabalho em fila. Honrarias Operation-Id por retentativa idempotente. Os clientes consultam a URL Operation-Location usando a operação get.

createOptimizationJob: (job: AgentOptimizationJob, options?: AgentsCreateOptimizationJobOptionalParams) => JobPoller<AgentOptimizationJobResult>

Valor da propriedade

Cria uma nova sessão para um endpoint agente. O endpoint resolve a versão do agente de suporte a partir version_indicator e aplica 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 da propriedade

Cria uma nova versão do agente a partir do código. Faz upload do código postal e cria uma nova versão para um agente existente. O resumo hexadecimal SHA-256 do zip é fornecido no x-ms-code-zip-sha256 cabeçalho para integridade e deduplicação. O corpo da requisição é multipart/formulário-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 é 250 MB.

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

Valor da propriedade

Exclui um agente. Para agentes hospedados, se alguma versão tiver sessões ativas, a solicitação é rejeitada com HTTP 409, a menos que force seja definida como true. Quando força é verdadeira, todas as sessões associadas são deletadas em cascata junto com o agente e suas versões.

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

Valor da propriedade

Cancela o trabalho ativo, depois exclui o trabalho e seus artefatos candidatos.

deleteOptimizationJob: (jobId: string, options?: AgentsDeleteOptimizationJobOptionalParams) => Promise<void>

Valor da propriedade

Exclui uma sessão de forma síncrona. Retorna 204 Sem Conteúdo quando a sessão é excluída ou não existe.

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

Valor da propriedade

Exclui o arquivo ou diretório especificado do sandbox da sessão. Quando recursive é falso, excluir um diretório não vazio retorna 409 Conflito.

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

Valor da propriedade

Exclui uma versão específica de um agente. Para agentes hospedados, se a versão tiver sessões ativas, a solicitação é rejeitada com HTTP 409, a menos que force seja definida como true. Quando força é verdadeira, todas as sessões associadas a esta versão são deletadas em cascata.

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

Valor da propriedade

Desabilita o agente especificado, impedindo que ele aceite novas sessões ou processe solicitações. Sessões ativas existentes podem drenar de forma elegante, mas nenhuma nova sessão pode ser criada. Essa operação é idempotente — desativar um agente já incapacitado retorna sucesso sem efeitos colaterais.

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

Valor da propriedade

Baixa o código postal de um agente hospedado baseado em código. Retorna o código postal previamente enviado (application/zip).

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

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

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

Valor da propriedade

Baixa o arquivo no 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 da propriedade

Habilita o agente especificado, permitindo que ele aceite novas sessões e processe solicitações. Essa operação é idempotente — permitindo que um agente já habilitado retorne o sucesso sem efeitos colaterais.

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

Valor da propriedade

Estima linhas de conjunto de validação, volumes de chamadas por estágio do modelo e faixas de custo sem submeter o trabalho.

estimateOptimizationJob: (inputs: AgentOptimizationEstimateInputs, options?: AgentsEstimateOptimizationJobOptionalParams) => Promise<AgentOptimizationEstimateResult>

Valor da propriedade

Recupera o agente.

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

Valor da propriedade

Gera o pacote de aplicativos Microsoft Teams (zip) para um agente Foundry a partir da solicitação de publicação fornecida, sem publicá-lo. Devolve o pacote do aplicativo como application/zip.

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

Valor da propriedade

Retorna valores padrão e anteriormente publicados usados para preencher uma solicitação de publicação do Microsoft 365 para um agente Foundry.

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

Valor da propriedade

Recupera um único candidato. Valores de mutação estão sempre incluídos.

getOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsGetOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor da propriedade

Recupera um trabalho de otimização por seu identificador.

getOptimizationJob: (jobId: string, options?: AgentsGetOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor da propriedade

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

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

Valor da propriedade

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

Cada quadro SSE contém:

• event: sempre "log"
• data: uma log line em texto simples (atualmente formatada em JSON, mas o esquema não é contratual e pode incluir chaves adicionais ou mudar de formato ao longo do tempo — os clientes devem tratá-la como uma string 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 o servidor encerre a conexão. Os clientes devem lidar com a reconexão conforme necessário.

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

Valor da propriedade

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

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

Valor da propriedade

Retorna a lista de todos os agentes.

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

Valor da propriedade

Lista os candidatos para o trabalho de otimização com paginação do cursor, incluindo a linha de base original e os candidatos gerados. Cada output.mutations item identifica um atributo alterado por type; campos de mutação value são omitidos, a menos que o cliente passe expand=mutationspor .

listOptimizationCandidates: (jobId: string, options?: AgentsListOptimizationCandidatesOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationCandidate, AgentOptimizationCandidate[], PageSettings>

Valor da propriedade

Lista trabalhos de otimização com paginação do cursor e filtros opcionais de status ou nome do agente.

listOptimizationJobs: (options?: AgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationJob, AgentOptimizationJob[], PageSettings>

Valor da propriedade

Retorna arquivos e diretórios no caminho especificado no sandbox da sessão. A resposta inclui apenas os filhos imediatos do diretório de destino e por padrão é direcionado ao diretório inicial da sessão quando nenhum caminho é fornecido.

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

Valor da propriedade

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

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

Valor da propriedade

Retorna a lista de versões de um agente.

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

Valor da propriedade

Modifica um agente existente.

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

Valor da propriedade

Promove um candidato para o agente Foundry armazenado na configuração de destino do trabalho pai. A promoção não está disponível quando o emprego foi omitido target_configuration. A promoção de prompt-agent cria uma nova versão de agente. Atualmente, a promoção com agente hospedado registra metadados da promoção sem implantar uma nova versão para agente hospedado.

promoteOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsPromoteOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor da propriedade

Publica um agente Foundry para Microsoft 365 / Microsoft Teams e retorna o título publicado e os IDs do app Teams.

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

Valor da propriedade

Encerra a sessão do agente hospedado especificada e retorna 204 Sem Conteúdo quando a solicitação é bem-sucedida.

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

Valor da propriedade

Aplica uma atualização de mesclarão na configuração de endpoint do agente especificada.

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

Valor da propriedade

Faz upload do conteúdo binário do arquivo para o caminho especificado no sandbox da sessão. O serviço armazena o arquivo em relação ao diretório inicial da sessão e rejeita cargas úteis maiores que 50 MB.

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

Valor da propriedade

Cria o agente.

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

Parâmetros

Retornos

Cria um agente a partir de um manifesto.

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

Parâmetros

Retornos

Crie uma nova versão do agente.

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

Parâmetros

Retornos

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

Retornos

Atualiza o agente adicionando uma nova versão se houver alguma alteração 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

Retornos

Atualiza o agente de um manifesto 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, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parâmetros

Retornos