Skip to content

[docs] Document Cosmos DB emulator default changes - #1563

Open
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.6from
docs/pr-19510-32505041647-1-4bf2326c84331397
Open

[docs] Document Cosmos DB emulator default changes#1563
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.6from
docs/pr-19510-32505041647-1-4bf2326c84331397

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#19510

@eerhardt

Targeting release/17.0 — the latest release branch on microsoft/aspire.dev — because release/13.6 (from the source PR milestone 13.6) does not exist there.

Why

microsoft/aspire#19510 makes the Linux-based (vNext) Cosmos DB emulator the default for RunAsEmulator (previously stable/classic), introduces a new non-experimental RunAsClassicEmulator API for the classic emulator, obsoletes RunAsPreviewEmulator as a compatibility alias forwarding to RunAsEmulator, and promotes WithDataExplorer out of experimental status. This is a breaking-change PR (labeled breaking-change) with a "User-facing usage" section in the PR body, so the docs need to reflect the new default behavior and API surface.

What changed

  • integrations/cloud/azure/azure-cosmos-db/azure-cosmos-db-host.mdx:
    • Updated "Run as emulator" to describe RunAsEmulator defaulting to the vNext (vnext-latest) image, with a breaking-change Aside pointing users to RunAsClassicEmulator for the old behavior.
    • Added a new "Run as classic emulator" section documenting RunAsClassicEmulator (the stable image, TLS/SSL certificate requirement) and a note that RunAsPreviewEmulator is now an obsolete alias for RunAsEmulator.
    • Replaced the old "Run as preview emulator (Linux-based)" section (which required suppressing ASPIRECOSMOSDB001) with a "Configure the Data Explorer" section showing WithDataExplorer used directly with RunAsEmulator, since both APIs are no longer experimental.
  • diagnostics/aspirecosmosdb001.mdx: added a version note (matching the convention used for other retired experimental diagnostics, e.g. aspireazure002.mdx) explaining that as of Aspire 13.6 RunAsPreviewEmulator/WithDataExplorer are no longer experimental and don't trigger ASPIRECOSMOSDB001.

No new pages were created; both existing pages were updated in place.

Generated by PR Documentation Check for #19510 · auto · 105.4 AIC · ⌖ 7.49 AIC · ⊞ 19.6K ·

…AsClassicEmulator)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Aug 21, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1563. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1563 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

/>

<Aside type="note">
As of Aspire 13.6, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As of Aspire 13.6, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire.
As of Aspire 17.0, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire.

@IEvangelist David Pine (IEvangelist) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-accuracy review — cannot verify against source of truth

Status: Claim verification (Phase A) could not run, and doc-tester (Phase B) was skipped.

This PR targets release/13.6, but microsoft/aspire has not yet cut a release/13.6 branch. The latest release branch there is release/13.5; the 13.6 changes currently live on main.

This reviewer verifies each claim against the release branch the PR actually targets. When that branch doesn't exist in microsoft/aspire, I flag the mismatch instead of falling back to another branch (e.g. main): main may have diverged from what 13.6 will ship, which would risk both false "verified" and false "contradicted" verdicts. So I have not verified the individual claims in this PR — the emulator vNext-default change, RunAsClassicEmulator, the now-obsolete RunAsPreviewEmulator, WithDataExplorer / NotSupportedException, and the ASPIRECOSMOSDB001 note.

Because Phase A could not establish a source of truth, Phase B (doc-tester) was skipped as well.

Field Value
PR target branch release/13.6
Matching microsoft/aspire branch none (latest is release/13.5)
Head SHA reviewed 3f8dcf169867a598d39f5e05fccea00f07fe6d4a

Next step: once microsoft/aspire cuts release/13.6, push a new commit or re-request review and I'll verify every claim against that branch.

Automated docs-accuracy reviewer — branch-mismatch exit.

@adamint Adam Ratzman (adamint) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No additional issues beyond the existing review threads.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants