models Package

Classes

A2APreviewTool

An agent implementing the A2A protocol.

AISearchIndexResource

A AI Search Index resource.

AgentBlueprintReference

AgentBlueprintReference.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedAgentIdentityBlueprintReference

AgentCard

AgentCard.

AgentCardSkill

AgentCardSkill.

AgentClusterInsightRequest

Insights on set of Agent Evaluation Results.

AgentClusterInsightResult

Insights from the agent cluster analysis.

AgentDataGenerationJobSource

Agent source for data generation jobs — references an agent to fetch instructions and metadata from.

AgentDefinition

AgentDefinition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ExternalAgentDefinition, HostedAgentDefinition, PromptAgentDefinition, WorkflowAgentDefinition

AgentDetails

AgentDetails.

AgentEndpointAuthorizationScheme

AgentEndpointAuthorizationScheme.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: BotServiceAuthorizationScheme, BotServiceRbacAuthorizationScheme, EntraAuthorizationScheme

AgentEndpointConfig

AgentEndpointConfig.

AgentEvaluatorGenerationJobSource

Agent source for evaluator generation jobs — references an agent to fetch instructions and metadata from.

AgentIdentifier

Identifies the registered Foundry agent to optimize (request-only). Skills, tools, and system_prompt are specified in options.optimization_config.

AgentIdentity

AgentIdentity.

AgentObjectVersions

AgentObjectVersions.

AgentSessionResource

An agent session providing a long-lived compute sandbox for hosted agent invocations.

AgentTaxonomyInput

Input configuration for the evaluation taxonomy when the input type is agent.

AgentVersionDetails

AgentVersionDetails.

AgenticIdentityPreviewCredentials

Agentic identity credential definition.

AgentsPagedResultOptimizationCandidate

The response data for a requested list of items.

ApiError

ApiError.

ApiErrorResponse

Error response for API failures.

ApiKeyCredentials

API Key Credential definition.

ApplyPatchToolParam

Apply patch tool.

ApproximateLocation

ApproximateLocation.

ArtifactProfile

Artifact profile of the model.

AsyncUpdateMemoriesLROPoller

Custom AsyncLROPoller for Memory Store update operations.

AutoCodeInterpreterToolParam

Automatic Code Interpreter Tool Parameters.

AzureAIAgentTarget

Represents a target specifying an Azure AI agent.

AzureAIAgentTargetParam

Represents a target specifying an Azure AI agent.

AzureAIBenchmarkPreviewEvalRunDataSource

Represents a data source for benchmark evaluation runs.

AzureAIDataSourceConfig

AzureAIDataSourceConfig.

AzureAIModelTarget

Represents a target specifying an Azure AI model for operations requiring model selection.

AzureAIModelTargetParam

Represents a target specifying an Azure AI model for operations requiring model selection.

AzureAIResponsesEvalRunDataSource

Represents a data source for evaluation runs that are specific to Continuous Evaluation scenarios.

AzureAISearchIndex

Azure AI Search Index Definition.

AzureAISearchTool

The input definition information for an Azure AI search tool as used to configure an agent.

AzureAISearchToolResource

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

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.

AzureOpenAIModelConfiguration

Azure OpenAI model configuration. The API version would be selected by the service for querying the model.

BaseCredentials

A base class for connection credentials.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EntraIDCredentials, AgenticIdentityPreviewCredentials, ApiKeyCredentials, CustomCredential, NoAuthenticationCredentials, SASCredentials

BingCustomSearchConfiguration

A bing custom search configuration.

BingCustomSearchPreviewTool

The input definition information for a Bing custom search tool as used to configure an agent.

BingCustomSearchToolParameters

The bing custom search tool parameters.

BingGroundingSearchConfiguration

Search configuration for Bing Grounding.

BingGroundingSearchToolParameters

The bing grounding search tool parameters.

BingGroundingTool

The input definition information for a bing grounding search tool as used to configure an agent.

BlobReference

Blob reference details.

BlobReferenceSasCredential

