AgentsOperations Class

Create a session.

Creates a new session for an agent endpoint. The endpoint resolves the backing agent version from version_indicator and enforces session ownership using the provided user identity for session-mutating operations.

create_session(agent_name: str, body: ~collections.abc.MutableMapping[str, ~typing.Any] | ~typing.IO[bytes] = <object object>, *, version_indicator: ~azure.ai.projects.models._models.VersionIndicator = <object object>, agent_session_id: str | None = None, **kwargs: ~typing.Any) -> AgentSessionResource

Parameters

Keyword-Only Parameters

Returns

Exceptions

Create an agent version.

Creates a new version for the specified agent and returns the created version resource.

create_version(agent_name: str, *, definition: _models.AgentDefinition, content_type: str = 'application/json', metadata: dict[str, str] | None = None, description: str | None = None, blueprint_reference: _models.AgentBlueprintReference | None = None, draft: bool | None = None, **kwargs: Any) -> _models.AgentVersionDetails

Parameters

Keyword-Only Parameters

Returns

Exceptions

Create an agent version from code.

Creates a new agent version from code. Uploads the code zip and creates a new version for an existing agent. The SHA-256 hex digest of the zip is provided in the x-ms-code-zip-sha256 header for integrity and dedup. The request body is multipart/form-data with a JSON metadata part and a binary code part (part order is irrelevant). Maximum upload size is 250 MB.

create_version_from_code(agent_name: str, *, definition: HostedAgentDefinition, code: IO[bytes], code_zip_sha256: str | None = None, description: str | None = None, metadata: dict[str, str] | None = None, **kwargs: Any) -> AgentVersionDetails

Parameters

Keyword-Only Parameters

Returns

Exceptions

Create an agent version from manifest.

Imports the provided manifest to create a new version for the specified agent.

create_version_from_manifest(agent_name: str, body: ~collections.abc.MutableMapping[str, ~typing.Any] | ~typing.IO[bytes] = <object object>, *, manifest_id: str = <object object>, parameter_values: dict[str, typing.Any] = <object object>, metadata: dict[str, str] | None = None, description: str | None = None, **kwargs: ~typing.Any) -> AgentVersionDetails

Parameters

Keyword-Only Parameters

Returns

Exceptions

Delete an agent.

Deletes an agent. For hosted agents, if any version has active sessions, the request is rejected with HTTP 409 unless force is set to true. When force is true, all associated sessions are cascade-deleted along with the agent and its versions.

delete(agent_name: str, *, force: bool | None = None, **kwargs: Any) -> DeleteAgentResponse

Parameters

Keyword-Only Parameters

Returns

Exceptions

Delete a session.

Deletes a session synchronously. Returns 204 No Content when the session is deleted or does not exist.

delete_session(agent_name: str, session_id: str, **kwargs: Any) -> None

Parameters

Returns

Exceptions

Delete a session file.

Deletes the specified file or directory from the session sandbox. When recursive is false, deleting a non-empty directory returns 409 Conflict.

