WorkflowAgentDefinition Class

Definition

The workflow agent definition. Microsoft Foundry is retiring workflows on December 1, 2026. If you're looking to build new workflows, use Microsoft Agent Framework. To migrate existing workflows, see the Migration guide.

public class WorkflowAgentDefinition : Azure.AI.Projects.Agents.ProjectsAgentDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.WorkflowAgentDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.WorkflowAgentDefinition>
type WorkflowAgentDefinition = class
    inherit ProjectsAgentDefinition
    interface IJsonModel<WorkflowAgentDefinition>
    interface IPersistableModel<WorkflowAgentDefinition>
Public Class WorkflowAgentDefinition
Inherits ProjectsAgentDefinition
Implements IJsonModel(Of WorkflowAgentDefinition), IPersistableModel(Of WorkflowAgentDefinition)
Inheritance
WorkflowAgentDefinition
Implements

Properties

Name Description
ContentFilterConfiguration

Configuration for Responsible AI (RAI) content filtering and safety features.

(Inherited from ProjectsAgentDefinition)

Methods

Name Description
FromYaml(String)

Creates a new WorkflowAgentDefinition from a workflow YAML document.

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ProjectsAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IJsonModel<ProjectsAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IJsonModel<WorkflowAgentDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<WorkflowAgentDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ProjectsAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<ProjectsAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<ProjectsAgentDefinition>.Write(ModelReaderWriterOptions) (Inherited from ProjectsAgentDefinition)
IPersistableModel<WorkflowAgentDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<WorkflowAgentDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<WorkflowAgentDefinition>.Write(ModelReaderWriterOptions)

Applies to