Aspire.Hosting.Foundry

Official

📦 Aspire.Hosting.Foundryv13.4.0-preview.1.26281.18

35Functions

23Types

23 types and 31 members

Functions

methodaddAISearchToolbuilder

Adds an Azure AI Search tool to a Microsoft Foundry project, enabling agents to ground their responses using data from an Azure AI Search index.

addAISearchTool(name: string, indexName?: string): AzureAISearchToolResource

methodaddAzureFunctionToolbuilder

Adds an Azure Function tool to a Microsoft Foundry project, enabling agents to invoke a serverless Azure Function with queue-based input/output bindings.

addAzureFunctionTool(name: string, functionName: string, description: string, parametersJson: string, inputQueueEndpoint: string, inputQueueName: string, outputQueueEndpoint: string, outputQueueName: string): AzureFunctionToolResource

methodaddBingGroundingConnectionbuilder

Adds a Grounding with Bing Search connection to a Microsoft Foundry project.

addBingGroundingConnection(name: string, bingResourceId: string): BingGroundingConnectionResource

methodaddBingGroundingConnectionFromParameterbuilder

Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter resource for the Bing resource ID.

addBingGroundingConnectionFromParameter(name: string, bingResourceId: ParameterResource): BingGroundingConnectionResource

methodaddBingGroundingToolbuilder

Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.

addBingGroundingTool(name: string): BingGroundingToolResource

methodaddCapabilityHostbuilder

Adds a capability host to the Microsoft Foundry project.

addCapabilityHost(name: string): AzureCognitiveServicesProjectResource

methodaddCodeInterpreterToolbuilder

Adds a Code Interpreter tool to a Microsoft Foundry project, enabling agents to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.

addCodeInterpreterTool(name: string): CodeInterpreterToolResource

methodaddComputerUseToolbuilder

Adds a Computer Use tool to a Microsoft Foundry project, enabling agents to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.

addComputerUseTool(name: string, displayWidth?: number, displayHeight?: number, environment?: string): ComputerToolResource

methodaddConnectionbuilder

Adds a connection to a Microsoft Foundry project.

addConnection(resource: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource

methodaddContainerRegistryConnectionbuilder

Adds a container registry connection to the Microsoft Foundry project.

addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource

methodaddCosmosConnectionbuilder

Adds CosmosDB to a project as a connection

addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource

methodaddDeploymentbuilder

Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.

addDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource

methodaddFabricToolbuilder

Adds a Microsoft Fabric data agent tool to a Microsoft Foundry project, enabling agents to query data through Fabric data agents.

addFabricTool(name: string, projectConnectionIds: string[]): FabricToolResource

methodaddFileSearchToolbuilder

Adds a File Search tool to a Microsoft Foundry project, enabling agents to search uploaded files and proprietary documents using vector search.

addFileSearchTool(name: string, vectorStoreIds: string[]): FileSearchToolResource

methodaddFoundrybuilder

Adds a Microsoft Foundry resource to the application model.

addFoundry(name: string): FoundryResource

methodaddFunctionToolbuilder

Adds a function calling tool to a Microsoft Foundry project, enabling agents to call application-defined functions with structured parameters.

addFunctionTool(name: string, functionName: string, parametersJson: string, description?: string, strictModeEnabled?: boolean): FunctionToolResource

methodaddImageGenerationToolbuilder

Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.

addImageGenerationTool(name: string): ImageGenerationToolResource

methodaddKeyVaultConnectionbuilder

Adds a Key Vault connection to the Microsoft Foundry project.

addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource

methodaddModelDeploymentbuilder

Adds a model deployment to the parent Microsoft Foundry resource.

addModelDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource

methodaddProjectbuilder

Adds a Microsoft Foundry project resource to the application model. This will also attach the project as a deployment target for agents.

addProject(name: string): AzureCognitiveServicesProjectResource

methodaddPromptAgentbuilder

Adds a prompt agent to a Microsoft Foundry project with the specified tools.

addPromptAgent(name: string, model: FoundryDeploymentResource, instructions?: string): AzurePromptAgentResource

methodaddSearchConnectionbuilder

Adds an Azure AI Search connection to a Microsoft Foundry project.

addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResource

methodaddSharePointToolbuilder

Adds a SharePoint grounding tool to a Microsoft Foundry project, enabling agents to search data from SharePoint sites configured as Foundry project connections.

addSharePointTool(name: string, projectConnectionIds: string[]): SharePointToolResource

methodaddStorageConnectionbuilder

Adds an Azure Storage account to a project as a connection.

addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource

methodaddWebSearchToolbuilder

Adds a Web Search tool to a Microsoft Foundry project, enabling agents to retrieve real-time information from the public web and return answers with inline citations.

addWebSearchTool(name: string): WebSearchToolResource

methodasHostedAgentbuilder

Configures the resource to run and publish as a hosted agent in Microsoft Foundry, targeting the specified Foundry project.

asHostedAgent(project: AzureCognitiveServicesProjectResource, options?: HostedAgentOptions): IResourceWithEndpoints

methodrunAsFoundryLocalbuilder

Adds a Foundry Local resource to the distributed application builder.

runAsFoundryLocal(): FoundryResource

methodwithAppInsightsbuilder

Adds an Application Insights resource to the Microsoft Foundry project, overriding the default (which is to create a new Application Insights resource).

withAppInsights(appInsights: AzureApplicationInsightsResource): AzureCognitiveServicesProjectResource

methodwithCapabilityHostbuilder

Associates a supported resource with a capability host on a Microsoft Foundry project.

withCapabilityHost(resource: FoundryResource): AzureCognitiveServicesProjectResource

methodwithFoundryRoleAssignmentsbuilder

Assigns the specified roles to the given resource, granting it the necessary permissions on the target Microsoft Foundry resource. This replaces the default role assignments for the resource.

withFoundryRoleAssignments(target: FoundryResource, roles: FoundryRole[]): IResource

methodwithKeyVaultbuilder

Adds a Key Vault connection to the Microsoft Foundry project.

withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource

methodwithPropertiesbuilder

Allows setting the properties of a Microsoft Foundry Deployment resource.

withProperties(configure: (obj: FoundryDeploymentResource) => Promise<void>): FoundryDeploymentResource

methodwithReferencebuilder

Links an Azure AI Search tool to a backing search resource.

withReference(search: AzureSearchResource): AzureAISearchToolResource

methodwithReferencebuilder

Links a Bing Grounding tool to a Bing Search resource or connection.

withReference(bingReference: ParameterResource): BingGroundingToolResource

methodwithToolbuilder

Adds a tool to a prompt agent.

withTool(tool: FoundryToolResource): AzurePromptAgentResource

Enums

enumFoundryRole3 values