AgentsOperations interface
Interface representing a Agents operations.
Properties
| delete | Deletes an agent. |
| delete |
Deletes a specific version of an agent. |
| get | Retrieves the agent. |
| get |
Retrieves a specific version of an agent. |
| list | Returns the list of all agents. |
| list |
Returns the list of versions of an agent. |
| stream |
Container log entry streamed from the container as text chunks. Each chunk is a UTF-8 string that may be either a plain text log line or a JSON-formatted log entry, depending on the type of container log being streamed. Clients should treat each chunk as opaque text and, if needed, attempt to parse it as JSON based on their logging requirements. For system logs, the format is JSON with the following structure: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Successfully connected to events server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1} For console logs, the format is plain text as emitted by the container's stdout/stderr. 2025-12-15T08:43:48.72656 Connecting to the container 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK |
Methods
| create(string, Agent |
Creates an agent from a definition. |
| create(string, string, Record<string, any>, Agents |
Creates an agent from a manifest. |
| create |
Create a new agent version from a definition. |
| create |
Create a new agent version from a manifest. |
| update(string, Agent |
Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version. |
| update(string, string, Record<string, any>, Agents |
Updates the agent from a manifest by adding a new version if there are any changes. If no changes, returns the existing agent version. |
Property Details
delete
Deletes an agent.
delete: (agentName: string, options?: AgentsDeleteAgentOptionalParams) => Promise<DeleteAgentResponse>Property Value
(agentName: string, options?: AgentsDeleteAgentOptionalParams) => Promise<DeleteAgentResponse>
deleteVersion
Deletes a specific version of an agent.
deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteAgentVersionOptionalParams) => Promise<DeleteAgentVersionResponse>Property Value
(agentName: string, agentVersion: string, options?: AgentsDeleteAgentVersionOptionalParams) => Promise<DeleteAgentVersionResponse>
get
Retrieves the agent.
get: (agentName: string, options?: AgentsGetAgentOptionalParams) => Promise<Agent>Property Value
(agentName: string, options?: AgentsGetAgentOptionalParams) => Promise<Agent>
getVersion
Retrieves a specific version of an agent.
getVersion: (agentName: string, agentVersion: string, options?: AgentsGetAgentVersionOptionalParams) => Promise<AgentVersion>Property Value
(agentName: string, agentVersion: string, options?: AgentsGetAgentVersionOptionalParams) => Promise<AgentVersion>
list
Returns the list of all agents.
list: (options?: AgentsListAgentsOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>Property Value
(options?: AgentsListAgentsOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>
listVersions
Returns the list of versions of an agent.
listVersions: (agentName: string, options?: AgentsListAgentVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>Property Value
(agentName: string, options?: AgentsListAgentVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>
streamAgentContainerLogs
Container log entry streamed from the container as text chunks. Each chunk is a UTF-8 string that may be either a plain text log line or a JSON-formatted log entry, depending on the type of container log being streamed. Clients should treat each chunk as opaque text and, if needed, attempt to parse it as JSON based on their logging requirements.
For system logs, the format is JSON with the following structure: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Successfully connected to events server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}
For console logs, the format is plain text as emitted by the container's stdout/stderr. 2025-12-15T08:43:48.72656 Connecting to the container 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK
streamAgentContainerLogs: (agentName: string, agentVersion: string, options?: AgentsStreamAgentContainerLogsOptionalParams) => Promise<void>Property Value
(agentName: string, agentVersion: string, options?: AgentsStreamAgentContainerLogsOptionalParams) => Promise<void>
Method Details
create(string, AgentDefinitionUnion, AgentsCreateAgentOptionalParams)
Creates an agent from a definition.
function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateAgentOptionalParams): Promise<Agent>Parameters
- name
-
string
- definition
- AgentDefinitionUnion
- options
- AgentsCreateAgentOptionalParams
Returns
Promise<Agent>
create(string, string, Record<string, any>, AgentsCreateAgentFromManifestOptionalParams)
Creates an agent from a manifest.
function create(name: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>Parameters
- name
-
string
- manifestId
-
string
- parameterValues
-
Record<string, any>
Returns
Promise<Agent>
createVersion(string, AgentDefinitionUnion, AgentsCreateAgentVersionOptionalParams)
Create a new agent version from a definition.
function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateAgentVersionOptionalParams): Promise<AgentVersion>Parameters
- agentName
-
string
- definition
- AgentDefinitionUnion
Returns
Promise<AgentVersion>
createVersion(string, string, Record<string, any>, AgentsCreateAgentVersionFromManifestOptionalParams)
Create a new agent version from a manifest.
function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>Parameters
- agentName
-
string
- manifestId
-
string
- parameterValues
-
Record<string, any>
Returns
Promise<AgentVersion>
update(string, AgentDefinitionUnion, AgentsUpdateAgentOptionalParams)
Updates the agent by adding a new version if there are any changes to the agent definition. If no changes, returns the existing agent version.
function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateAgentOptionalParams): Promise<Agent>Parameters
- agentName
-
string
- definition
- AgentDefinitionUnion
- options
- AgentsUpdateAgentOptionalParams
Returns
Promise<Agent>
update(string, string, Record<string, any>, AgentsUpdateAgentFromManifestOptionalParams)
Updates the agent from a manifest by adding a new version if there are any changes. If no changes, returns the existing agent version.
function update(agentName: string, manifestId: string, parameterValues: Record<string, any>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>Parameters
- agentName
-
string
- manifestId
-
string
- parameterValues
-
Record<string, any>
Returns
Promise<Agent>
