AzureCognitiveServicesProjectConnectionsBuilderExtensions Methods
ClassMethods12 members
Extension methods for adding Microsoft Foundry project connection resources to the distributed application model.
AddBingGroundingConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, string)Section titled AddBingGroundingConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, string)extensionIResourceBuilder<BingGroundingConnectionResource> Adds a Grounding with Bing Search connection to a Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<BingGroundingConnectionResource> AddBingGroundingConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, string name, string bingResourceId) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>The ApplicationModel.IResourceBuilder`1 for the parent Microsoft Foundry project resource.namestringThe name of the connection resource.bingResourceIdstring The full Azure resource ID of the Bing Search resource (e.g., /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Bing/accounts/{name}). Returns
IResourceBuilder<BingGroundingConnectionResource>A reference to the ApplicationModel.IResourceBuilder`1 for the connection resource.Remarks
The Bing Search resource ( Microsoft.Bing/accounts) cannot be provisioned through Aspire or Bicep. It must be created manually in the Azure portal.
Once the Bing resource exists, pass its resource ID to this method. The connection is created in the Foundry project using API key authentication with category: "ApiKey" and metadata.Type: "bing_grounding".
AddBingGroundingConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, IResourceBuilder<ParameterResource>)Section titled AddBingGroundingConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<BingGroundingConnectionResource> Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter resource for the Bing resource ID.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<BingGroundingConnectionResource> AddBingGroundingConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, string name, IResourceBuilder<ParameterResource> bingResourceId) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>The ApplicationModel.IResourceBuilder`1 for the parent Microsoft Foundry project resource.namestringThe name of the connection resource.bingResourceIdIResourceBuilder<ParameterResource> A parameter resource containing the full Azure resource ID of the Bing Search resource. Returns
IResourceBuilder<BingGroundingConnectionResource>A reference to the ApplicationModel.IResourceBuilder`1 for the connection resource.Remarks
This overload allows the Bing resource ID to be supplied as a parameter (e.g., from user secrets or configuration) rather than a hardcoded string. The parameter value is resolved at deployment time and embedded in the Bicep template.
AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, Func<AzureResourceInfrastructure, CognitiveServicesConnectionProperties>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, string, Func<AzureResourceInfrastructure, CognitiveServicesConnectionProperties>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds a Microsoft Foundry project connection resource to a project. This is a low level interface that requires the caller to specify all connection properties.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, string name, Func<AzureResourceInfrastructure, CognitiveServicesConnectionProperties> configureProperties) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>The ApplicationModel.IResourceBuilder`1 for the parent Microsoft Foundry project resource.namestringThe name of the Microsoft Foundry project connection resource.configurePropertiesFunc<AzureResourceInfrastructure, CognitiveServicesConnectionProperties>Action to customize the resource.Returns
IResourceBuilder<AzureCognitiveServicesProjectConnectionResource>A reference to the ApplicationModel.IResourceBuilder`1 for the Microsoft Foundry project connection resource.Remarks
This method is not available in polyglot app hosts.
AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureCosmosDBResource)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureCosmosDBResource)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds CosmosDB to a project as a connection
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, AzureCosmosDBResource db) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>dbAzureCosmosDBResourceAddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureCosmosDBResource>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureCosmosDBResource>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds CosmosDB to a project as a connection
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, IResourceBuilder<AzureCosmosDBResource> db) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>dbIResourceBuilder<AzureCosmosDBResource>AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureStorageResource)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureStorageResource)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds an Azure Storage account to a project as a connection.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, AzureStorageResource storage) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>storageAzureStorageResourceAddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureStorageResource>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureStorageResource>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds an Azure Storage account to a project as a connection.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, IResourceBuilder<AzureStorageResource> storage) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>storageIResourceBuilder<AzureStorageResource>AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureContainerRegistryResource)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureContainerRegistryResource)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds a container registry connection to the Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, AzureContainerRegistryResource registry) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>registryAzureContainerRegistryResourceAddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureContainerRegistryResource>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureContainerRegistryResource>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds a container registry connection to the Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, IResourceBuilder<AzureContainerRegistryResource> registry) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>registryIResourceBuilder<AzureContainerRegistryResource>AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureSearchResource)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, AzureSearchResource)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds an Azure AI Search connection to a Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, AzureSearchResource search) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>searchAzureSearchResourceAddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureSearchResource>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureSearchResource>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds an Azure AI Search connection to a Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, IResourceBuilder<AzureSearchResource> search) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>searchIResourceBuilder<AzureSearchResource>AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureKeyVaultResource>)Section titled AddConnection(IResourceBuilder<AzureCognitiveServicesProjectResource>, IResourceBuilder<AzureKeyVaultResource>)extensionIResourceBuilder<AzureCognitiveServicesProjectConnectionResource> Adds a Key Vault connection to the Microsoft Foundry project.
public static class AzureCognitiveServicesProjectConnectionsBuilderExtensions{ public static IResourceBuilder<AzureCognitiveServicesProjectConnectionResource> AddConnection( this IResourceBuilder<AzureCognitiveServicesProjectResource> builder, IResourceBuilder<AzureKeyVaultResource> keyVault) { // ... }}Parameters
builderIResourceBuilder<AzureCognitiveServicesProjectResource>keyVaultIResourceBuilder<AzureKeyVaultResource>Remarks
This connection allows the Microsoft Foundry project to store secrets for various other connections. As such, we recommend adding this connection *before* any others, so that those connections can leverage the Key Vault connection for secret storage.