microsoft-foundry.rest.security.o-auth2-auth
Agents
Delete an agent
DELETE
/agents/{agent_name}
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.
路徑參數
agent_name
string
必要
The name of the agent to delete.
查詢參數
force
boolean
For Hosted Agents, if true, force-deletes the agent even if its versions have active sessions, cascading deletion to all associated sessions. The service defaults to false if a value is not specified by the caller. This value is not relevant for other Agent types.
api-version
string
必要
The API version to use for this operation.
回覆
The request has succeeded.
主體
Content-Type: application/json
object
enum
必要
The object type. Always 'agent.deleted'.
agent.deleted
name
string
必要
The name of the agent.
deleted
boolean
必要
Whether the agent was successfully deleted.
Request
DELETE /agents/{agent_name} HTTP/1.1回應
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json