SAS Credential definition.

BotServiceAuthorizationScheme

BotServiceAuthorizationScheme.

BotServiceRbacAuthorizationScheme

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.

BrowserAutomationToolParameters

Definition of input parameters for the Browser Automation Tool.

CandidateDeployConfig

Deploy-config blob for a candidate. Suitable for setting OPTIMIZATION_CONFIG on a hosted-agent version.

CandidateFileInfo

File entry in a candidate's blob directory.

CandidateMetadata

Candidate metadata returned by GET /candidates/{id}.

CandidateResults

Full per-task evaluation results for a candidate, returned by GET /candidates/{id}/results.

CaptureStructuredOutputsTool

A tool for capturing structured outputs.

ChartCoordinate

Coordinates for the analysis chart.

ChatSummaryMemoryItem

A memory item containing a summary extracted from conversations.

ClusterInsightResult

Insights from the cluster analysis.

ClusterTokenUsage

Token usage for cluster analysis.

CodeBasedEvaluatorDefinition

Code-based evaluator definition using python code.

CodeConfiguration

Code-based deployment configuration for a hosted agent.

CodeInterpreterTool

Code interpreter.

ComparisonFilter

Comparison Filter.

CompoundFilter

Compound Filter.

ComputerUsePreviewTool

Computer use preview.

Connection

Response from the list and get connections operations.

ContainerAutoParam

ContainerAutoParam.

ContainerConfiguration

Container-based deployment configuration for a hosted agent.

ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyAllowlistParam.

ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDisabledParam.

ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyDomainSecretParam.

ContainerNetworkPolicyParam

Network access policy for the container.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerNetworkPolicyAllowlistParam, ContainerNetworkPolicyDisabledParam

ContainerSkill

ContainerSkill.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: InlineSkillParam, SkillReferenceParam

ContinuousEvaluationRuleAction

Evaluation rule action for continuous evaluation.

CosmosDBIndex

CosmosDB Vector Store Index Definition.

CreateAgentVersionFromCodeContent

Multipart request body for updating or versioning a code-based agent (POST /agents/{name} and POST /agents/{name}/versions).

CreateAgentVersionFromCodeMetadata

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.

CreateAsyncResponse

CreateAsyncResponse.

CreateSkillVersionFromFilesBody

Multipart request body for creating a skill version from files. Accepts either a single zip file or multiple individual skill files (directory upload). For zip uploads, the server extracts and validates contents. For directory uploads, files are validated as-is.

CronTrigger

Cron based trigger.

CustomCredential

Custom credential definition.

CustomGrammarFormatParam

Grammar format.

CustomRoutineTrigger

A custom event routine trigger.

CustomTextFormatParam

Text format.

CustomToolParam

Custom tool.

CustomToolParamFormat

The input format for the custom tool. Default is unconstrained text.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CustomGrammarFormatParam, CustomTextFormatParam

DailyRecurrenceSchedule

Daily recurrence schedule.

DataGenerationJob

Data Generation Job resource.

DataGenerationJobInputs

Caller-supplied inputs for a data generation job.

DataGenerationJobOptions

Options for managing data generation jobs.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SimpleQnADataGenerationJobOptions, ToolUseFineTuningDataGenerationJobOptions, TracesDataGenerationJobOptions

DataGenerationJobOutput

Output information for a data generation job.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DatasetDataGenerationJobOutput, FileDataGenerationJobOutput

DataGenerationJobOutputOptions

Output options for data generation job.

DataGenerationJobResult

Result produced by a successful data generation job.

DataGenerationJobSource

The base source model for data generation jobs.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentDataGenerationJobSource, FileDataGenerationJobSource, PromptDataGenerationJobSource, TracesDataGenerationJobSource

DataGenerationModelOptions

LLM model options for data generation jobs.

DataGenerationTokenUsage

Token usage information for a data generation job.

DatasetCredential

Represents a reference to a blob for consumption.

DatasetDataGenerationJobOutput

Dataset output for a data generation job.

DatasetEvaluatorGenerationJobSource

