Azure.AI.Projects.Agents Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Classes

Name	Description
A2APreviewTool	An agent implementing the A2A protocol.
A2APreviewToolboxTool	An A2A tool stored in a toolbox.
A2AProtocolConfiguration	Configuration specific to the A2A protocol.
ActivityProtocolConfiguration	Configuration specific to the activity protocol.
AgentAdministrationClient	The AgentAdministrationClient sub-client.
AgentAdministrationClientOptions	Client options for Azure.AI.Projects.Agents.InternalProjectsClient.
AgentAdministrationClientSettings	Represents the settings used to configure a AgentAdministrationClient that can be loaded from an IConfigurationSection.
AgentAdministrationSettings	Represents the settings used to configure a AgentAdministrationClient that can be loaded from an IConfigurationSection.
AgentBlueprintReference	The AgentBlueprintReference. Please note this is the abstract base class. The derived classes available for instantiation are: ManagedAgentIdentityBlueprintReference.
AgentCard	The AgentCard.
AgentCardSkill	The AgentCardSkill.
AgentEndpointAuthorizationScheme	The AgentEndpointAuthorizationScheme. Please note this is the abstract base class. The derived classes available for instantiation are: EntraAuthorizationScheme, BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, and BotServiceTenantAuthorizationScheme.
AgentEndpointConfiguration	The AgentEndpointConfiguration.
AgentFromCodeOptions	Multipart request body for creating a new code-based agent (POST /agents). Inherits from CreateAgentVersionFromCodeContent for future extensibility.
AgentIdentity	The AgentIdentity.
AgentManifestOptions	The AgentManifestOptions.
AgentOptimizationJobs	The AgentOptimizationJobs sub-client.
AgentSessionFiles	Session-scoped file operations for hosted agent sandboxes. These endpoints enable uploading, downloading, listing, and deleting files within a live ADC sandbox session. All file content is streamed end-to-end (no buffering in Agents service memory). Sessions are scoped to agent endpoints (not individual versions), allowing the endpoint to evolve the backing agent version independently of the session lifecycle.
AgentsSkill	A skill resource.
AgentToolboxes	The AgentToolboxes sub-client.
AgentVersionFromCodeMetadata	JSON metadata for code-based agent operations (create, update, create version). The agent name comes from the URL path parameter or the `x-ms-agent-name` header, so it is not included in this model. The content hash (SHA-256 of the zip) is carried in the `x-ms-code-zip-sha256` header.
AzureAIProjectsAgentsContext	Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md
AzureAISearchTool	The input definition information for an Azure AI search tool as used to configure an agent.
AzureAISearchToolboxTool	An Azure AI Search tool stored in a toolbox.
AzureAISearchToolIndex	A AI Search Index resource.
AzureAISearchToolOptions	A set of index resources used by the `azure_ai_search` tool.
AzureFunctionBinding	The structure for keeping storage queue name and URI.
AzureFunctionDefinition	The definition of Azure function.
AzureFunctionDefinitionFunction	The AzureFunctionDefinitionFunction.
AzureFunctionStorageQueue	The structure for keeping storage queue name and URI.
AzureFunctionTool	The input definition information for an Azure Function Tool, as used to configure an Agent.
BingCustomSearchConfiguration	A bing custom search configuration.
BingCustomSearchPreviewTool	The input definition information for a Bing custom search tool as used to configure an agent.
BingCustomSearchToolOptions	The bing custom search tool parameters.
BingGroundingSearchConfiguration	Search configuration for Bing Grounding.
BingGroundingSearchToolOptions	The bing grounding search tool parameters.
BingGroundingTool	The input definition information for a bing grounding search tool as used to configure an agent.
BotServiceAuthorizationScheme	The BotServiceAuthorizationScheme.
BotServiceRbacAuthorizationScheme	The BotServiceRbacAuthorizationScheme.
BotServiceTenantAuthorizationScheme	The BotServiceTenantAuthorizationScheme.
BrowserAutomationPreviewTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
BrowserAutomationPreviewToolboxTool	A browser automation tool stored in a toolbox.
BrowserAutomationToolConnectionParameters	Definition of input parameters for the connection used by the Browser Automation Tool.
BrowserAutomationToolOptions	Definition of input parameters for the Browser Automation Tool.
CaptureStructuredOutputsTool	A tool for capturing structured outputs.
ClientConnectionProviderExtensions	Extension methods on ClientConnectionProvider that produce Foundry-project-specific agent clients.
CodeConfiguration	Code-based deployment configuration for a hosted agent.
CodeInterpreterToolboxTool	A code interpreter tool stored in a toolbox.
ContainerConfiguration	Container-based deployment configuration for a hosted agent.
ContentFilterConfiguration	Configuration for Responsible AI (RAI) content filtering and safety features.
CreateAgentVersionFromManifestRequest	The CreateAgentVersionFromManifestRequest.
DeclarativeAgentDefinition	The prompt agent definition.
EntraAuthorizationScheme	The EntraAuthorizationScheme.
ExternalAgentDefinition	The external agent definition. Represents a third-party agent hosted outside Foundry (for example, on GCP or AWS). Registration is metadata-only: Foundry records the agent definition to light up observability experiences (traces, evaluations) over customer-emitted OpenTelemetry data.
FabricDataAgentToolOptions	The fabric data agent tool parameters.
FabricIQPreviewTool	A FabricIQ server-side tool.
FabricIQPreviewToolboxTool	A FabricIQ tool stored in a toolbox.
FileSearchToolboxTool	A file search tool stored in a toolbox.
FixedRatioVersionSelectionRule	The FixedRatioVersionSelectionRule.
HeaderTelemetryEndpointAuth	Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.
HostedAgentDefinition	The hosted agent definition.
InvocationsProtocolConfiguration	Configuration specific to the invocations protocol.
InvocationsWsProtocolConfiguration	Configuration specific to the WebSocket-based invocations protocol.
ManagedAgentIdentityBlueprintReference	The ManagedAgentIdentityBlueprintReference.
McpProtocolConfiguration	Configuration specific to the MCP protocol.
MCPToolboxTool	An MCP tool stored in a toolbox.
McpToolExtensions	Extension methods on OpenAI.Responses.McpTool that expose Foundry-project-specific configuration (such as the project connection identifier).
MemorySearchPreviewTool	A tool for integrating memories into the agent.
MemorySearchToolOptions	Memory search options.
MicrosoftFabricPreviewTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
OpenAPIAnonymousAuthenticationDetails	Security details for OpenApi anonymous authentication.
OpenApiAuthenticationDetails	authentication details for OpenApiFunctionDefinition Please note this is the abstract base class. The derived classes available for instantiation are: OpenAPIAnonymousAuthenticationDetails, OpenApiProjectConnectionAuthenticationDetails, and OpenAPIManagedAuthenticationDetails.
OpenApiFunctionDefinition	The input definition information for an openapi function.
OpenAPIFunctionEntry	The OpenAPIFunctionEntry.
OpenAPIManagedAuthenticationDetails	Security details for OpenApi managed_identity authentication.
OpenAPIManagedSecurityScheme	Security scheme for OpenApi managed_identity authentication.
OpenApiProjectConnectionAuthenticationDetails	Security details for OpenApi project connection authentication.
OpenApiProjectConnectionSecurityScheme	Security scheme for OpenApi managed_identity authentication.
OpenAPITool	The input definition information for an OpenAPI tool as used to configure an agent.
OpenApiToolboxTool	An OpenAPI tool stored in a toolbox.
OptimizationAgentIdentifier	Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.
OptimizationCandidate	Aggregated evaluation result for a single candidate agent configuration across all tasks.
OptimizationDatasetCriterion	Evaluation criterion: a name + instruction pair used for per-item scoring.
OptimizationDatasetInput	Base discriminated model for dataset input. Either inline items or a registered reference. Please note this is the abstract base class. The derived classes available for instantiation are: OptimizationInlineDatasetInput and OptimizationReferenceDatasetInput.
OptimizationDatasetItem	A single item in an inline dataset.
OptimizationEvaluatorRef	Reference to a named evaluator, optionally pinned to a version.
OptimizationInlineDatasetInput	Inline dataset — items supplied directly in the request body.
OptimizationJob	Agent optimization job resource — a long-running job that optimizes an agent's configuration (instructions, model, skills, tools) to maximize evaluation scores. On success, the result contains scored candidates.
OptimizationJobInputs	Caller-supplied inputs for an optimization job.
OptimizationJobProgress	In-flight progress; only populated while status is queued or in_progress.
OptimizationJobResult	Terminal-state result body. Populated when status is succeeded or failed.
OptimizationOptions	Tuning knobs and run-mode for an optimization job.
OptimizationReferenceDatasetInput	Reference to a registered Foundry dataset.
OtlpTelemetryEndpoint	An OTLP (OpenTelemetry Protocol) telemetry export endpoint.
PatchAgentOptions	The PatchAgentOptions.
ProjectAgentSession	An agent session providing a long-lived compute sandbox for hosted agent invocations.
ProjectAgentSkills	The ProjectAgentSkills sub-client.
ProjectsAgentDefinition	The ProjectsAgentDefinition. Please note this is the abstract base class. The derived classes available for instantiation are: HostedAgentDefinition, DeclarativeAgentDefinition, WorkflowAgentDefinition, and ExternalAgentDefinition.
ProjectsAgentRecord	The ProjectsAgentRecord.
ProjectsAgentsModelFactory	A factory class for creating instances of the models for mocking.
ProjectsAgentTool	A tool that can be used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: FabricIQPreviewTool, BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenAPITool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, WorkIQPreviewTool, MemorySearchPreviewTool, ReminderPreviewTool, and ToolSearchTool.
ProjectsAgentVersion	The ProjectsAgentVersion.
ProjectsAgentVersionCreationOptions	The ProjectsAgentVersionCreationOptions.
ProjectWebSearchConfiguration	A web search configuration for bing custom search.
PromotionInfo	Promotion metadata recorded when a candidate is deployed to a Foundry agent.
ProtocolConfiguration	Per-protocol configuration for the agent endpoint.
ProtocolVersionRecord	A record mapping for a single protocol and its version.
ReminderPreviewTool	A built-in tool that schedules the agent to re-invoke itself after a delay. The model passes a single `minutes` argument (positive integer) when calling this tool. The service creates a one-shot timer routine that fires after the specified delay and re-invokes the agent on the same conversation thread. No pre-created routine is required.
ReminderPreviewToolboxTool	A reminder tool stored in a toolbox.
ResponsesProtocolConfiguration	Configuration specific to the responses protocol.
ResponseToolExtensions	Extension methods that convert OpenAI OpenAI.Responses.ResponseTool instances into the equivalent ProjectsAgentTool representation.
SessionDirectoryEntry	A single entry in a directory listing.
SessionFileWriteResponse	Response from uploading a file to a session sandbox.
SessionLogEvent	A single Server-Sent Event frame emitted by the hosted agent session log stream. Each frame contains an `event` field identifying the event type and a `data` field carrying the payload as plain text. Although the current `data` payload is JSON-formatted, its schema is not contractual — additional keys may appear and the format may change over time. Clients should treat `data` as an opaque string and optionally attempt JSON parsing. New event types may be added in the future. Clients should gracefully ignore unrecognized event types. Wire format: `event: log data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting server on port 18080"} event: log data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}`
SharePointGroundingToolOptions	The sharepoint grounding tool parameters.
SharepointPreviewTool	The input definition information for a sharepoint tool as used to configure an agent.
SkillDeletionResult	A deleted skill.
SkillInlineContent	Inline content for defining a simple skill without uploading files. Follows the agentskills.io SKILL.md specification.
SkillVersion	A specific version of a skill.
SkillVersionDeletionResult	A deleted skill version.
StructuredInputDefinition	An structured input that can participate in prompt template substitutions and tool argument binding.
StructuredOutputDefinition	A structured output that can be produced by the agent.
TelemetryConfig	Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.
TelemetryEndpoint	A telemetry export endpoint configuration. Please note this is the abstract base class. The derived classes available for instantiation are: OtlpTelemetryEndpoint.
TelemetryEndpointAuthentication	Authentication configuration for a telemetry endpoint. Please note this is the abstract base class. The derived classes available for instantiation are: HeaderTelemetryEndpointAuth.
ToolboxPolicies	Policy configuration for a toolbox, including content safety and other governance settings.
ToolboxRecord	A toolbox that stores reusable tool definitions for agents.
ToolboxSearchPreviewToolboxTool	A toolbox search tool stored in a toolbox.
ToolboxSkill	A skill source included in a toolbox. Please note this is the abstract base class. The derived classes available for instantiation are: ToolboxSkillReference.
ToolboxSkillReference	A reference to an existing skill to include in a toolbox.
ToolboxTool	An abstract representation of a tool stored in a toolbox. Please note this is the abstract base class. The derived classes available for instantiation are: FabricIQPreviewToolboxTool, CodeInterpreterToolboxTool, FileSearchToolboxTool, WebSearchToolboxTool, MCPToolboxTool, AzureAISearchToolboxTool, OpenApiToolboxTool, A2APreviewToolboxTool, BrowserAutomationPreviewToolboxTool, ReminderPreviewToolboxTool, WorkIQPreviewToolboxTool, and ToolboxSearchPreviewToolboxTool.
ToolboxVersion	A specific version of a toolbox.
ToolConfig	Per-tool configuration that controls tool visibility and search behavior.
ToolProjectConnection	A project connection resource.
ToolSearchTool	Tool search tool.
UpdateToolboxRequest	The UpdateToolboxRequest.
VersionIndicator	Version indicator determining which agent version backs the session. Please note this is the abstract base class. The derived classes available for instantiation are: VersionRefIndicator.
VersionRefIndicator	Version indicator that references a specific agent version by name.
VersionSelectionRule	The VersionSelectionRule. Please note this is the abstract base class. The derived classes available for instantiation are: FixedRatioVersionSelectionRule.
VersionSelector	The VersionSelector.
WebSearchToolboxTool	A web search tool stored in a toolbox.
WebSearchToolExtensions	Extension methods that expose Microsoft Foundry-specific configuration on OpenAI.Responses.WebSearchTool instances.
WorkflowAgentDefinition	The workflow agent definition.
WorkIQPreviewTool	A WorkIQ server-side tool.
WorkIQPreviewToolboxTool	A WorkIQ tool stored in a toolbox.

Structs

Name	Description
AgentListOrder
AgentSessionStatus	The status of an agent session.
AgentsEvaluationLevel	The level at which evaluation is performed.
AgentsJobStatus	Extensible status values shared by Foundry jobs.
AgentState	The operational state of an agent.
AgentVersionStatus	The provisioning status of an agent version.
AzureAISearchQueryType	Available query types for Azure AI Search tool.
CodeDependencyResolution	How package dependencies are resolved at deployment time for a code-based hosted agent.
ExportedDataTypes	The type of telemetry data to export.
ProjectsAgentKind
ProjectsAgentProtocol
SessionLogEventKind	Known SSE event types emitted by the hosted agent session log stream. Additional event types may be introduced in future versions.
TelemetryTransportProtocol	The transport protocol for telemetry export.
ToolSearchExecutionKind

Enums

Name	Description
AgentAdministrationClientOptions.ServiceVersion	The version of the service to use.
AgentDefinitionOptInKeys	Feature opt-in keys for agent definition operations supporting hosted or workflow agents.

Feedback

Was this page helpful?