AgentsOperations interface

Interfaz que representa las operaciones de los agentes.

Propiedades

createSession	Crea una nueva sesión para un endpoint agente. El endpoint resuelve la versión del agente de respaldo desde `version_indicator` y hace cumplir la propiedad de la sesión usando la clave de aislamiento proporcionada para las operaciones de mutación de sesión.
createVersionFromCode	Crea una nueva versión del agente a partir del código. Sube el código postal y crea una nueva versión para un agente existente. El resumen hexadecimal SHA-256 del zip se proporciona en el `x-ms-code-zip-sha256` encabezado para integridad y deduplicación. El cuerpo de la solicitud es multipart/formulario con una parte de metadatos JSON y una parte de código binario (el orden de las piezas es irrelevante). El tamaño máximo de subida es de 250 MB.
delete	Elimina un agente. Para los agentes alojados, si alguna versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que `force` se ponga como true. Cuando la fuerza es verdadera, todas las sesiones asociadas se eliminan en cascada junto con el agente y sus versiones.
deleteSession	Elimina una sesión de forma síncrona. Devuelve 204 Sin contenido cuando la sesión se elimina o no existe.
deleteSessionFile	Elimina el archivo o directorio especificado del sandbox de sesión. Cuando `recursive` es falso, eliminar un directorio no vacío devuelve 409 Conflicto.
deleteVersion	Elimina una versión específica de un agente. Para los agentes alojados, si la versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que `force` se ponga en true. Cuando la fuerza es verdadera, todas las sesiones asociadas a esta versión se eliminan en cascada.
disable	Desactiva el agente especificado, impidiéndole aceptar nuevas sesiones o procesar solicitudes. Las sesiones activas existentes pueden drenarse de forma elegante, pero no se pueden crear nuevas sesiones. Esta operación es idempotente: desactivar a un agente ya discapacitado devuelve el éxito sin efectos secundarios.
downloadAgentCode	Descarga el código postal de un agente alojado basado en código. Devuelve el código postal previamente subido (`application/zip`). Si `agent_version` se proporciona, devuelve el código zip de esa versión; de lo contrario, devuelve el código zip de la última versión. El resumen SHA-256 de los bytes devueltos coincide con el `content_hash` de la versión `code_configuration`resuelta .
downloadSessionFile	Descarga el archivo en la ruta sandbox especificada como un flujo binario. La ruta se resuelve en relación con el directorio principal de la sesión.
enable	Activa el agente especificado, permitiéndole aceptar nuevas sesiones y procesar solicitudes. Esta operación es idempotente: permitir que un agente ya habilitado devuelva el éxito sin efectos secundarios.
get	Recupera el agente.
getSession	Recupera los detalles de una sesión de agente alojada por nombre del agente e identificador de sesión.
getSessionLogStream	Transmite los registros de consola (stdout / stderr) para una sesión de agente alojada específica como un flujo de Server-Sent Eventos (SSE). Cada trama SSE contiene: `event`: siempre `"log"` `data`: una línea de registro en texto plano (actualmente con formato JSON, pero el esquema no es contractual y puede incluir claves adicionales o cambiar de formato con el tiempo — los clientes deben tratarla como una cadena opaca) Ejemplos de tramas 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"}` La transmisión permanece abierta hasta que el cliente se desconecta o el servidor termina la conexión. Los clientes deben gestionar la reconexión según sea necesario.
getVersion	Recupera una versión específica de un agente.
list	Devuelve la lista de todos los agentes.
listSessionFiles	Devuelve archivos y directorios en la ruta especificada en el sandbox de sesión. La respuesta incluye solo a los hijos inmediatos del directorio destino y por defecto pasa al directorio principal de la sesión cuando no se proporciona ruta.
listSessions	Devuelve una colección paginada de sesiones asociadas al punto final del agente especificado.
listVersions	Devuelve la lista de versiones de un agente.
patchAgentObject	Modifica un agente existente.
stopSession	Termina la sesión del agente alojado especificada y devuelve 204 Sin contenido cuando la solicitud tiene éxito.
updateAgent	Aplica una actualización de parche de fusión a la configuración de endpoint agente especificada.
uploadSessionFile	Sube el contenido binario de archivos a la ruta especificada en el sandbox de sesión. El servicio almacena el archivo en relación con el directorio principal de la sesión y rechaza cargas útiles mayores a 50 MB.