Dataset source for evaluator generation jobs — reference to a dataset.

DatasetInfo

Metadata about the dataset used for optimization, surfaced in the response.

DatasetRef

Reference to a registered dataset in the Foundry Dataset Service.

DatasetReference

Reference to a versioned Foundry Dataset.

DatasetVersion

DatasetVersion Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileDatasetVersion, FolderDatasetVersion

DeleteAgentResponse

A deleted agent Object.

DeleteAgentVersionResponse

A deleted agent version Object.

DeleteMemoryResult

Response for deleting a memory item from a memory store.

DeleteMemoryStoreResult

DeleteMemoryStoreResult.

DeleteSkillResult

A deleted skill.

DeleteSkillVersionResult

A deleted skill version.

Deployment

Model Deployment Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ModelDeployment

Dimension

A single dimension — one independent, measurable quality dimension within a rubric evaluator's scoring blueprint.

DispatchRoutineResult

Identifiers returned after a routine dispatch is queued.

EmbeddingConfiguration

Embedding configuration class.

EntraAuthorizationScheme

EntraAuthorizationScheme.

EntraIDCredentials

Entra ID credential definition.

EntraIsolationKeySource

EntraIsolationKeySource.

EvalCsvFileIdSource

Represents a CSV data source by file ID.

EvalCsvRunDataSource

Represents a CSV data source for evaluation runs.

EvalResult

Result of the evaluation.

EvalRunResultCompareItem

Metric comparison for a treatment against the baseline.

EvalRunResultComparison

Comparison results for treatment runs against the baseline.

EvalRunResultSummary

Summary statistics of a metric in an evaluation run.

EvaluationComparisonInsightRequest

Evaluation Comparison Request.

EvaluationComparisonInsightResult

Insights from the evaluation comparison.

EvaluationResultSample

A sample from the evaluation result.

EvaluationRule

Evaluation rule model.

EvaluationRuleAction

Evaluation action model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContinuousEvaluationRuleAction, HumanEvaluationPreviewRuleAction

EvaluationRuleFilter

Evaluation filter model.

EvaluationRunClusterInsightRequest

Insights on set of Evaluation Results.

EvaluationRunClusterInsightResult

Insights from the evaluation run cluster analysis.

EvaluationScheduleTask

Evaluation task for the schedule.

EvaluationTarget

Base class for targets with discriminator support.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureAIAgentTarget, AzureAIModelTarget

EvaluationTaxonomy

Evaluation Taxonomy Definition.

EvaluationTaxonomyInput

Input configuration for the evaluation taxonomy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentTaxonomyInput

EvaluatorCredentialRequest

Request body for getting evaluator credentials.

EvaluatorDefinition

Base evaluator configuration with discriminator.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CodeBasedEvaluatorDefinition, PromptBasedEvaluatorDefinition, RubricBasedEvaluatorDefinition

EvaluatorGenerationArtifacts

Service-managed provenance artifacts produced by an evaluator generation job. Present only on EvaluatorVersion resources created via the generation pipeline. The combined-JSONL Foundry Dataset is read-only and resolves to a versioned dataset in a service-reserved namespace.

EvaluatorGenerationInputs

Caller-supplied inputs for an evaluator generation job.

EvaluatorGenerationJob

Evaluator Generation Job resource — a long-running job that generates rubric-based evaluator definitions from source materials. On success, the result is the persisted EvaluatorVersion.

EvaluatorGenerationJobSource

The base source model for evaluator generation jobs. Polymorphic over type.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentEvaluatorGenerationJobSource, DatasetEvaluatorGenerationJobSource, PromptEvaluatorGenerationJobSource, TracesEvaluatorGenerationJobSource

EvaluatorGenerationTokenUsage

Token consumption summary for an evaluator generation job. Populated when the job reaches a terminal state.

EvaluatorMetric

Evaluator Metric.

EvaluatorVersion

Evaluator Definition.

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.

FabricDataAgentToolParameters

The fabric data agent tool parameters.

