Azure.AI.Projects.Agents Namespace

Classes

Name Description
A2APreviewTool

An agent implementing the A2A 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.

AgentEndpoint

The AgentEndpoint.

AgentEndpointAuthorizationScheme

The AgentEndpointAuthorizationScheme. Please note this is the abstract base class. The derived classes available for instantiation are: EntraAuthorizationScheme, BotServiceAuthorizationScheme, and BotServiceRbacAuthorizationScheme.

AgentIdentity

The AgentIdentity.

AgentManifestOptions

The AgentManifestOptions.

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 object.

AgentToolboxes

The AgentToolboxes sub-client.

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.

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.

BrowserAutomationPreviewTool

The input definition information for a Browser Automation Tool, as used to configure an Agent.

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
CodeConfiguration

Code-based deployment configuration for a hosted agent.

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.

DeleteSkillResponse

A deleted skill Object.

EntraAuthorizationScheme

The EntraAuthorizationScheme.

EntraIsolationKeySource

The EntraIsolationKeySource.

FabricDataAgentToolOptions

The fabric data agent tool parameters.

FixedRatioVersionSelectionRule

The FixedRatioVersionSelectionRule.

HeaderIsolationKeySource

The HeaderIsolationKeySource.

HeaderTelemetryEndpointAuth

Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.

HostedAgentDefinition

The hosted agent definition.

IsolationKeySource

The IsolationKeySource. Please note this is the abstract base class. The derived classes available for instantiation are: EntraIsolationKeySource and HeaderIsolationKeySource.

ManagedAgentIdentityBlueprintReference

The ManagedAgentIdentityBlueprintReference.

McpToolExtensions
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.

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, and WorkflowAgentDefinition.

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: BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenAPITool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, WorkIQPreviewTool, and MemorySearchPreviewTool.

ProjectsAgentVersion

The ProjectsAgentVersion.

ProjectsAgentVersionCreationOptions

The ProjectsAgentVersionCreationOptions.

ProjectWebSearchConfiguration

A web search configuration for bing custom search.

ProtocolVersionRecord

A record mapping for a single protocol and its version.

ResponseToolExtensions
SessionDirectoryEntry

A single entry in a directory listing.

SessionDirectoryListResponse

Response from listing a directory in a session sandbox.

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.

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.

TelemetryEndpointAuth

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.

ToolboxVersion

A specific version of a toolbox.

ToolProjectConnection

A project connection resource.

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.

WebSearchToolExtensions
WorkflowAgentDefinition

The workflow agent definition.

WorkIQPreviewTool

A WorkIQ server-side tool.

WorkIQPreviewToolParameters

The WorkIQ tool parameters.

Structs

Name Description
AgentEndpointProtocol
AgentListOrder
AgentSessionStatus

The status of an agent session.

AzureAISearchQueryType

Available query types for Azure AI Search tool.

ProjectsAgentKind
ProjectsAgentProtocol
SessionLogEventType

Known SSE event types emitted by the hosted agent session log stream. Additional event types may be introduced in future versions.

TelemetryDataKind

The type of telemetry data to export.

TelemetryTransportProtocol

The transport protocol for telemetry export.

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.

AgentVersionStatus

The provisioning status of an agent version.

FoundryFeaturesOptInKeys