Métodos

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Crea el agente.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Crea un agente a partir de un manifiesto.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Cree una nueva versión del agente.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Cree una nueva versión del agente a partir de un manifiesto.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Actualiza el agente agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Actualiza el agente desde un manifiesto agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

createSession

Crea una nueva sesión para un endpoint agente. El endpoint resuelve la versión del agente de respaldo desde version_indicator y hace cumplir la propiedad de la sesión usando la clave de aislamiento proporcionada para las operaciones de mutación de sesión.

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

Valor de propiedad

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

createVersionFromCode

Crea una nueva versión del agente a partir del código. Sube el código postal y crea una nueva versión para un agente existente. El resumen hexadecimal SHA-256 del zip se proporciona en el x-ms-code-zip-sha256 encabezado para integridad y deduplicación. El cuerpo de la solicitud es multipart/formulario con una parte de metadatos JSON y una parte de código binario (el orden de las piezas es irrelevante). El tamaño máximo de subida es de 250 MB.

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

Valor de propiedad

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

delete

Elimina un agente. Para los agentes alojados, si alguna versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que force se ponga como true. Cuando la fuerza es verdadera, todas las sesiones asociadas se eliminan en cascada junto con el agente y sus versiones.

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

Valor de propiedad

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

deleteSession

Elimina una sesión de forma síncrona. Devuelve 204 Sin contenido cuando la sesión se elimina o no existe.

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

Valor de propiedad

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

deleteSessionFile

Elimina el archivo o directorio especificado del sandbox de sesión. Cuando recursive es falso, eliminar un directorio no vacío devuelve 409 Conflicto.

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

Valor de propiedad

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

deleteVersion

Elimina una versión específica de un agente. Para los agentes alojados, si la versión tiene sesiones activas, la solicitud se rechaza con HTTP 409 a menos que force se ponga en true. Cuando la fuerza es verdadera, todas las sesiones asociadas a esta versión se eliminan en cascada.

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

Valor de propiedad

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

disable

Desactiva el agente especificado, impidiéndole aceptar nuevas sesiones o procesar solicitudes. Las sesiones activas existentes pueden drenarse de forma elegante, pero no se pueden crear nuevas sesiones. Esta operación es idempotente: desactivar a un agente ya discapacitado devuelve el éxito sin efectos secundarios.

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

Valor de propiedad

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

downloadAgentCode

Descarga el código postal de un agente alojado basado en código. Devuelve el código postal previamente subido (application/zip).

Si agent_version se proporciona, devuelve el código zip de esa versión; de lo contrario, devuelve el código zip de la última versión.

El resumen SHA-256 de los bytes devueltos coincide con el content_hash de la versión code_configurationresuelta .

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

Valor de propiedad

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

downloadSessionFile

Descarga el archivo en la ruta sandbox especificada como un flujo binario. La ruta se resuelve en relación con el directorio principal de la sesión.

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

Valor de propiedad

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

enable

Activa el agente especificado, permitiéndole aceptar nuevas sesiones y procesar solicitudes. Esta operación es idempotente: permitir que un agente ya habilitado devuelva el éxito sin efectos secundarios.

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

Valor de propiedad

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

get

Recupera el agente.

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

Valor de propiedad

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

getSession

Recupera los detalles de una sesión de agente alojada por nombre del agente e identificador de sesión.

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

Valor de propiedad

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

getSessionLogStream

Transmite los registros de consola (stdout / stderr) para una sesión de agente alojada específica como un flujo de Server-Sent Eventos (SSE).