FabricIQPreviewTool

A FabricIQ server-side tool.

FieldMapping

Field mapping configuration class.

FileDataGenerationJobOutput

Azure OpenAI file output for a data generation job.

FileDataGenerationJobSource

File source for data generation jobs — Azure OpenAI file input.

FileDatasetVersion

FileDatasetVersion Definition.

FileSearchTool

File search.

FixedRatioVersionSelectionRule

FixedRatioVersionSelectionRule.

FolderDatasetVersion

FileDatasetVersion Definition.

FoundryModelWarning

A warning associated with a model.

FunctionShellToolParam

Shell tool.

FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironment.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContainerAutoParam, FunctionShellToolParamEnvironmentContainerReferenceParam, FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentContainerReferenceParam.

FunctionShellToolParamEnvironmentLocalEnvironmentParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam.

FunctionTool

Function.

GitHubIssueRoutineTrigger

A GitHub issue routine trigger.

HeaderIsolationKeySource

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.

HourlyRecurrenceSchedule

Hourly recurrence schedule.

HumanEvaluationPreviewRuleAction

Evaluation rule action for human evaluation.

HybridSearchOptions

HybridSearchOptions.

ImageGenTool

Image generation tool.

ImageGenToolInputImageMask

ImageGenToolInputImageMask.

Index

Index resource Definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureAISearchIndex, CosmosDBIndex, ManagedAzureAISearchIndex

InlineSkillParam

InlineSkillParam.

InlineSkillSourceParam

Inline skill payload.

Insight

The response body for cluster insights.

InsightCluster

A cluster of analysis samples.

InsightModelConfiguration

Configuration of the model used in the insight generation.

InsightRequest

The request of the insights report.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentClusterInsightRequest, EvaluationComparisonInsightRequest, EvaluationRunClusterInsightRequest

InsightResult

The result of the insights.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgentClusterInsightResult, EvaluationComparisonInsightResult, EvaluationRunClusterInsightResult

InsightSample

A sample from the analysis.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationResultSample

InsightScheduleTask

Insight task for the schedule.

InsightSummary

Summary of the error cluster analysis.

InsightsMetadata

Metadata about the insights.

InvokeAgentInvocationsApiDispatchPayload

A manual payload used to test an invocations API routine dispatch.

InvokeAgentInvocationsApiRoutineAction

Dispatches a routine through the raw invocations API. Exactly one of agent_name or agent_endpoint_id must be provided.

InvokeAgentResponsesApiDispatchPayload

A manual payload used to test a responses API routine dispatch.

InvokeAgentResponsesApiRoutineAction

Dispatches a routine through the responses API. Exactly one of agent_name or agent_endpoint_id must be provided.

IsolationKeySource

IsolationKeySource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EntraIsolationKeySource, HeaderIsolationKeySource

LocalShellToolParam

Local shell tool.

LocalSkillParam

LocalSkillParam.

LoraConfig

Adapter-specific metadata for LoRA models. Drives serving engine configuration at deployment time.

MCPTool

MCP tool.

MCPToolFilter

MCP tool filter.

MCPToolRequireApproval

MCPToolRequireApproval.

ManagedAgentIdentityBlueprintReference

ManagedAgentIdentityBlueprintReference.

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition.

MemoryItem

A single memory item stored in the memory store, containing content and metadata.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ChatSummaryMemoryItem, ProceduralMemoryItem, UserProfileMemoryItem

MemoryOperation

Represents a single memory operation (create, update, or delete) performed on a memory item.

MemorySearchItem

A retrieved memory item from memory search.

MemorySearchOptions

Memory search options.

MemorySearchPreviewTool

A tool for integrating memories into the agent.

MemoryStoreDefaultDefinition

Default memory store implementation.

MemoryStoreDefaultOptions

Default memory store configurations.

MemoryStoreDefinition

Base definition for memory store configurations.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MemoryStoreDefaultDefinition

MemoryStoreDeleteScopeResult

Response for deleting memories from a scope.

