|
A2APreviewTool(Uri, String, String, Nullable<Boolean>)
|
An agent implementing the A2A protocol.
|
|
A2APreviewToolboxTool(String, String, IDictionary<String,ToolConfig>, Uri, String, String, Nullable<Boolean>)
|
An A2A tool stored in a toolbox.
|
|
A2AProtocolConfiguration()
|
Configuration specific to the A2A protocol.
|
|
ActivityProtocolConfiguration(Nullable<Boolean>)
|
Configuration specific to the activity protocol.
|
|
AgentBlueprintReference(String)
|
The AgentBlueprintReference.
Please note this is the abstract base class. The derived classes available for instantiation are: ManagedAgentIdentityBlueprintReference.
|
|
AgentCard(String, String, IEnumerable<AgentCardSkill>)
|
The AgentCard.
|
|
AgentCardSkill(String, String, String, IEnumerable<String>, IEnumerable<String>)
|
The AgentCardSkill.
|
|
AgentEndpointAuthorizationScheme(String)
|
The AgentEndpointAuthorizationScheme.
Please note this is the abstract base class. The derived classes available for instantiation are: EntraAuthorizationScheme, BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, and BotServiceTenantAuthorizationScheme.
|
|
AgentEndpointConfiguration(VersionSelector, ProtocolConfiguration, IEnumerable<AgentEndpointAuthorizationScheme>)
|
The AgentEndpointConfiguration.
|
|
AgentFromCodeOptions(AgentVersionFromCodeMetadata, BinaryData)
|
Multipart request body for creating a new code-based agent (POST /agents). Inherits from CreateAgentVersionFromCodeContent for future extensibility.
|
|
AgentIdentity(String, String)
|
The AgentIdentity.
|
|
AgentManifestOptions(IDictionary<String,String>, String, String, IDictionary<String,BinaryData>)
|
The AgentManifestOptions.
|
|
AgentsSkill(String, String, String, DateTimeOffset, String, String)
|
A skill resource.
|
|
AgentVersionFromCodeMetadata(String, IDictionary<String,String>, HostedAgentDefinition)
|
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.
|
|
AzureAISearchTool(String, String, IDictionary<String,ToolConfig>, AzureAISearchToolOptions)
|
The input definition information for an Azure AI search tool as used to configure an agent.
|
|
AzureAISearchToolboxTool(String, String, IDictionary<String,ToolConfig>, AzureAISearchToolOptions)
|
An Azure AI Search tool stored in a toolbox.
|
|
AzureAISearchToolIndex(String, String, Nullable<AzureAISearchQueryType>, Nullable<Int32>, String, String)
|
A AI Search Index resource.
|
|
AzureAISearchToolOptions(IEnumerable<AzureAISearchToolIndex>)
|
A set of index resources used by the azure_ai_search tool.
|
|
AzureFunctionBinding(AzureFunctionStorageQueue)
|
The structure for keeping storage queue name and URI.
|
|
AzureFunctionDefinition(AzureFunctionDefinitionFunction, AzureFunctionBinding, AzureFunctionBinding)
|
The definition of Azure function.
|
|
AzureFunctionDefinitionFunction(String, String, BinaryData)
|
The AzureFunctionDefinitionFunction.
|
|
AzureFunctionStorageQueue(String, String)
|
The structure for keeping storage queue name and URI.
|
|
AzureFunctionTool(IDictionary<String,ToolConfig>, AzureFunctionDefinition)
|
The input definition information for an Azure Function Tool, as used to configure an Agent.
|
|
BingCustomSearchConfiguration(String, String, String, String, Nullable<Int64>, String)
|
A bing custom search configuration.
|
|
BingCustomSearchPreviewTool(BingCustomSearchToolOptions)
|
The input definition information for a Bing custom search tool as used to configure an agent.
|
|
BingCustomSearchToolOptions(IEnumerable<BingCustomSearchConfiguration>)
|
The bing custom search tool parameters.
|
|
BingGroundingSearchConfiguration(String, String, String, Nullable<Int64>, String)
|
Search configuration for Bing Grounding.
|
|
BingGroundingSearchToolOptions(IEnumerable<BingGroundingSearchConfiguration>)
|
The bing grounding search tool parameters.
|
|
BingGroundingTool(String, String, IDictionary<String,ToolConfig>, BingGroundingSearchToolOptions)
|
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(BrowserAutomationToolOptions)
|
The input definition information for a Browser Automation Tool, as used to configure an Agent.
|
|
BrowserAutomationPreviewToolboxTool(String, String, IDictionary<String,ToolConfig>, BrowserAutomationToolOptions)
|
A browser automation tool stored in a toolbox.
|
|
BrowserAutomationToolConnectionParameters(String)
|
Definition of input parameters for the connection used by the Browser Automation Tool.
|
|
BrowserAutomationToolOptions(BrowserAutomationToolConnectionParameters)
|
Definition of input parameters for the Browser Automation Tool.
|
|
CaptureStructuredOutputsTool(String, String, IDictionary<String,ToolConfig>, StructuredOutputDefinition)
|
A tool for capturing structured outputs.
|
|
CodeConfiguration(String, IEnumerable<String>, CodeDependencyResolution, String)
|
Code-based deployment configuration for a hosted agent.
|
|
CodeInterpreterToolboxTool(String, String, IDictionary<String,ToolConfig>, BinaryData)
|
A code interpreter tool stored in a toolbox.
|
|
ContainerConfiguration(String)
|
Container-based deployment configuration for a hosted agent.
|
|
ContentFilterConfiguration(String)
|
Configuration for Responsible AI (RAI) content filtering and safety features.
|
|
CreateAgentVersionFromManifestRequest(IDictionary<String,String>, String, String, IDictionary<String,BinaryData>)
|
The CreateAgentVersionFromManifestRequest.
|
|
DeclarativeAgentDefinition(ContentFilterConfiguration, String,
String, Nullable<Single>, Nullable<Single>, ResponseReasoningOptions,
IEnumerable<ResponseTool>, BinaryData, ResponseTextOptions, IDictionary<String,
StructuredInputDefinition>)
|
The prompt agent definition.
|
|
EmptyModelParam()
|
The EmptyModelParam.
|
|
EntraAuthorizationScheme()
|
The EntraAuthorizationScheme.
|
|
ExternalAgentDefinition(ContentFilterConfiguration, String)
|
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(IEnumerable<ToolProjectConnection>)
|
The fabric data agent tool parameters.
|
|
FabricIQPreviewTool(String, String, Uri, BinaryData)
|
A FabricIQ server-side tool.
|
|
FabricIQPreviewToolboxTool(String, String, IDictionary<String,ToolConfig>, String, String, Uri, BinaryData)
|
A FabricIQ tool stored in a toolbox.
|
|
FixedRatioVersionSelectionRule(String, Int32)
|
The FixedRatioVersionSelectionRule.
|
|
HeaderTelemetryEndpointAuth(String, String, String)
|
Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.
|
|
HostedAgentDefinition(ContentFilterConfiguration, String, String,
IDictionary<String,String>, ContainerConfiguration, IEnumerable<ProtocolVersionRecord>,
CodeConfiguration, TelemetryConfig)
|
The hosted agent definition.
|
|
InvocationsProtocolConfiguration()
|
Configuration specific to the invocations protocol.
|
|
InvocationsWsProtocolConfiguration()
|
Configuration specific to the WebSocket-based invocations protocol.
|
|
ManagedAgentIdentityBlueprintReference(String)
|
The ManagedAgentIdentityBlueprintReference.
|
|
McpProtocolConfiguration()
|
Configuration specific to the MCP protocol.
|
|
MCPToolboxTool(String, String, IDictionary<String,ToolConfig>,
String, Uri, Nullable<MCPToolboxToolConnectorId>, String, String,
IDictionary<String,String>, BinaryData, BinaryData, Nullable<Boolean>,
String)
|
An MCP tool stored in a toolbox.
|
|
MemorySearchPreviewTool(String, String, MemorySearchToolOptions, Nullable<Int32>)
|
A tool for integrating memories into the agent.
|
|
MemorySearchToolOptions(Nullable<Int32>)
|
Memory search options.
|
|
MicrosoftFabricPreviewTool(FabricDataAgentToolOptions)
|
The input definition information for a Microsoft Fabric tool as used to configure an agent.
|
|
OpenAPIAnonymousAuthenticationDetails()
|
Security details for OpenApi anonymous authentication.
|
|
OpenApiAuthenticationDetails(String)
|
authentication details for OpenApiFunctionDefinition
Please note this is the abstract base class. The derived classes available for instantiation are: OpenAPIAnonymousAuthenticationDetails, OpenApiProjectConnectionAuthenticationDetails, and OpenAPIManagedAuthenticationDetails.
|
|
OpenApiFunctionDefinition(String, String, IDictionary<String,
BinaryData>, OpenApiAuthenticationDetails, IEnumerable<String>,
IEnumerable<OpenAPIFunctionEntry>)
|
The input definition information for an openapi function.
|
|
OpenAPIFunctionEntry(String, String, IDictionary<String,BinaryData>)
|
The OpenAPIFunctionEntry.
|
|
OpenAPIManagedAuthenticationDetails(OpenAPIManagedSecurityScheme)
|
Security details for OpenApi managed_identity authentication.
|
|
OpenAPIManagedSecurityScheme(String)
|
Security scheme for OpenApi managed_identity authentication.
|
|
OpenApiProjectConnectionAuthenticationDetails(OpenApiProjectConnectionSecurityScheme)
|
Security details for OpenApi project connection authentication.
|
|
OpenApiProjectConnectionSecurityScheme(String)
|
Security scheme for OpenApi managed_identity authentication.
|
|
OpenAPITool(IDictionary<String,ToolConfig>, OpenApiFunctionDefinition)
|
The input definition information for an OpenAPI tool as used to configure an agent.
|
|
OpenApiToolboxTool(String, String, IDictionary<String,ToolConfig>, OpenApiFunctionDefinition)
|
An OpenAPI tool stored in a toolbox.
|
|
OptimizationAgentIdentifier(String, String)
|
Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.
|
|
OptimizationCandidate(String, String, IDictionary<String,BinaryData>, Double, Double, String, String, PromotionInfo)
|
Aggregated evaluation result for a single candidate agent configuration across all tasks.
|
|
OptimizationDatasetCriterion(String, String)
|
Evaluation criterion: a name + instruction pair used for per-item scoring.
|
|
OptimizationDatasetInput(String)
|
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(String, String, Nullable<Int32>, IEnumerable<OptimizationDatasetCriterion>)
|
A single item in an inline dataset.
|
|
OptimizationEvaluatorRef(String, String)
|
Reference to a named evaluator, optionally pinned to a version.
|
|
OptimizationInlineDatasetInput(IEnumerable<OptimizationDatasetItem>)
|
Inline dataset — items supplied directly in the request body.
|
|
OptimizationJobInputs(OptimizationAgentIdentifier, OptimizationDatasetInput,
OptimizationDatasetInput, IEnumerable<OptimizationEvaluatorRef>,
OptimizationOptions)
|
Caller-supplied inputs for an optimization job.
|
|
OptimizationJobProgress(Int32, Double, Double)
|
In-flight progress; only populated while status is queued or in_progress.
|
|
OptimizationJobResult(String, String, IEnumerable<OptimizationCandidate>)
|
Terminal-state result body. Populated when status is succeeded or failed.
|
|
OptimizationOptions(Nullable<Int32>, IDictionary<String,BinaryData>, String, String, Nullable<AgentsEvaluationLevel>)
|
Tuning knobs and run-mode for an optimization job.
|
|
OptimizationReferenceDatasetInput(String, String)
|
Reference to a registered Foundry dataset.
|
|
OtlpTelemetryEndpoint(IEnumerable<ExportedDataTypes>, TelemetryEndpointAuthentication, String, TelemetryTransportProtocol)
|
An OTLP (OpenTelemetry Protocol) telemetry export endpoint.
|
|
PatchAgentOptions(AgentEndpointConfiguration, AgentCard)
|
The PatchAgentOptions.
|
|
ProjectAgentSession(String, VersionIndicator, AgentSessionStatus, DateTimeOffset, DateTimeOffset, DateTimeOffset)
|
An agent session providing a long-lived compute sandbox for hosted agent invocations.
|
|
ProjectsAgentDefinition(String, ContentFilterConfiguration)
|
The ProjectsAgentDefinition.
Please note this is the abstract base class. The derived classes available for instantiation are: HostedAgentDefinition, DeclarativeAgentDefinition, WorkflowAgentDefinition, and ExternalAgentDefinition.
|
|
ProjectsAgentRecord(String, String, AgentState)
|
Creates a new instance of ProjectsAgentRecord for mocking.
|
|
ProjectsAgentTool(String)
|
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(IDictionary<String,String>, String, String,
String, String, DateTimeOffset, ProjectsAgentDefinition, Nullable<Boolean>,
Nullable<AgentVersionStatus>, AgentIdentity, AgentIdentity, AgentBlueprintReference,
String)
|
The ProjectsAgentVersion.
|
|
ProjectsAgentVersionCreationOptions(IDictionary<String,String>, String, ProjectsAgentDefinition, AgentBlueprintReference, Nullable<Boolean>)
|
The ProjectsAgentVersionCreationOptions.
|
|
ProjectWebSearchConfiguration(String, String)
|
A web search configuration for bing custom search.
|
|
PromotionInfo(DateTimeOffset, String, String)
|
Promotion metadata recorded when a candidate is deployed to a Foundry agent.
|
|
ProtocolConfiguration(ActivityProtocolConfiguration, ResponsesProtocolConfiguration,
A2AProtocolConfiguration, McpProtocolConfiguration, InvocationsProtocolConfiguration,
InvocationsWsProtocolConfiguration)
|
Per-protocol configuration for the agent endpoint.
|
|
ProtocolVersionRecord(ProjectsAgentProtocol, String)
|
A record mapping for a single protocol and its version.
|
|
ReminderPreviewTool(String, String)
|
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(String, String, IDictionary<String,ToolConfig>)
|
A reminder tool stored in a toolbox.
|
|
ResponsesProtocolConfiguration()
|
Configuration specific to the responses protocol.
|
|
SessionDirectoryEntry(String, Int64, Boolean, DateTimeOffset)
|
A single entry in a directory listing.
|
|
SessionFileWriteResponse(String, Int64)
|
Response from uploading a file to a session sandbox.
|
|
SessionLogEvent(SessionLogEventKind, String)
|
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(IEnumerable<ToolProjectConnection>)
|
The sharepoint grounding tool parameters.
|
|
SharepointPreviewTool(SharePointGroundingToolOptions)
|
The input definition information for a sharepoint tool as used to configure an agent.
|
|
SkillDeletionResult(String, String, Boolean)
|
A deleted skill.
|
|
SkillInlineContent(String, String, String, String, IDictionary<String,String>, IEnumerable<String>)
|
Inline content for defining a simple skill without uploading files. Follows the agentskills.io SKILL.md specification.
|
|
SkillVersion(String, String, String, String, String, DateTimeOffset)
|
A specific version of a skill.
|
|
SkillVersionDeletionResult(String, String, Boolean, String)
|
A deleted skill version.
|
|
StructuredInputDefinition(String, BinaryData, IDictionary<String,BinaryData>, Nullable<Boolean>)
|
An structured input that can participate in prompt template substitutions and tool argument binding.
|
|
StructuredOutputDefinition(String, String, IDictionary<String,BinaryData>, Nullable<Boolean>)
|
A structured output that can be produced by the agent.
|
|
TelemetryConfig(IEnumerable<TelemetryEndpoint>)
|
Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.
|
|
TelemetryEndpoint(String, IEnumerable<ExportedDataTypes>, TelemetryEndpointAuthentication)
|
A telemetry export endpoint configuration.
Please note this is the abstract base class. The derived classes available for instantiation are: OtlpTelemetryEndpoint.
|
|
TelemetryEndpointAuthentication(String)
|
Authentication configuration for a telemetry endpoint.
Please note this is the abstract base class. The derived classes available for instantiation are: HeaderTelemetryEndpointAuth.
|
|
ToolboxPolicies(ContentFilterConfiguration)
|
Policy configuration for a toolbox, including content safety and other governance settings.
|
|
ToolboxRecord(String, String, String)
|
A toolbox that stores reusable tool definitions for agents.
|
|
ToolboxSearchPreviewToolboxTool(String, String, IDictionary<String,ToolConfig>)
|
A toolbox search tool stored in a toolbox.
|
|
ToolboxSkill(String)
|
A skill source included in a toolbox.
Please note this is the abstract base class. The derived classes available for instantiation are: ToolboxSkillReference.
|
|
ToolboxSkillReference(String, String)
|
A reference to an existing skill to include in a toolbox.
|
|
ToolboxTool(String, String, String, IDictionary<String,ToolConfig>)
|
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(IDictionary<String,String>, String, String, String,
String, DateTimeOffset, IEnumerable<ToolboxTool>, IEnumerable<ToolboxSkill>,
ToolboxPolicies)
|
A specific version of a toolbox.
|
|
ToolConfig(Nullable<Boolean>, String)
|
Per-tool configuration that controls tool visibility and search behavior.
|
|
ToolProjectConnection(String)
|
A project connection resource.
|
|
ToolSearchTool(Nullable<ToolSearchExecutionKind>, String, EmptyModelParam)
|
Tool search tool.
|
|
UpdateToolboxRequest(String, String)
|
The UpdateToolboxRequest.
|
|
VersionIndicator(String)
|
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(String)
|
Version indicator that references a specific agent version by name.
|
|
VersionSelectionRule(String, String)
|
The VersionSelectionRule.
Please note this is the abstract base class. The derived classes available for instantiation are: FixedRatioVersionSelectionRule.
|
|
VersionSelector(IEnumerable<VersionSelectionRule>)
|
The VersionSelector.
|
|
WebSearchApproximateLocation(String, String, String, String)
|
Web search approximate location.
|
|
WebSearchToolboxTool(String, String, IDictionary<String,ToolConfig>,
WebSearchToolFilters, WebSearchApproximateLocation, Nullable<WebSearchToolSearchContextSize>,
ProjectWebSearchConfiguration)
|
A web search tool stored in a toolbox.
|
|
WebSearchToolFilters(IEnumerable<String>)
|
The WebSearchToolFilters.
|
|
WorkflowAgentDefinition(ContentFilterConfiguration, String)
|
The workflow agent definition.
|
|
WorkIQPreviewTool(String)
|
A WorkIQ server-side tool.
|
|
WorkIQPreviewToolboxTool(String, String, IDictionary<String,ToolConfig>, String)
|
A WorkIQ tool stored in a toolbox.
|
