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.
Pfadparameter
agent_name
string
Erforderlich
The name of the agent to delete.
Abfrageparameter
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
Erforderlich
The API version to use for this operation.
Antworten
The request has succeeded.
Text
Content-Type: application/json
object
enum
Erforderlich
The object type. Always 'agent.deleted'.
agent.deleted
name
string
Erforderlich
The name of the agent.
deleted
boolean
Erforderlich
Whether the agent was successfully deleted.
Anfordern
DELETE /agents/{agent_name} HTTP/1.1Antwort
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json