MemoryStoreDetails

A memory store that can store and retrieve user memories.

MemoryStoreOperationUsage

Usage statistics of a memory store operation.

MemoryStoreSearchResult

Memory search response.

MemoryStoreUpdateCompletedResult

Memory update result.

MemoryStoreUpdateResult

Provides the status of a memory store update operation.

MicrosoftFabricPreviewTool

The input definition information for a Microsoft Fabric tool as used to configure an agent.

ModelCredentialRequest

Request to fetch credentials for a model asset.

ModelDeployment

Model Deployment Definition.

ModelDeploymentSku

Sku information.

ModelPendingUploadRequest

Represents a request for a pending upload of a model version.

ModelPendingUploadResponse

Represents the response for a model pending upload request.

ModelSamplingConfigParam

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

ModelSamplingParams

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

ModelSourceData

Source information for the model.

ModelVersion

Model Version Definition.

MonthlyRecurrenceSchedule

Monthly recurrence schedule.

NoAuthenticationCredentials

Credentials that do not require authentication.

OneTimeTrigger

One-time trigger.

OpenApiAnonymousAuthDetails

Security details for OpenApi anonymous authentication.

OpenApiAuthDetails

authentication details for OpenApiFunctionDefinition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails, OpenApiProjectConnectionAuthDetails

OpenApiFunctionDefinition

The input definition information for an openapi function.

OpenApiFunctionDefinitionFunction

OpenApiFunctionDefinitionFunction.

OpenApiManagedAuthDetails

Security details for OpenApi managed_identity authentication.

OpenApiManagedSecurityScheme

Security scheme for OpenApi managed_identity authentication.

OpenApiProjectConnectionAuthDetails

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.

OptimizationAgentDefinition

Agent definition returned in response payloads (includes resolved config).

OptimizationCandidate

Aggregated evaluation result for a single candidate agent configuration across all tasks.

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.

OptimizationTaskResult

Per-task evaluation result for a single candidate.

OtlpTelemetryEndpoint

An OTLP (OpenTelemetry Protocol) telemetry export endpoint.

PendingUploadRequest

Represents a request for a pending upload.

PendingUploadResponse

Represents the response for a pending upload request.

ProceduralMemoryItem

A memory item containing a procedure extracted from conversations.

PromoteCandidateRequest

Request body for promoting a candidate to a Foundry agent version.

PromoteCandidateResponse

Response after successfully promoting a candidate.

PromotionInfo

Promotion metadata recorded when a candidate is deployed to a Foundry agent.

PromptAgentDefinition

The prompt agent definition.

PromptAgentDefinitionTextOptions

Configuration options for a text response from the model. Can be plain text or structured JSON data.

PromptBasedEvaluatorDefinition

Prompt-based evaluator.

PromptDataGenerationJobSource

Prompt source for data generation jobs — inline text provided by the user.

PromptEvaluatorGenerationJobSource

Prompt source for evaluator generation jobs — inline text provided by the user.

ProtocolVersionRecord

A record mapping for a single protocol and its version.

RaiConfig

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

RankingOptions

RankingOptions.

Reasoning

Reasoning.

RecurrenceSchedule

Recurrence schedule model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DailyRecurrenceSchedule, HourlyRecurrenceSchedule, MonthlyRecurrenceSchedule, WeeklyRecurrenceSchedule

RecurrenceTrigger

Recurrence based trigger.

RedTeam

Red team details.

RedTeamEvalRunDataSource

RedTeamEvalRunDataSource.

RedTeamTargetConfig

Abstract class for target configuration.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureOpenAIModelConfiguration

ResponseRetrievalItemGenerationParams

Represents the parameters for response retrieval item generation.

ResponseUsageInputTokensDetails

ResponseUsageInputTokensDetails.

ResponseUsageOutputTokensDetails

ResponseUsageOutputTokensDetails.

Routine

A routine definition returned by the service.

RoutineAction

Base model for a routine action.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: InvokeAgentInvocationsApiRoutineAction, InvokeAgentResponsesApiRoutineAction

