|
A2APreviewTool(String, String, IDictionary<String,ToolConfig>, Uri, String, String)
|
An agent implementing the A2A 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, and BotServiceRbacAuthorizationScheme.
|
|
AgentEndpointConfiguration(VersionSelector, IEnumerable<AgentEndpointProtocol>, IEnumerable<AgentEndpointAuthorizationScheme>)
|
The AgentEndpointConfiguration.
|
|
AgentIdentifier(String, String)
|
Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.
|
|
AgentIdentity(String, String)
|
The AgentIdentity.
|
|
AgentManifestOptions(IDictionary<String,String>, String, String, IDictionary<String,BinaryData>)
|
The AgentManifestOptions.
|
|
AgentsPagedResultOptimizationCandidate(IEnumerable<OptimizationCandidate>, String, String, Boolean)
|
The response data for a requested list of items.
|
|
AgentsSkill(String, String, String, DateTimeOffset, String, String)
|
A skill resource.
|
|
AzureAISearchTool(String, String, IDictionary<String,ToolConfig>, AzureAISearchToolOptions)
|
The input definition information for an Azure AI search tool as used to configure an agent.
|
|
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(AzureFunctionDefinition, IDictionary<String,ToolConfig>)
|
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(String, String, IDictionary<String,ToolConfig>, 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.
|
|
BrowserAutomationPreviewTool(String, String, IDictionary<String,ToolConfig>, BrowserAutomationToolOptions)
|
The input definition information for a Browser Automation Tool, as used to configure an Agent.
|
|
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.
|
|
CandidateDeployConfig(String, String, Nullable<Single>, IEnumerable<IDictionary<String,BinaryData>>, IEnumerable<IDictionary<String,BinaryData>>)
|
Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version.
|
|
CandidateFileInfo(String, String, Int64)
|
File entry in a candidate's blob directory.
|
|
CandidateMetadata(String, String, String, String, Nullable<Double>,
Boolean, DateTimeOffset, DateTimeOffset, PromotionInfo, IEnumerable<CandidateFileInfo>)
|
Candidate metadata returned by GET /candidates/{id}.
|
|
CandidateResults(String, IEnumerable<OptimizationTaskResult>)
|
Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results.
|
|
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.
|
|
ContainerConfiguration(String)
|
Container-based deployment configuration for a hosted agent.
|
|
ContentFilterConfiguration(String)
|
Configuration for Responsible AI (RAI) content filtering and safety features.
|
|
CreateAgentFromCodeOptions(CreateAgentVersionFromCodeMetadata, BinaryData)
|
Multipart request body for creating a new code-based agent (POST /agents). Inherits from CreateAgentVersionFromCodeContent for future extensibility.
|
|
CreateAgentVersionFromCodeMetadata(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.
|
|
CreateAgentVersionFromManifestRequest(IDictionary<String,String>, String, String, IDictionary<String,BinaryData>)
|
The CreateAgentVersionFromManifestRequest.
|
|
DatasetInfo(String, String, Int32, Boolean)
|
Metadata about the dataset used for optimization, surfaced in the response.
|
|
DatasetRef(String, String)
|
Reference to a registered dataset in the Foundry Dataset Service.
|
|
DeclarativeAgentDefinition(ContentFilterConfiguration, String,
String, Nullable<Single>, Nullable<Single>, ResponseReasoningOptions,
IEnumerable<ResponseTool>, BinaryData, ResponseTextOptions, IDictionary<String,
StructuredInputDefinition>)
|
The prompt agent definition.
|
|
DeleteSkillResponse(String, String, Boolean)
|
A deleted skill.
|
|
DeleteSkillVersionResponse(String, String, Boolean, String)
|
A deleted skill version.
|
|
EmptyModelParam()
|
The EmptyModelParam.
|
|
EntraAuthorizationScheme(IsolationKeySource)
|
The EntraAuthorizationScheme.
|
|
EntraIsolationKeySource()
|
The EntraIsolationKeySource.
|
|
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, String, String, IDictionary<String,ToolConfig>)
|
A FabricIQ server-side tool.
|
|
FixedRatioVersionSelectionRule(String, Int32)
|
The FixedRatioVersionSelectionRule.
|
|
HeaderIsolationKeySource()
|
The HeaderIsolationKeySource.
|
|
HeaderTelemetryEndpointAuth(String, String, String)
|
Header-based secret authentication for a telemetry endpoint. The resolved secret value is injected as an HTTP header.
|
|
HostedAgentDefinition(ContentFilterConfiguration, IEnumerable<ProjectsAgentTool>,
String, String, IDictionary<String,String>, ContainerConfiguration,
IEnumerable<ProtocolVersionRecord>, CodeConfiguration, TelemetryConfig)
|
The hosted agent definition.
|
|
IsolationKeySource(String)
|
The IsolationKeySource.
Please note this is the abstract base class. The derived classes available for instantiation are: EntraIsolationKeySource and HeaderIsolationKeySource.
|
|
ManagedAgentIdentityBlueprintReference(String)
|
The ManagedAgentIdentityBlueprintReference.
|
|
MemorySearchPreviewTool(String, String, IDictionary<String,ToolConfig>, String, String, MemorySearchToolOptions, Nullable<Int32>)
|
A tool for integrating memories into the agent.
|
|
MemorySearchToolOptions(Nullable<Int32>)
|
Memory search options.
|
|
MicrosoftFabricPreviewTool(String, String, IDictionary<String,ToolConfig>, 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(OpenApiFunctionDefinition, IDictionary<String,ToolConfig>)
|
The input definition information for an OpenAPI tool as used to configure an agent.
|
|
OptimizationAgentDefinition(String, String, String, String, IEnumerable<IDictionary<String,BinaryData>>, IEnumerable<IDictionary<String,BinaryData>>)
|
Agent definition returned in response payloads (includes resolved config).
|
|
OptimizationCandidate(String, String, OptimizationAgentDefinition,
IDictionary<String,BinaryData>, Double, Double, Double, IEnumerable<OptimizationTaskResult>,
Boolean, String, String, PromotionInfo)
|
Aggregated evaluation result for a single candidate agent configuration across all tasks.
|
|
OptimizationJobInputs(AgentIdentifier, DatasetRef, DatasetRef, IEnumerable<String>, 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(OptimizationCandidate, OptimizationCandidate,
IEnumerable<OptimizationCandidate>, OptimizationOptions, IEnumerable<String>,
Nullable<Boolean>)
|
Terminal-state result body. Populated when status is succeeded or failed.
|
|
OptimizationOptions(Nullable<Int32>, IDictionary<String,BinaryData>, String, String, Nullable<EvaluationLevel>)
|
Tuning knobs and run-mode for an optimization job.
|
|
OptimizationTaskResult(String, String, IDictionary<String,Double>,
Double, Int64, TimeSpan, Boolean, String, IDictionary<String,
String>, String, String)
|
Per-task evaluation result for a single candidate.
|
|
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)
|
|
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: BingGroundingTool, MicrosoftFabricPreviewTool, SharepointPreviewTool, AzureAISearchTool, OpenAPITool, BingCustomSearchPreviewTool, BrowserAutomationPreviewTool, AzureFunctionTool, CaptureStructuredOutputsTool, A2APreviewTool, WorkIQPreviewTool, FabricIQPreviewTool, MemorySearchPreviewTool, ToolboxSearchPreviewTool, and ToolSearchTool.
|
|
ProjectsAgentVersion(IDictionary<String,String>, String, String,
String, String, DateTimeOffset, ProjectsAgentDefinition, Nullable<AgentVersionStatus>,
AgentIdentity, AgentIdentity, AgentBlueprintReference, String)
|
The ProjectsAgentVersion.
|
|
ProjectsAgentVersionCreationOptions(IDictionary<String,String>, String, ProjectsAgentDefinition, AgentBlueprintReference)
|
The ProjectsAgentVersionCreationOptions.
|
|
ProjectWebSearchConfiguration(String, String)
|
A web search configuration for bing custom search.
|
|
PromoteCandidateRequest(String, String)
|
Request body for promoting a candidate to a Foundry agent version.
|
|
PromoteCandidateResponse(String, String, DateTimeOffset, String, String)
|
Response after successfully promoting a candidate.
|
|
PromotionInfo(DateTimeOffset, String, String)
|
Promotion metadata recorded when a candidate is deployed to a Foundry agent.
|
|
ProtocolVersionRecord(ProjectsAgentProtocol, String)
|
A record mapping for a single protocol and its version.
|
|
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(SessionLogEventType, 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(String, String, IDictionary<String,ToolConfig>, SharePointGroundingToolOptions)
|
The input definition information for a sharepoint tool as used to configure an agent.
|
|
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.
|
|
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.
|
|
ToolboxSearchPreviewTool(String, String, IDictionary<String,ToolConfig>)
|
A tool for searching over the agent's toolbox.
When present, deferred tools are hidden from tools/list and only
discoverable via search_tools queries at runtime.
|
|
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.
|
|
ToolboxVersion(IDictionary<String,String>, String, String, String,
String, DateTimeOffset, IEnumerable<ProjectsAgentTool>, 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<ToolSearchExecutionType>, 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.
|
|
WorkflowAgentDefinition(ContentFilterConfiguration, String)
|
The workflow agent definition.
|
|
WorkIQPreviewTool(String, String, String, IDictionary<String,ToolConfig>)
|
A WorkIQ server-side tool.
|
