Skip to content

[docs] Document Bicep parameter expressions for enum-valued SKU properties - #1859

Draft
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20557-37977079315-1-613034c6e672f350
Draft

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20557-37977079315-1-613034c6e672f350

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20557 (@sebastienros)

Target branch

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

Why this is needed

TypeScript AppHosts previously failed with A value of type String cannot be assigned to a BicepValue<T> when configureInfrastructure assigned a bicep().parameter(...) expression to an enum-valued Azure provisioning property, such as a Storage SKU name. The source PR fixes BicepValueProxy so string-backed Bicep expressions can flow into enum-valued properties without being mistaken for literal enum values. The source PR body includes a dedicated "User-facing usage" section with the exact pattern, which is the trigger signal for this docs update (pr_body_has_user_facing_section).

The existing "Configure SKUs and tiers" section in [Customize Azure resources]((aspire.dev/redacted) only showed assigning a literal enum value (e.g. StorageSkuName.StandardGrs) to sku.name. It didn't cover assigning a deployment-time Bicep expression, which previously wasn't supported for enum-valued properties.

What changed

Added a new subsection, "Assign a deployment-time expression to an enum-valued property", directly after "Configure SKUs and tiers" in integrations/cloud/azure/customize-resources.mdx. It:

  • Shows a TypeScript example assigning await bicep.parameter(storageSku) to sku.name on a Storage account, mirroring the source PR's usage sample.
  • Clarifies that a JavaScript string literal still must match one of the enum's values, and that only a Bicep expression can bypass that compile-time check because its value is resolved at deployment time.
  • Notes the Aspire 17.0 version floor for this capability (the target branch's upcoming release).

Files modified

  • src/frontend/src/content/docs/integrations/cloud/azure/customize-resources.mdx (updated, 24 lines added)

No new pages were created; this is an addition to an existing, actively maintained page.

Validation

Documentation-only change (new prose and a TypeScript code sample); no site build or test commands were run per the task's guidance that doc-only changes need no validation unless documentation tests exist. The added code sample mirrors the pattern validated by the source PR's own description (CLI build, aspire publish, and aspire deploy runs against Azure Storage).

Generated by PR Documentation Check for #20557 · copilot · auto · 117.6 AIC · ⌖ 11.4 AIC · ⊞ 20.4K · ◷

…ties

Documents the fix in microsoft/aspire#20557 that allows TypeScript
AppHosts to assign a bicep().parameter(...) expression to an
enum-valued Azure provisioning property (e.g. sku.name) without
Aspire mistaking the string-backed expression for an enum literal.

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

VS Code: Open PR #1859 artifacts

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

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.

0 participants