RoutineDispatchPayload

Base model for a manual dispatch payload.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: InvokeAgentInvocationsApiDispatchPayload, InvokeAgentResponsesApiDispatchPayload

RoutineRun

A single routine run returned from the run history API.

RoutineTrigger

Base model for a routine trigger.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CustomRoutineTrigger, GitHubIssueRoutineTrigger, ScheduleRoutineTrigger, TimerRoutineTrigger

RubricBasedEvaluatorDefinition

Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.

SASCredentials

Shared Access Signature (SAS) credential definition.

Schedule

Schedule model.

ScheduleRoutineTrigger

A recurring cron-based routine trigger.

ScheduleRun

Schedule run model.

ScheduleTask

Schedule task model.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EvaluationScheduleTask, InsightScheduleTask

SessionDirectoryEntry

A single entry in a directory listing.

SessionFileWriteResult

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"}
SharepointGroundingToolParameters

The sharepoint grounding tool parameters.

SharepointPreviewTool

The input definition information for a sharepoint tool as used to configure an agent.

SimpleQnADataGenerationJobOptions

The options for a data generation job with SimpleQnA type.

SkillDetails

A skill resource.

SkillInlineContent

Inline content for defining a simple skill without uploading files. Follows the agentskills.io SKILL.md specification.

SkillReferenceParam

SkillReferenceParam.

SkillVersion

A specific version of a skill.

SpecificApplyPatchParam

Specific apply patch tool choice.

SpecificFunctionShellParam

Specific shell tool choice.

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.

SystemDataV3

System metadata for a resource.

TargetCompletionEvalRunDataSource

Represents a data source for target-based completion evaluation configuration.

TaxonomyCategory

Taxonomy category definition.

TaxonomySubCategory

Taxonomy sub-category definition.

TelemetryConfig

Customer-supplied telemetry configuration for exporting container logs, traces, and metrics.

TelemetryEndpoint

A telemetry export endpoint configuration.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: OtlpTelemetryEndpoint

TelemetryEndpointAuth

Authentication configuration for a telemetry endpoint.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HeaderTelemetryEndpointAuth

TestingCriterionAzureAIEvaluator

AzureAIEvaluatorGrader.

TextResponseFormat

An object specifying the format that the model must output. Configuring { "type": "json_schema" } enables Structured Outputs, which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide. The default format is { "type": "text" } with no additional options. Not recommended for gpt-4o and newer models:* Setting to { "type": "json_object" } enables the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TextResponseFormatJsonObject, TextResponseFormatJsonSchema, TextResponseFormatText

TextResponseFormatJsonObject

JSON object.

TextResponseFormatJsonSchema

JSON schema.

TextResponseFormatText

Text.

TimerRoutineTrigger

A one-shot timer routine trigger.

Tool

A tool that can be used to generate a response.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: A2APreviewTool, ApplyPatchToolParam, AzureAISearchTool, AzureFunctionTool, BingCustomSearchPreviewTool, BingGroundingTool, BrowserAutomationPreviewTool, CaptureStructuredOutputsTool, CodeInterpreterTool, ComputerUsePreviewTool, CustomToolParam, MicrosoftFabricPreviewTool, FabricIQPreviewTool, FileSearchTool, FunctionTool, ImageGenTool, LocalShellToolParam, MCPTool, MemorySearchPreviewTool, OpenApiTool, SharepointPreviewTool, FunctionShellToolParam, ToolboxSearchPreviewTool, WebSearchTool, WebSearchPreviewTool, WorkIQPreviewTool

ToolChoiceAllowed

Allowed tools.

ToolChoiceCodeInterpreter

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolChoiceComputerUsePreview

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolChoiceCustom

Custom tool.

ToolChoiceFileSearch

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolChoiceFunction

Function tool.

ToolChoiceImageGeneration

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolChoiceMCP

MCP tool.

