Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 21, 2025

Fixes #5308

This PR updates all documentation to reflect the new polyglot-friendly environment variable format for service endpoints introduced in dotnet/aspire#12141.

Changes

The environment variable naming convention for service endpoints has been updated from the .NET-specific format to a more language-agnostic format that works seamlessly with JavaScript, Python, and other non-.NET technologies.

Before

Environment variables used the format services__{resourcename}__{endpointname}__{index}:

var apiservice = builder.AddProject<Projects.ApiService>("apiservice");
var frontend = builder.AddProject<Projects.Frontend>("frontend")
    .WithReference(apiservice);

This generated environment variables like:

  • services__apiservice__http__0="http://localhost:5455"
  • services__apiservice__https__0="https://localhost:7356"

After

Environment variables now use the format {RESOURCENAME}_{ENDPOINTNAME}:

The same code now generates:

  • APISERVICE_HTTP="http://localhost:5455"
  • APISERVICE_HTTPS="https://localhost:7356"

Updated Documentation

  • fundamentals/app-host-overview.md - Updated service endpoint environment variable format explanation and examples
  • get-started/build-aspire-apps-with-nodejs.md - Updated JavaScript integration examples (Angular, React, Vue)
  • deployment/manifest-format.md - Updated manifest format examples
  • deployment/azd/aca-deployment-azd-in-depth.md - Updated Azure Container Apps deployment examples
  • fundamentals/orchestrate-resources.md - Updated external service examples
  • extensibility/dev-tunnels-integration.md - Updated dev tunnels integration examples
  • testing/snippets/ - Updated test assertions across all three test frameworks (xUnit, MSTest, NUnit)

The new format is uppercase, doesn't include an index for single endpoints, and follows a consistent pattern that makes it easier to use in polyglot scenarios where non-.NET applications need to consume Aspire services.

Original prompt

Please address #5308 - by considering the changes in dotnet/aspire#12141. Look for all places where we refer to the structure of the env var, for example services__*


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


Internal previews

📄 File 🔗 Preview link
docs/deployment/azd/aca-deployment-azd-in-depth.md docs/deployment/azd/aca-deployment-azd-in-depth
docs/deployment/manifest-format.md docs/deployment/manifest-format
docs/extensibility/dev-tunnels-integration.md docs/extensibility/dev-tunnels-integration
docs/fundamentals/app-host-overview.md docs/fundamentals/app-host-overview
docs/fundamentals/orchestrate-resources.md docs/fundamentals/orchestrate-resources
docs/get-started/build-aspire-apps-with-nodejs.md docs/get-started/build-aspire-apps-with-nodejs

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Update references to env var structure in documentation Update environment variable format to polyglot-friendly pattern Oct 21, 2025
Copilot finished work on behalf of IEvangelist October 21, 2025 12:17
Copilot AI requested a review from IEvangelist October 21, 2025 12:17
@IEvangelist IEvangelist marked this pull request as ready for review October 23, 2025 11:52
@IEvangelist IEvangelist merged commit 0fec1c7 into release-13 Oct 23, 2025
12 checks passed
@IEvangelist IEvangelist deleted the copilot/update-env-var-structure-references branch October 23, 2025 11:55
IEvangelist added a commit that referenced this pull request Nov 11, 2025
* Document ClaimActions configuration for dashboard OpenID Connect authentication (#5192)

* Initial plan

* Document ClaimActions configuration for dashboard OIDC authentication

Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>

* Apply suggestion from @JamesNK

* Apply suggestion from @JamesNK

* Apply suggestion from @JamesNK

* Update configuration.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: James Newton-King <james@newtonking.com>

* Document breaking change: DefaultAzureCredential defaults to ManagedIdentityCredential on ACA and App Service (#5303)

* Initial plan

* Add breaking change documentation for DefaultAzureCredential in 13.0

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix markdown linting error - add blank line before list

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update docs/compatibility/13.0/defaultazurecredential-managedidentity-default.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update Azure AI Foundry and GitHub Models documentation to use strongly-typed model constants (#5302)

* Initial plan

* Update documentation to use AIFoundryModel and GitHubModel constants

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update compatibility matrix to use GitHubModel constant

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update environment variable format to polyglot-friendly pattern (#5320)

* Initial plan

* Update environment variable format to polyglot-friendly pattern

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update AppHost project documentation for Aspire 13.0 SDK format (#5319)

* Initial plan

* Update AppHost project section to show new SDK format for Aspire 13.0

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md (#5318)

* Initial plan

* Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Apply suggestions from code review

* Update docs/fundamentals/app-host-overview.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Add breaking changes documentation for pipeline activity reporter API rename (PR #12137) (#5310)

* Initial plan

* Add breaking changes article for PR #12137 and update documentation

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix parameter naming consistency in breaking change examples

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix cross reference warnings by using inline code formatting

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Add documentation for ASPIREPIPELINES001, ASPIREPIPELINES002, and ASPIREPIPELINES003 diagnostics (#5359)

* Initial plan

* Add documentation for three new pipeline-related diagnostics

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Fix ms.date to reflect current date in diagnostic documentation

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

* Add ASPIREPIPELINES001-003 diagnostics to TOC

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add Aspire MCP docs (#5446)

* Update configuration

* Document deployment state caching (#5301)

* Initial plan

* Add local deployment state documentation

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Address feedback: Add intros, italicize paths, add CI/CD example

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Rename and relocate deployment state doc outside Azure section

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Clarify cache save behavior in GitHub Actions example

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add certificate trust customization article for Aspire 13 (#5311)

* Initial plan

* Add certificate trust customization article

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Fix cross-reference title to match actual article title

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Address PR feedback: update API examples, add runtime callout, document default scopes

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update callback APIs to use async Task and simplified context objects

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Replace deprecated callback APIs with new simplified APIs

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update documentation for new polyglot environment variables (issue #5308) (#5313)

* Initial plan

* Update documentation with new polyglot environment variable format

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Add clarification about resource names in environment variables

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Improve clarity of note about connection name parameter

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>

* Update docs/fundamentals/app-host-overview.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: David Pine <david.pine@microsoft.com>

* Update documentation for Aspire 13 release

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: build

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com>
Co-authored-by: James Newton-King <james@newtonking.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants