Skip to content

[docs] Remove obsolete ASPIREAZURE001 suppression from role-assignments example - #1851

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20820-37858653998-1-d04732cfda06cd63
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20820-37858653998-1-d04732cfda06cd63

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20820

@mitchdenny

Target branch: Targeting release/17.0 based on the source PR milestone 17.0 (exact match on microsoft/aspire.dev).

Why this PR is needed

microsoft/aspire#20820 graduates five core Azure deployment APIs to stable by removing their [Experimental("ASPIREAZURE001")] attributes:

  • AzureEnvironmentResource
  • AzurePublishingContext
  • AzureEnvironmentResourceExtensions.AddAzureEnvironment
  • AzureEnvironmentResourceExtensions.WithLocation
  • AzureEnvironmentResourceExtensions.WithResourceGroup

The PR's "User-facing usage" section confirms that existing Azure environment configuration (builder.AddAzureEnvironment().WithLocation(...).WithResourceGroup(...)) no longer requires an ASPIREAZURE001 suppression.

A code sample in integrations/cloud/azure/role-assignments.mdx still showed #pragma warning disable ASPIREAZURE001 // AzureEnvironmentResource is Experimental ahead of a pipeline-step example that references AzureEnvironmentResource.PrepareResourcesStepName. Leaving this in place would incorrectly suggest the suppression is still required.

What changed

  • Removed the obsolete #pragma warning disable ASPIREAZURE001 directive (and its trailing blank line) from the C# code sample in integrations/cloud/azure/role-assignments.mdx, since AzureEnvironmentResource is no longer experimental.

Files modified

  • src/frontend/src/content/docs/integrations/cloud/azure/role-assignments.mdx

No new pages were created; this is a targeted update to an existing example to keep it accurate after the API graduation.

Generated by PR Documentation Check for #20820 · copilot · auto · 60.2 AIC · ⌖ 12.3 AIC · ⊞ 20.4K · ◷

…s example

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 Oct 8, 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 #1851. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1851 artifacts

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

Copy link
Copy Markdown
Member

docs-pr-reviewer report — [partial — phase A: all extracted claims evaluated; phase B: not run (docs site was not served in this automated run)]

Recommendation: approve

Source used: microsoft/aspire main via merged source PR microsoft/aspire#20820 (docs PR targets release/17.0; no matching branch checked).
PR status: draft, mergeable, opened 2026-10-08 (not stale)

Phase A — claims

  • ✅ verified: [Experimental("ASPIREAZURE001")] removed from AzureEnvironmentResource and its extensions, so the pragma is no longer needed.
  • ⚠️ nuance: the sample also uses builder.Pipeline.AddStep/WellKnownPipelineSteps; a human should confirm none of those need another suppression.

Phase B — doc-tester

Not run; rendering of the changed pages is not browser-checked.

🤖 Posted by aspire.dev - squad (AI Agent)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Confirming that AzureEnvironmentResource no longer requires ASPIREAZURE001 on release/17.0 requires upstream source or compiler validation, neither of which is available in this restricted snapshot.

No open issues 🎉

What changed in this PR

Updates the Azure role-assignment documentation to reflect the stabilization of AzureEnvironmentResource in Aspire 17.0, as described in microsoft/aspire#20820.

Changes:

  • Removes the obsolete ASPIREAZURE001 warning suppression and trailing blank line from the C# pipeline-step example; the remaining sample is unchanged.
File Description
src/​frontend/​src/​content/​docs/​integrations/​cloud/​azure/​role-assignments.mdx Removes the obsolete experimental-API suppression from the example.

Review effort: Balanced

@maddymontaquila

Copy link
Copy Markdown
Contributor

Superseded by #2176, which consolidates the 17.0 retired experimental diagnostics docs with a consistent format (Retired in: 17.0 badge and note, overview table, and a single What's new section).

Maddy Montaquila (maddymontaquila) added a commit that referenced this pull request Nov 16, 2026
## Summary

<!-- Describe what this pull request changes and why. -->

Consolidates the retired experimental diagnostic documentation for
Aspire 17.0, superseding the individual PRs against `release/17.0`.

- Marks 14 diagnostic pages as retired in 17.0, retaining their
historical content and guidance for removing suppressions.
- Updates the diagnostics overview and the 17.0 release notes, including
`ASPIREDENO001` and `ASPIRECONNECTIONSTRINGS001`, which don't have
dedicated pages.
- Explains that `ASPIRECOMPUTE002` was only partially graduated:
endpoint-mapping contracts are stable, while persistent-volume APIs
remain experimental.
- Removes retired suppressions and experimental cautions from affected
guides, while retaining the experimental image-building guidance for
`ASPIREPIPELINES003`.
- Notes that `ASPIRECSHARPAPPS001` was retired when `AddCSharpApp`
became obsolete. The broader migration and ProjectResource v2 guidance
is separate in #2180.

The retired diagnostic list was checked against `[Experimental("…")]`
usages in `microsoft/aspire` between `v13.6.5` and `release/17.0`.

Supersedes #1846, #1847, #1851, #1852, #1853, #1854, #1856, #1857,
#2127, #2167, #2168, #2169, #2170, #2171.

## Third-party links and affiliations

<!--
List any third-party links added or changed by this pull request and
disclose any
material affiliation with the linked organizations, such as employment,
sponsorship, or ownership. Write "None" if this pull request doesn't add
or
change third-party links.
-->

None

## Validation

<!-- List the checks you ran or explain why validation isn't needed. -->

- `git diff --check origin/release/17.0 --
src/frontend/src/content/docs` — passed.
- Frontend validation CI — passed; frontend build CI is pending.
- Local Astro build and tests were not run; Bun and frontend
dependencies were unavailable.

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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