ToolChoiceParam

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolChoiceAllowed, SpecificApplyPatchParam, ToolChoiceCodeInterpreter, ToolChoiceComputerUsePreview, ToolChoiceCustom, ToolChoiceFileSearch, ToolChoiceFunction, ToolChoiceImageGeneration, ToolChoiceMCP, SpecificFunctionShellParam, ToolChoiceWebSearchPreview, ToolChoiceWebSearchPreview20250311

ToolChoiceWebSearchPreview

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolChoiceWebSearchPreview20250311

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

ToolConfig

Per-tool configuration that controls tool visibility and search behavior.

ToolDescription

Description of a tool that can be used by an agent.

ToolDescriptionParam

Description of a tool that can be used by an agent.

ToolProjectConnection

A project connection resource.

ToolUseFineTuningDataGenerationJobOptions

The options for a data generation job with ToolUse type. Used only for fine-tuning scenarios.

ToolboxObject

A toolbox that stores reusable tool definitions for agents.

ToolboxPolicies

Policy configuration for a toolbox, including content safety and other governance settings.

ToolboxSearchPreviewTool

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

A skill source included in a toolbox.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ToolboxSkillReference

ToolboxSkillReference

A reference to an existing skill to include in a toolbox.

ToolboxVersionObject

A specific version of a toolbox.

TracesDataGenerationJobOptions

The options for a data generation job with Traces type.

TracesDataGenerationJobSource

Traces source for data generation jobs — conversation traces from Application Insights.

TracesEvaluatorGenerationJobSource

Traces source for evaluator generation jobs — conversation traces from Application Insights.

TracesPreviewEvalRunDataSource

Represents a data source for evaluation runs that operate over Agent traces stored in Application Insights.

Trigger

Base model for Trigger of the schedule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CronTrigger, OneTimeTrigger, RecurrenceTrigger

UpdateMemoriesLROPoller

Custom LROPoller for Memory Store update operations.

UpdateModelVersionRequest

Request body for updating a model version. Only description and tags can be modified.

UpdateToolboxRequest

UpdateToolboxRequest.

UserProfileMemoryItem

A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.

VersionIndicator

Version indicator determining which agent version backs the session.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: VersionRefIndicator

VersionRefIndicator

Version indicator that references a specific agent version by name.

VersionSelectionRule

VersionSelectionRule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FixedRatioVersionSelectionRule

VersionSelector

VersionSelector.

WebSearchApproximateLocation

Web search approximate location.

WebSearchConfiguration

A web search configuration for bing custom search.

WebSearchPreviewTool

Web search preview.

WebSearchTool

Web search.

WebSearchToolFilters

WebSearchToolFilters.

WeeklyRecurrenceSchedule

Weekly recurrence schedule.

WorkIQPreviewTool

A WorkIQ server-side tool.

WorkflowAgentDefinition

The workflow agent definition.

Enums

AgentBlueprintReferenceType

Type of AgentBlueprintReferenceType.

AgentEndpointAuthorizationSchemeType

Type of AgentEndpointAuthorizationSchemeType.

AgentEndpointProtocol

Type of AgentEndpointProtocol.

AgentKind

Type of AgentKind.

AgentObjectType

Type of AgentObjectType.

AgentProtocol

Type of AgentProtocol.

AgentSessionStatus

The status of an agent session.

AgentVersionStatus

The provisioning status of an agent version.

AttackStrategy

Strategies for attacks.

AzureAISearchQueryType

Available query types for Azure AI Search tool.

CodeDependencyResolution

How package dependencies are resolved at deployment time for a code-based hosted agent.

ComputerEnvironment

Type of ComputerEnvironment.

ConnectionType

The Type (or category) of the connection.

ContainerMemoryLimit

Type of ContainerMemoryLimit.

ContainerNetworkPolicyParamType

Type of ContainerNetworkPolicyParamType.

ContainerSkillType

Type of ContainerSkillType.

CredentialType

The credential type used by the connection.

CustomToolParamFormatType

Type of CustomToolParamFormatType.

DataGenerationJobOutputType

The supported output file types for a data generation job.

