Aspire.Hosting.Foundry
Official
📦 Aspire.Hosting.Foundry v13.4.0-preview.1.26281.18 35 Functions
23 Types
23 types and 31 members
Types
handle
AzureAISearchToolResource 1 members handle
AzureCognitiveServicesProjectConnectionResource handle
AzureCognitiveServicesProjectResource 25 members handle
AzureFunctionToolResource handle
AzurePromptAgentResource 9 members handle
BingGroundingConnectionResource handle
BingGroundingToolResource 1 members handle
CodeInterpreterToolResource handle
ComputerToolResource handle
FabricToolResource handle
FileSearchToolResource handle
FoundryDeploymentResource 16 members type
FoundryModel 3 fields handle
FoundryResource 3 members handle
FoundryToolResource handle
FunctionToolResource handle
HostedAgentConfiguration 8 members type
HostedAgentOptions 6 fields type
HostedAgentProtocolVersion 2 fields handle
ImageGenerationToolResource handle
SharePointToolResource handle
WebSearchToolResource Functions
method
addAISearchTool builder 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 method
addAzureFunctionTool builder 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 method
addBingGroundingConnection builder Adds a Grounding with Bing Search connection to a Microsoft Foundry project.
addBingGroundingConnection(name: string, bingResourceId: string): BingGroundingConnectionResource method
addBingGroundingConnectionFromParameter builder 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 method
addBingGroundingTool builder Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.
addBingGroundingTool(name: string): BingGroundingToolResource method
addCapabilityHost builder Adds a capability host to the Microsoft Foundry project.
addCapabilityHost(name: string): AzureCognitiveServicesProjectResource method
addCodeInterpreterTool builder 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 method
addComputerUseTool builder 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 method
addConnection builder Adds a connection to a Microsoft Foundry project.
addConnection(resource: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource method
addContainerRegistryConnection builder Adds a container registry connection to the Microsoft Foundry project.
addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource method
addCosmosConnection builder Adds CosmosDB to a project as a connection
addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource method
addDeployment builder Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.
addDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource method
addFabricTool builder 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 method
addFileSearchTool builder 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 method
addFoundry builder Adds a Microsoft Foundry resource to the application model.
addFoundry(name: string): FoundryResource method
addFunctionTool builder 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 method
addImageGenerationTool builder Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.
addImageGenerationTool(name: string): ImageGenerationToolResource method
addKeyVaultConnection builder Adds a Key Vault connection to the Microsoft Foundry project.
addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource method
addModelDeployment builder Adds a model deployment to the parent Microsoft Foundry resource.
addModelDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource method
addProject builder 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 method
addPromptAgent builder Adds a prompt agent to a Microsoft Foundry project with the specified tools.
addPromptAgent(name: string, model: FoundryDeploymentResource, instructions?: string): AzurePromptAgentResource method
addSearchConnection builder Adds an Azure AI Search connection to a Microsoft Foundry project.
addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResource method
addSharePointTool builder 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 method
addStorageConnection builder Adds an Azure Storage account to a project as a connection.
addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource method
addWebSearchTool builder 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 method
asHostedAgent builder 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 method
runAsFoundryLocal builder Adds a Foundry Local resource to the distributed application builder.
runAsFoundryLocal(): FoundryResource method
withAppInsights builder 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 method
withCapabilityHost builder Associates a supported resource with a capability host on a Microsoft Foundry project.
withCapabilityHost(resource: FoundryResource): AzureCognitiveServicesProjectResource method
withFoundryRoleAssignments builder 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 method
withKeyVault builder Adds a Key Vault connection to the Microsoft Foundry project.
withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource method
withProperties builder Allows setting the properties of a Microsoft Foundry Deployment resource.
withProperties(configure: (obj: FoundryDeploymentResource) => Promise<void>): FoundryDeploymentResource method
withReference builder Links an Azure AI Search tool to a backing search resource.
withReference(search: AzureSearchResource): AzureAISearchToolResource method
withReference builder Links a Bing Grounding tool to a Bing Search resource or connection.
withReference(bingReference: ParameterResource): BingGroundingToolResource method
withTool builder Adds a tool to a prompt agent.
withTool(tool: FoundryToolResource): AzurePromptAgentResource