Cada trama SSE contiene:

event: siempre "log"
data: una línea de registro en texto plano (actualmente con formato JSON, pero el esquema no es contractual y puede incluir claves adicionales o cambiar de formato con el tiempo — los clientes deben tratarla como una cadena opaca)

Ejemplos de tramas 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"}

La transmisión permanece abierta hasta que el cliente se desconecta o el servidor termina la conexión. Los clientes deben gestionar la reconexión según sea necesario.

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

Valor de propiedad

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

getVersion

Recupera una versión específica de un agente.

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

Valor de propiedad

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

list

Devuelve la lista de todos los agentes.

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

Valor de propiedad

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

listSessionFiles

Devuelve archivos y directorios en la ruta especificada en el sandbox de sesión. La respuesta incluye solo a los hijos inmediatos del directorio destino y por defecto pasa al directorio principal de la sesión cuando no se proporciona ruta.

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

Valor de propiedad

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

listSessions

Devuelve una colección paginada de sesiones asociadas al punto final del agente especificado.

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

Valor de propiedad

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

listVersions

Devuelve la lista de versiones de un agente.

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

Valor de propiedad

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

patchAgentObject

Modifica un agente existente.

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

Valor de propiedad

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

stopSession

Termina la sesión del agente alojado especificada y devuelve 204 Sin contenido cuando la solicitud tiene éxito.

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

Valor de propiedad

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

updateAgent

Aplica una actualización de parche de fusión a la configuración de endpoint agente especificada.

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

Valor de propiedad

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

uploadSessionFile

Sube el contenido binario de archivos a la ruta especificada en el sandbox de sesión. El servicio almacena el archivo en relación con el directorio principal de la sesión y rechaza cargas útiles mayores a 50 MB.

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

Valor de propiedad

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

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Crea el agente.

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

Parámetros

name: string

definition: AgentDefinitionUnion

options: AgentsCreateOptionalParams

Devoluciones

Promise<Agent>

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

Crea un agente a partir de un manifiesto.

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

Parámetros

name: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentFromManifestOptionalParams

Devoluciones

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Cree una nueva versión del agente.

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

Parámetros

agentName: string

definition: AgentDefinitionUnion

options: AgentsCreateVersionOptionalParams

Devoluciones

Promise<AgentVersion>

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

Cree una nueva versión del agente a partir de un manifiesto.

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

Parámetros

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentVersionFromManifestOptionalParams

Devoluciones

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Actualiza el agente agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

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

Parámetros

agentName: string

definition: AgentDefinitionUnion

options: AgentsUpdateOptionalParams

Devoluciones

Promise<Agent>

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

Actualiza el agente desde un manifiesto agregando una nueva versión si hay algún cambio en la definición del agente. Si no hay cambios, devuelve la versión existente del agente.

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

Parámetros

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsUpdateAgentFromManifestOptionalParams

Devoluciones

Promise<Agent>

AgentsOperations interface

Propiedades

Métodos

Detalles de las propiedades

createSession

Valor de propiedad

createVersionFromCode

Valor de propiedad

delete

Valor de propiedad

deleteSession

Valor de propiedad

deleteSessionFile

Valor de propiedad

deleteVersion

Valor de propiedad

disable

Valor de propiedad

downloadAgentCode

Valor de propiedad

downloadSessionFile

Valor de propiedad

enable

Valor de propiedad

get

Valor de propiedad

getSession

Valor de propiedad

getSessionLogStream

Valor de propiedad

getVersion

Valor de propiedad

list

Valor de propiedad

listSessionFiles

Valor de propiedad

listSessions

Valor de propiedad

listVersions

Valor de propiedad

patchAgentObject

Valor de propiedad

stopSession

Valor de propiedad

updateAgent

Valor de propiedad

uploadSessionFile

Valor de propiedad

Detalles del método

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Parámetros

Devoluciones

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

Parámetros

Devoluciones