delete_session_file(agent_name: str, session_id: str, *, path: str, recursive: bool | None = None, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Returns

Exceptions

Delete an agent version.

Deletes a specific version of an agent. For hosted agents, if the version has active sessions, the request is rejected with HTTP 409 unless force is set to true. When force is true, all sessions associated with this version are cascade-deleted.

delete_version(agent_name: str, agent_version: str, *, force: bool | None = None, **kwargs: Any) -> DeleteAgentVersionResponse

Parameters

Keyword-Only Parameters

Returns

Exceptions

Disable an agent.

Disables the specified agent, preventing it from accepting new sessions or processing requests. Existing active sessions are allowed to drain gracefully but no new sessions can be created. This operation is idempotent — disabling an already-disabled agent returns success with no side effects.

disable(agent_name: str, **kwargs: Any) -> None

Parameters

Returns

Exceptions

Download agent code.

Downloads the code zip for a code-based hosted agent. Returns the previously-uploaded zip (application/zip).

If agent_version is supplied, returns that version's code zip; otherwise returns the latest version's code zip.

The SHA-256 digest of the returned bytes matches the content_hash on the resolved version's code_configuration.

download_code(agent_name: str, *, agent_version: str | None = None, **kwargs: Any) -> Iterator[bytes]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Download a session file.

Downloads the file at the specified sandbox path as a binary stream. The path is resolved relative to the session home directory.

download_session_file(agent_name: str, session_id: str, *, path: str, **kwargs: Any) -> Iterator[bytes]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Enable an agent.

Enables the specified agent, allowing it to accept new sessions and process requests. This operation is idempotent — enabling an already-enabled agent returns success with no side effects.

enable(agent_name: str, **kwargs: Any) -> None

Parameters

Returns

Exceptions

Get an agent.

Retrieves an agent definition by its unique name.

get(agent_name: str, **kwargs: Any) -> AgentDetails

Parameters

Returns

Exceptions

Get a session.

Retrieves the details of a hosted agent session by agent name and session identifier.

get_session(agent_name: str, session_id: str, **kwargs: Any) -> AgentSessionResource

Parameters

Returns

Exceptions

Stream console logs for a hosted agent session.

Streams console logs (stdout / stderr) for a specific hosted agent session as a Server-Sent Events (SSE) stream.

Each SSE frame contains:

• event: always "log"

• data: a plain-text log line (currently JSON-formatted, but the schema is not contractual and may include additional keys or change format over time; clients should treat it as an opaque string)

Example SSE frames:

   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"}

The stream remains open until the client disconnects or the server terminates the connection. Clients should handle reconnection as needed.

get_session_log_stream(agent_name: str, agent_version: str, session_id: str, **kwargs: Any) -> SessionLogEvent

Parameters

Returns

Exceptions

Get an agent version.

Retrieves the specified version of an agent by its agent name and version identifier.

get_version(agent_name: str, agent_version: str, **kwargs: Any) -> AgentVersionDetails

Parameters

Returns

Exceptions

List agents.

Returns a paged collection of agent resources.

list(*, kind: str | AgentKind | None = None, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, **kwargs: Any) -> ItemPaged[AgentDetails]

Keyword-Only Parameters

Returns

Exceptions

List session files.

Returns files and directories at the specified path in the session sandbox. The response includes only the immediate children of the target directory and defaults to the session home directory when no path is supplied.

list_session_files(agent_name: str, session_id: str, *, path: str | None = None, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, **kwargs: Any) -> ItemPaged[SessionDirectoryEntry]

Parameters

Keyword-Only Parameters

Returns

Exceptions

List sessions for an agent.

Returns a paged collection of sessions associated with the specified agent endpoint.

list_sessions(agent_name: str, *, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, **kwargs: Any) -> ItemPaged[AgentSessionResource]

Parameters

Keyword-Only Parameters

Returns

Exceptions

List agent versions.

Returns a paged collection of versions for the specified agent.

list_versions(agent_name: str, *, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, include_drafts: bool | None = None, **kwargs: Any) -> ItemPaged[AgentVersionDetails]

Parameters

Keyword-Only Parameters

Returns

Exceptions

Stop a session.

Terminates the specified hosted agent session and returns 204 No Content when the request succeeds.

stop_session(agent_name: str, session_id: str, **kwargs: Any) -> None

Parameters

Returns

Exceptions

Update an agent endpoint.

Applies a merge-patch update to the specified agent endpoint configuration.

update_details(agent_name: str, body: ~collections.abc.MutableMapping[str, ~typing.Any] | ~typing.IO[bytes] = <object object>, *, agent_endpoint: ~azure.ai.projects.models._models.AgentEndpointConfig | None = None, agent_card: ~azure.ai.projects.models._models.AgentCard | None = None, **kwargs: ~typing.Any) -> AgentDetails

Parameters

Keyword-Only Parameters

Returns

Exceptions

Upload a session file.

Uploads binary file content to the specified path in the session sandbox. The service stores the file relative to the session home directory and rejects payloads larger than 50 MB.

upload_session_file(agent_name: str, session_id: str, content: bytes, *, path: str, **kwargs: Any) -> SessionFileWriteResult

Parameters

Keyword-Only Parameters

Returns

Exceptions