AzureCognitiveServicesProjectResource
Handle
interface AzureCognitiveServicesProjectResource extends IAzureResource, IComputeEnvironmentResource, IExpressionValue, IManifestExpressionProvider, IResource, IResourceWithConnectionString, IResourceWithParameters, IResourceWithParent, FoundryResource]], IValueProvider, IValueWithReferences, IAzureComputeEnvironmentResource { addAISearchTool( name: string, indexName?: string): AzureAISearchToolResource; addAzureFunctionTool( name: string, functionName: string, description: string, parametersJson: string, inputQueueEndpoint: string, inputQueueName: string, outputQueueEndpoint: string, outputQueueName: string): AzureFunctionToolResource; addBingGroundingConnection( name: string, bingResourceId: string): BingGroundingConnectionResource; addBingGroundingConnectionFromParameter( name: string, bingResourceId: ParameterResource): BingGroundingConnectionResource; addBingGroundingTool(name: string): BingGroundingToolResource; addCapabilityHost(name: string): AzureCognitiveServicesProjectResource; addCodeInterpreterTool(name: string): CodeInterpreterToolResource; addComputerUseTool( name: string, displayWidth?: number, displayHeight?: number, environment?: string): ComputerToolResource; addConnection(resource: AzureCosmosDBResource | AzureStorageResource | AzureContainerRegistryResource | AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource; addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource; addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource; addFabricTool( name: string, projectConnectionIds: string[]): FabricToolResource; addFileSearchTool( name: string, vectorStoreIds: string[]): FileSearchToolResource; addFunctionTool( name: string, functionName: string, parametersJson: string, description?: string, strictModeEnabled?: boolean): FunctionToolResource; addImageGenerationTool(name: string): ImageGenerationToolResource; addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource; addModelDeployment( name: string, model: FoundryModel | string, modelVersion?: string, format?: string): FoundryDeploymentResource; addPromptAgent( name: string, model: FoundryDeploymentResource, instructions?: string): AzurePromptAgentResource; addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResource; addSharePointTool( name: string, projectConnectionIds: string[]): SharePointToolResource; addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource; addToolbox( name: string, options?: FoundryToolboxOptions): FoundryToolboxResource; addWebSearchTool(name: string): WebSearchToolResource; withAppInsights(appInsights: AzureApplicationInsightsResource): AzureCognitiveServicesProjectResource; withCapabilityHost(resource: AzureCosmosDBResource | AzureStorageResource | AzureSearchResource | FoundryResource): AzureCognitiveServicesProjectResource; withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource;}26 members
Methods
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): AzureAISearchToolResourceParameters
namestringindexName stringoptionalReturns
AzureAISearchToolResource 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): AzureFunctionToolResourceParameters
namestringfunctionName stringdescriptionstringparametersJson stringinputQueueEndpoint stringinputQueueName stringoutputQueueEndpoint stringoutputQueueName stringReturns
AzureFunctionToolResource Adds a Grounding with Bing Search connection to a Microsoft Foundry project.
addBingGroundingConnection( name: string, bingResourceId: string): BingGroundingConnectionResourceParameters
namestringbingResourceId stringReturns
BingGroundingConnectionResource 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): BingGroundingConnectionResourceParameters
namestringbingResourceId ParameterResource Returns
BingGroundingConnectionResource Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.
addBingGroundingTool(name: string): BingGroundingToolResourceParameters
namestringReturns
BingGroundingToolResource Adds a capability host to the Microsoft Foundry project.
addCapabilityHost(name: string): AzureCognitiveServicesProjectResourceParameters
namestringReturns
AzureCognitiveServicesProjectResource 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): CodeInterpreterToolResourceParameters
namestringReturns
CodeInterpreterToolResource 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): ComputerToolResourceParameters
namestringdisplayWidth numberoptional= 1024displayHeight numberoptional= 768environmentstringoptional= browserReturns
ComputerToolResource Adds a connection to a Microsoft Foundry project.
addConnection(resource: AzureCosmosDBResource | AzureStorageResource | AzureContainerRegistryResource | AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResourceParameters
resourceAzureCosmosDBResource | AzureStorageResource | AzureContainerRegistryResource | AzureKeyVaultResource Returns
AzureCognitiveServicesProjectConnectionResource Adds a container registry connection to the Microsoft Foundry project.
addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResourceParameters
registryAzureContainerRegistryResource Returns
AzureCognitiveServicesProjectConnectionResource Adds CosmosDB to a project as a connection
addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResourceParameters
dbAzureCosmosDBResource Returns
AzureCognitiveServicesProjectConnectionResource 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[]): FabricToolResourceParameters
namestringprojectConnectionIds string[]Returns
FabricToolResource 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[]): FileSearchToolResourceParameters
namestringvectorStoreIds string[]Returns
FileSearchToolResource 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): FunctionToolResourceParameters
namestringfunctionName stringparametersJson stringdescriptionstringoptionalstrictModeEnabled booleanoptionalReturns
FunctionToolResource Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.
addImageGenerationTool(name: string): ImageGenerationToolResourceParameters
namestringReturns
ImageGenerationToolResource Adds a Key Vault connection to the Microsoft Foundry project.
addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResourceParameters
keyVault AzureKeyVaultResource Returns
AzureCognitiveServicesProjectConnectionResource Adds a model deployment to the parent Microsoft Foundry resource.
addModelDeployment( name: string, model: FoundryModel | string, modelVersion?: string, format?: string): FoundryDeploymentResourceParameters
namestringmodelFoundryModel | string modelVersion stringoptionalformatstringoptionalReturns
FoundryDeploymentResource Adds a prompt agent to a Microsoft Foundry project with the specified tools.
addPromptAgent( name: string, model: FoundryDeploymentResource, instructions?: string): AzurePromptAgentResourceParameters
namestringmodelFoundryDeploymentResource instructionsstringoptionalReturns
AzurePromptAgentResource Adds an Azure AI Search connection to a Microsoft Foundry project.
addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResourceParameters
searchAzureSearchResource Returns
AzureCognitiveServicesProjectConnectionResource Adds an Azure Storage account to a project as a connection.
addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResourceParameters
storageAzureStorageResource Returns
AzureCognitiveServicesProjectConnectionResource Adds a Microsoft Foundry Toolbox endpoint to a Microsoft Foundry project.
addToolbox( name: string, options?: FoundryToolboxOptions): FoundryToolboxResourceParameters
namestringoptionsFoundryToolboxOptions optionalReturns
FoundryToolboxResource 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): WebSearchToolResourceParameters
namestringReturns
WebSearchToolResource 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): AzureCognitiveServicesProjectResourceParameters
appInsights AzureApplicationInsightsResource Returns
AzureCognitiveServicesProjectResource Associates a supported resource with a capability host on a Microsoft Foundry project.
withCapabilityHost(resource: AzureCosmosDBResource | AzureStorageResource | AzureSearchResource | FoundryResource): AzureCognitiveServicesProjectResourceParameters
resourceAzureCosmosDBResource | AzureStorageResource | AzureSearchResource | FoundryResource Returns
AzureCognitiveServicesProjectResource Adds a Key Vault connection to the Microsoft Foundry project.
withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResourceParameters
keyVault AzureKeyVaultResource Returns
AzureCognitiveServicesProjectResource 
Aspire