AzureOpenAIExtensions.AddAzureOpenAI Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.Azure.CognitiveServices.dll

Package:: Aspire.Hosting.Azure.CognitiveServices v8.2.0

Package:: Aspire.Hosting.Azure.CognitiveServices v9.0.0

Package:: Aspire.Hosting.Azure.CognitiveServices v9.1.0

Package:: Aspire.Hosting.Azure.CognitiveServices v9.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AddAzureOpenAI(IDistributedApplicationBuilder, String)	Adds an Azure OpenAI resource to the application model.
AddAzureOpenAI(IDistributedApplicationBuilder, String, Action<IResourceBuilder<AzureOpenAIResource>, ResourceModuleConstruct,CognitiveServicesAccount,IEnumerable<CognitiveServicesAccountDeployment>>)	Adds an Azure OpenAI resource to the application model.

AddAzureOpenAI(IDistributedApplicationBuilder, String)

Source:: AzureOpenAIExtensions.cs

Source:: AzureOpenAIExtensions.cs

Source:: AzureOpenAIExtensions.cs

Source:: AzureOpenAIExtensions.cs

Adds an Azure OpenAI resource to the application model.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource> AddAzureOpenAI(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name);

static member AddAzureOpenAI : Aspire.Hosting.IDistributedApplicationBuilder * string -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource>

<Extension()>
Public Function AddAzureOpenAI (builder As IDistributedApplicationBuilder, name As String) As IResourceBuilder(Of AzureOpenAIResource)

Parameters

builder: IDistributedApplicationBuilder

The IDistributedApplicationBuilder.

name: String

The name of the resource. This name will be used as the connection string name when referenced in a dependency.

Returns

IResourceBuilder<AzureOpenAIResource>

A reference to the IResourceBuilder<T>.

Remarks

By default references to the Azure OpenAI resource will be assigned the following roles:

- CognitiveServicesOpenAIContributor

These can be replaced by calling WithRoleAssignments<T>(IResourceBuilder<T>, IResourceBuilder<AzureOpenAIResource>, CognitiveServicesBuiltInRole[]).

Applies to

AddAzureOpenAI(IDistributedApplicationBuilder, String, Action<IResourceBuilder<AzureOpenAIResource>, ResourceModuleConstruct,CognitiveServicesAccount,IEnumerable<CognitiveServicesAccountDeployment>>)

Source:: AzureOpenAIExtensions.cs

Adds an Azure OpenAI resource to the application model.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource> AddAzureOpenAI(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource>,Aspire.Hosting.ResourceModuleConstruct,Azure.Provisioning.CognitiveServices.CognitiveServicesAccount,System.Collections.Generic.IEnumerable<Azure.Provisioning.CognitiveServices.CognitiveServicesAccountDeployment>>? configureResource);

static member AddAzureOpenAI : Aspire.Hosting.IDistributedApplicationBuilder * string * Action<Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource>, Aspire.Hosting.ResourceModuleConstruct, Azure.Provisioning.CognitiveServices.CognitiveServicesAccount, seq<Azure.Provisioning.CognitiveServices.CognitiveServicesAccountDeployment>> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.AzureOpenAIResource>

<Extension()>
Public Function AddAzureOpenAI (builder As IDistributedApplicationBuilder, name As String, configureResource As Action(Of IResourceBuilder(Of AzureOpenAIResource), ResourceModuleConstruct, CognitiveServicesAccount, IEnumerable(Of CognitiveServicesAccountDeployment))) As IResourceBuilder(Of AzureOpenAIResource)