DataGenerationJobScenario

The supported scenarios for a data generation job.

DataGenerationJobSourceType

The supported source types for data generation jobs.

DataGenerationJobType

The supported data generation job types.

DatasetType

Enum to determine the type of data.

DayOfWeek

Days of the week for recurrence schedule.

DeploymentType

Type of DeploymentType.

EvaluationLevel

The level at which evaluation is performed.

EvaluationRuleActionType

Type of the evaluation action.

EvaluationRuleEventType

Type of the evaluation rule event.

EvaluationTaxonomyInputType

Type of the evaluation taxonomy input.

EvaluatorCategory

The category of the evaluator.

EvaluatorDefinitionType

The type of evaluator definition.

EvaluatorGenerationJobSourceType

The supported source types for evaluator generation jobs.

EvaluatorMetricDirection

The direction of the metric indicating whether a higher value is better, a lower value is better, or neutral.

EvaluatorMetricType

The type of the evaluator.

EvaluatorType

The type of the evaluator.

FoundryModelArtifactProfileCategory

The artifact profile category.

FoundryModelArtifactProfileSignal

Signals detected in the model artifact.

FoundryModelSourceType

The source type of the model.

FoundryModelWarningCode

Warning code for model artifacts.

FoundryModelWeightType

The weight type of the model.

FunctionShellToolParamEnvironmentType

Type of FunctionShellToolParamEnvironmentType.

GitHubIssueEvent

Known GitHub issue events that can fire a routine.

GrammarSyntax1

Type of GrammarSyntax1.

ImageGenAction

Type of ImageGenAction.

IndexType

Type of IndexType.

InputFidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

InsightType

The request of the insights.

IsolationKeySourceKind

Type of IsolationKeySourceKind.

JobStatus

Extensible status values shared by Foundry jobs.

MemoryItemKind

Memory item kind.

MemoryOperationKind

Memory operation kind.

MemoryStoreKind

The type of memory store implementation to use.

MemoryStoreObjectType

Type of MemoryStoreObjectType.

MemoryStoreUpdateStatus

Status of a memory store update operation.

OpenApiAuthType

Authentication type for OpenApi endpoint. Allowed types are:

  • Anonymous (no authentication required)

  • Project Connection (requires project_connection_id to endpoint, as setup in AI Foundry)

  • Managed_Identity (requires audience for identity based auth).

OperationState

Enum describing allowed operation states.

PageOrder

Type of PageOrder.

PendingUploadType

The type of pending upload.

RankerVersionType

Type of RankerVersionType.

RecurrenceType

Recurrence type.

RiskCategory

Risk category for the attack objective.

RoutineActionType

The discriminator values supported for routine actions.

RoutineAttemptSource

Known source paths that can produce a routine run.

RoutineDispatchPayloadType

The discriminator values supported for manual routine dispatch payloads.

RoutineRunPhase

Known lifecycle phases recorded for a routine run.

RoutineTriggerType

The discriminator values supported for routine triggers.

SampleType

The type of sample used in the analysis.

ScheduleProvisioningStatus

Schedule provisioning status.

ScheduleTaskType

Type of the task.

SearchContextSize

Type of SearchContextSize.

SessionLogEventType

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

SimpleQnAFineTuningQuestionType

The supported question types for SimpleQnA data generation jobs used for fine-tuning scenarios.

TelemetryDataKind

The type of telemetry data to export.

TelemetryEndpointAuthType

The type of authentication for a telemetry endpoint.

TelemetryEndpointKind

The kind of telemetry export endpoint.

TelemetryTransportProtocol

The transport protocol for telemetry export.

TextResponseFormatConfigurationType

Type of TextResponseFormatConfigurationType.

ToolChoiceParamType

Type of ToolChoiceParamType.

ToolType

Type of ToolType.

TreatmentEffectType

Treatment Effect Type.

TriggerType

Type of the trigger.

VersionIndicatorType

The type of version indicator used to determine the agent version backing a session.

VersionSelectorType

Type of VersionSelectorType.