Skip to content

Remove redundant id in AspireExportAttribute usages #15769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndriySvyryd merged 10 commits into from
Apr 3, 2026
Merged

Remove redundant id in AspireExportAttribute usages #15769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f01290d
Remove redundant id parameter from AspireExportAttribute usages
Copilot Apr 1, 2026
caae0e9
Update TwoPassScanningGeneratedAspire.verified
AndriySvyryd Apr 1, 2026
48f64c0
Remove redundant id from PublishAsScheduledAzureContainerAppJob Aspir…
Copilot Apr 1, 2026
eca9135
Remove the type name from the default id for instance methods
AndriySvyryd Apr 1, 2026
d4a7912
Fix ASPIREEXPORT009 (Rule 7) to use effectiveExportId; add parameterl…
Copilot Apr 2, 2026
82c4efd
Refactor: compute GetDerivedExportId once, reuse for both ASPIREEXPOR…
Copilot Apr 2, 2026
c1b2f06
Suppress ASPIREEXPORT011 when ASPIREEXPORT009 fires; add instance-met…
Copilot Apr 2, 2026
2077fa2
Merge branch 'main' into copilot/remove-id-parameter-where-unnecessary
AndriySvyryd Apr 2, 2026
9db7025
Remove export name from WithEnvironment method
AndriySvyryd Apr 2, 2026
7cdb9eb
Remove route names from AspireExport attributes
AndriySvyryd Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public static class AzureAppConfigurationExtensions
///
/// These can be replaced by calling <see cref="WithRoleAssignments{T}(IResourceBuilder{T}, IResourceBuilder{AzureAppConfigurationResource}, AppConfigurationBuiltInRole[])"/>.
/// </remarks>
[AspireExport("addAzureAppConfiguration", Description = "Adds an Azure App Configuration resource")]
[AspireExport(Description = "Adds an Azure App Configuration resource")]
public static IResourceBuilder<AzureAppConfigurationResource> AddAzureAppConfiguration(this IDistributedApplicationBuilder builder, [ResourceName] string name)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down Expand Up @@ -93,7 +93,7 @@ public static IResourceBuilder<AzureAppConfigurationResource> AddAzureAppConfigu
/// <param name="builder">The Azure App Configuration resource builder.</param>
/// <param name="configureEmulator">Callback that exposes underlying container used for emulation to allow for customization.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
[AspireExport("runAsEmulator", Description = "Configures Azure App Configuration to run with the local emulator", RunSyncOnBackgroundThread = true)]
[AspireExport(Description = "Configures Azure App Configuration to run with the local emulator", RunSyncOnBackgroundThread = true)]
public static IResourceBuilder<AzureAppConfigurationResource> RunAsEmulator(this IResourceBuilder<AzureAppConfigurationResource> builder, Action<IResourceBuilder<AzureAppConfigurationEmulatorResource>>? configureEmulator = null)
{
if (builder.ApplicationBuilder.ExecutionContext.IsPublishMode)
Expand Down Expand Up @@ -127,7 +127,7 @@ public static IResourceBuilder<AzureAppConfigurationResource> RunAsEmulator(this
/// <param name="builder">The builder for the <see cref="AzureAppConfigurationEmulatorResource"/>.</param>
/// <param name="path">Relative path to the AppHost where emulator storage is persisted between runs. Defaults to the path '.aace'</param>
/// <returns>A builder for the <see cref="AzureAppConfigurationEmulatorResource"/>.</returns>
[AspireExport("withDataBindMount", Description = "Adds a data bind mount for the App Configuration emulator")]
[AspireExport(Description = "Adds a data bind mount for the App Configuration emulator")]
public static IResourceBuilder<AzureAppConfigurationEmulatorResource> WithDataBindMount(this IResourceBuilder<AzureAppConfigurationEmulatorResource> builder, string? path = null)
{
ArgumentNullException.ThrowIfNull(builder);
Expand All @@ -141,7 +141,7 @@ public static IResourceBuilder<AzureAppConfigurationEmulatorResource> WithDataBi
/// <param name="builder">The builder for the <see cref="AzureAppConfigurationEmulatorResource"/>.</param>
/// <param name="name">The name of the volume. Defaults to an auto-generated name based on the application and resource names.</param>
/// <returns>A builder for the <see cref="AzureAppConfigurationEmulatorResource"/>.</returns>
[AspireExport("withDataVolume", Description = "Adds a data volume for the App Configuration emulator")]
[AspireExport(Description = "Adds a data volume for the App Configuration emulator")]
public static IResourceBuilder<AzureAppConfigurationEmulatorResource> WithDataVolume(this IResourceBuilder<AzureAppConfigurationEmulatorResource> builder, string? name = null)
{
ArgumentNullException.ThrowIfNull(builder);
Expand All @@ -155,7 +155,7 @@ public static IResourceBuilder<AzureAppConfigurationEmulatorResource> WithDataVo
/// <param name="builder">Builder for the Azure App Configuration emulator container</param>
/// <param name="port">The port to bind on the host. If <see langword="null"/> is used, a random port will be assigned.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
[AspireExport("withHostPort", Description = "Sets the host port for the App Configuration emulator")]
[AspireExport(Description = "Sets the host port for the App Configuration emulator")]
public static IResourceBuilder<AzureAppConfigurationEmulatorResource> WithHostPort(this IResourceBuilder<AzureAppConfigurationEmulatorResource> builder, int? port)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down
12 changes: 6 additions & 6 deletions src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ internal static IDistributedApplicationBuilder AddAzureContainerAppsInfrastructu
/// <param name="builder">The distributed application builder.</param>
/// <param name="name">The name of the resource.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
[AspireExport("addAzureContainerAppEnvironment", Description = "Adds an Azure Container App Environment resource")]
[AspireExport(Description = "Adds an Azure Container App Environment resource")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> AddAzureContainerAppEnvironment(this IDistributedApplicationBuilder builder, string name)
{
builder.AddAzureContainerAppsInfrastructureCore();
Expand Down Expand Up @@ -410,7 +410,7 @@ public static IResourceBuilder<AzureContainerAppEnvironmentResource> AddAzureCon
/// This method allows for reusing the previously deployed resources if the application was deployed using
/// azd without calling <see cref="AddAzureContainerAppEnvironment"/>
/// </remarks>
[AspireExport("withAzdResourceNaming", Description = "Configures resources to use azd naming conventions")]
[AspireExport(Description = "Configures resources to use azd naming conventions")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithAzdResourceNaming(this IResourceBuilder<AzureContainerAppEnvironmentResource> builder)
{
builder.Resource.UseAzdNamingConvention = true;
Expand Down Expand Up @@ -440,7 +440,7 @@ public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithAzdReso
/// Use <see cref="WithAzdResourceNaming"/> to change those names as well.
/// </para>
/// </remarks>
[AspireExport("withCompactResourceNaming", Description = "Configures resources to use compact naming for length-constrained Azure resources")]
[AspireExport(Description = "Configures resources to use compact naming for length-constrained Azure resources")]
[Experimental("ASPIREACANAMING001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithCompactResourceNaming(this IResourceBuilder<AzureContainerAppEnvironmentResource> builder)
{
Expand All @@ -454,7 +454,7 @@ public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithCompact
/// <param name="builder">The AzureContainerAppEnvironmentResource to configure.</param>
/// <param name="enable">Whether to include the Aspire dashboard. Default is true.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
[AspireExport("withDashboard", Description = "Configures whether the Aspire dashboard is included in the container app environment")]
[AspireExport(Description = "Configures whether the Aspire dashboard is included in the container app environment")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithDashboard(this IResourceBuilder<AzureContainerAppEnvironmentResource> builder, bool enable = true)
{
builder.Resource.EnableDashboard = enable;
Expand All @@ -473,7 +473,7 @@ public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithDashboa
/// Note that explicit ports specified for development (e.g., port 8080) are still normalized
/// to standard ports (80/443) as required by Azure Container Apps.
/// </remarks>
[AspireExport("withHttpsUpgrade", Description = "Configures whether HTTP endpoints are upgraded to HTTPS")]
[AspireExport(Description = "Configures whether HTTP endpoints are upgraded to HTTPS")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithHttpsUpgrade(this IResourceBuilder<AzureContainerAppEnvironmentResource> builder, bool upgrade = true)
{
builder.Resource.PreserveHttpEndpoints = !upgrade;
Expand All @@ -487,7 +487,7 @@ public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithHttpsUp
/// <param name="workspaceBuilder">The resource builder for the <see cref="AzureLogAnalyticsWorkspaceResource"/> to use.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="builder"/> or <paramref name="workspaceBuilder"/> is null.</exception>
[AspireExport("withAzureLogAnalyticsWorkspace", Description = "Configures the container app environment to use a specific Log Analytics Workspace")]
Comment thread
AndriySvyryd marked this conversation as resolved.
[AspireExport(Description = "Configures the container app environment to use a specific Log Analytics Workspace")]
public static IResourceBuilder<AzureContainerAppEnvironmentResource> WithAzureLogAnalyticsWorkspace(this IResourceBuilder<AzureContainerAppEnvironmentResource> builder, IResourceBuilder<AzureLogAnalyticsWorkspaceResource> workspaceBuilder)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Azure.AppContainers/ContainerAppExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ public static IResourceBuilder<T> PublishAsAzureContainerAppJob<T>(this IResourc
/// </code>
/// </example>
/// </remarks>
[AspireExport("publishAsAzureContainerAppJob", Description = "Configures the compute resource as a manually triggered Azure Container App Job")]
[AspireExport(Description = "Configures the compute resource as a manually triggered Azure Container App Job")]
[Experimental("ASPIREAZURE002", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
public static IResourceBuilder<T> PublishAsAzureContainerAppJob<T>(this IResourceBuilder<T> resource)
where T : IComputeResource
Expand Down Expand Up @@ -250,7 +250,7 @@ public static IResourceBuilder<T> PublishAsScheduledAzureContainerAppJob<T>(this
/// <remarks>
/// This method is a convenience wrapper that configures the job with a schedule trigger using the specified cron expression.
/// </remarks>
[AspireExport("publishAsScheduledAzureContainerAppJob", Description = "Configures the compute resource as a scheduled Azure Container App Job")]
[AspireExport(Description = "Configures the compute resource as a scheduled Azure Container App Job")]
[Experimental("ASPIREAZURE002", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
internal static IResourceBuilder<T> PublishAsScheduledAzureContainerAppJob<T>(this IResourceBuilder<T> resource, string cronExpression)
where T : IComputeResource
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Azure.AppService/AzureAppServiceComputeResourceExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public static class AzureAppServiceComputeResourceExtensions
/// </code>
/// </example>
/// </remarks>
[AspireExport("publishAsAzureAppServiceWebsite", Description = "Publishes the compute resource as an Azure App Service website or deployment slot")]
[AspireExport(Description = "Publishes the compute resource as an Azure App Service website or deployment slot")]
public static IResourceBuilder<T> PublishAsAzureAppServiceWebsite<T>(this IResourceBuilder<T> builder,
Action<AzureResourceInfrastructure, WebSite>? configure = null,
Action<AzureResourceInfrastructure, WebSiteSlot>? configureSlot = null)
Expand Down Expand Up @@ -75,7 +75,7 @@ public static IResourceBuilder<T> PublishAsAzureAppServiceWebsite<T>(this IResou
/// <param name="builder">The compute resource builder.</param>
/// <returns>The updated compute resource builder.</returns>
/// <exception cref="InvalidOperationException">Thrown when the resource is not configured for Azure App Service publishing.</exception>
[AspireExport("skipEnvironmentVariableNameChecks", Description = "Skips Azure App Service environment variable name validation for the compute resource")]
[AspireExport(Description = "Skips Azure App Service environment variable name validation for the compute resource")]
public static IResourceBuilder<T> SkipEnvironmentVariableNameChecks<T>(this IResourceBuilder<T> builder)
where T : IComputeResource
{
Expand Down
8 changes: 4 additions & 4 deletions src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ internal static IDistributedApplicationBuilder AddAzureAppServiceInfrastructureC
/// <param name="builder">The distributed application builder.</param>
/// <param name="name">The name of the resource.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
[AspireExport("addAzureAppServiceEnvironment", Description = "Adds an Azure App Service environment resource")]
[AspireExport(Description = "Adds an Azure App Service environment resource")]
public static IResourceBuilder<AzureAppServiceEnvironmentResource> AddAzureAppServiceEnvironment(this IDistributedApplicationBuilder builder, string name)
{
builder.AddAzureAppServiceInfrastructureCore();
Expand Down Expand Up @@ -232,7 +232,7 @@ public static IResourceBuilder<AzureAppServiceEnvironmentResource> AddAzureAppSe
/// <param name="builder">The <see cref="IResourceBuilder{AzureAppServiceEnvironmentResource}"/> to configure.</param>
/// <param name="enable">Whether to include the Aspire dashboard. Default is true.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/> for chaining additional configuration.</returns>
[AspireExport("withDashboard", Description = "Configures whether the Aspire dashboard is included in the Azure App Service environment")]
[AspireExport(Description = "Configures whether the Aspire dashboard is included in the Azure App Service environment")]
public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithDashboard(this IResourceBuilder<AzureAppServiceEnvironmentResource> builder, bool enable = true)
{
builder.Resource.EnableDashboard = enable;
Expand All @@ -244,7 +244,7 @@ public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithDashboard
/// </summary>
/// <param name="builder">The AzureAppServiceEnvironmentResource to configure.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
[AspireExport("withAzureApplicationInsights", Description = "Enables Azure Application Insights for the Azure App Service environment")]
[AspireExport(Description = "Enables Azure Application Insights for the Azure App Service environment")]
public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithAzureApplicationInsights(this IResourceBuilder<AzureAppServiceEnvironmentResource> builder)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down Expand Up @@ -316,7 +316,7 @@ public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithDeploymen
/// <param name="builder">The AzureAppServiceEnvironmentResource to configure.</param>
/// <param name="deploymentSlot">The deployment slot for all App Services in the App Service Environment.</param>
/// <returns><see cref="IResourceBuilder{T}"/></returns>
[AspireExport("withDeploymentSlot", Description = "Configures the deployment slot for all Azure App Services in the environment")]
[AspireExport(Description = "Configures the deployment slot for all Azure App Services in the environment")]
public static IResourceBuilder<AzureAppServiceEnvironmentResource> WithDeploymentSlot(this IResourceBuilder<AzureAppServiceEnvironmentResource> builder, string deploymentSlot)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down
4 changes: 2 additions & 2 deletions src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public static class AzureApplicationInsightsExtensions
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{AzureApplicationInsightsResource}"/>.</returns>
[AspireExport("addAzureApplicationInsights", Description = "Adds an Azure Application Insights resource")]
[AspireExport(Description = "Adds an Azure Application Insights resource")]
public static IResourceBuilder<AzureApplicationInsightsResource> AddAzureApplicationInsights(this IDistributedApplicationBuilder builder, [ResourceName] string name)
=> AddAzureApplicationInsights(builder, name, logAnalyticsWorkspace: null);

Expand Down Expand Up @@ -145,7 +145,7 @@ public static IResourceBuilder<AzureApplicationInsightsResource> WithLogAnalytic
/// <param name="builder">The resource builder for <see cref="AzureApplicationInsightsResource"/>.</param>
/// <param name="logAnalyticsWorkspace">The resource builder for the <see cref="AzureLogAnalyticsWorkspaceResource"/>.</param>
/// <returns>The <see cref="IResourceBuilder{AzureApplicationInsightsResource}"/> for chaining.</returns>
[AspireExport("withLogAnalyticsWorkspace", Description = "Configures the Application Insights resource to use a Log Analytics Workspace")]
[AspireExport(Description = "Configures the Application Insights resource to use a Log Analytics Workspace")]
public static IResourceBuilder<AzureApplicationInsightsResource> WithLogAnalyticsWorkspace(
this IResourceBuilder<AzureApplicationInsightsResource> builder,
IResourceBuilder<AzureLogAnalyticsWorkspaceResource> logAnalyticsWorkspace)
Expand Down
6 changes: 3 additions & 3 deletions src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static class AzureOpenAIExtensions
///
/// These can be replaced by calling <see cref="WithRoleAssignments{T}(IResourceBuilder{T}, IResourceBuilder{AzureOpenAIResource}, CognitiveServicesBuiltInRole[])"/>.
/// </remarks>
[AspireExport("addAzureOpenAI", Description = "Adds an Azure OpenAI resource")]
[AspireExport(Description = "Adds an Azure OpenAI resource")]
public static IResourceBuilder<AzureOpenAIResource> AddAzureOpenAI(this IDistributedApplicationBuilder builder, [ResourceName] string name)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down Expand Up @@ -171,7 +171,7 @@ public static IResourceBuilder<AzureOpenAIResource> AddDeployment(this IResource
/// <param name="modelName">The name of the model to deploy.</param>
/// <param name="modelVersion">The version of the model to deploy.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
[AspireExport("addDeployment", Description = "Adds an Azure OpenAI deployment resource")]
[AspireExport(Description = "Adds an Azure OpenAI deployment resource")]
public static IResourceBuilder<AzureOpenAIDeploymentResource> AddDeployment(this IResourceBuilder<AzureOpenAIResource> builder, [ResourceName] string name, string modelName, string modelVersion)
{
ArgumentNullException.ThrowIfNull(builder);
Expand All @@ -191,7 +191,7 @@ public static IResourceBuilder<AzureOpenAIDeploymentResource> AddDeployment(this
/// <param name="builder">The Azure OpenAI Deployment resource builder.</param>
/// <param name="configure">A method that can be used for customizing the <see cref="AzureOpenAIDeploymentResource"/>.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
[AspireExport("withProperties", Description = "Configures properties of an Azure OpenAI deployment", RunSyncOnBackgroundThread = true)]
[AspireExport(Description = "Configures properties of an Azure OpenAI deployment", RunSyncOnBackgroundThread = true)]
public static IResourceBuilder<AzureOpenAIDeploymentResource> WithProperties(this IResourceBuilder<AzureOpenAIDeploymentResource> builder, Action<AzureOpenAIDeploymentResource> configure)
{
ArgumentNullException.ThrowIfNull(builder);
Expand Down
Loading
Loading