[docs] Document AzureBicepResourceScope.CreateForSubscription/CreateForTenant - #1451
Draft
aspire-repo-bot[bot] wants to merge 2 commits into
Draft
[docs] Document AzureBicepResourceScope.CreateForSubscription/CreateForTenant#1451aspire-repo-bot[bot] wants to merge 2 commits into
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
…rTenant Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
14 tasks
|
|
||
| By default, Aspire deploys Bicep resources at the resource group scope. Some Bicep templates require a different [deployment scope](https://learn.microsoft.com/azure/azure-resource-manager/bicep/deploy-to-subscription), such as the subscription or the tenant. Set the `Scope` property on the Bicep resource using `AzureBicepResourceScope.CreateForSubscription` or `AzureBicepResourceScope.CreateForTenant`: | ||
|
|
||
| ```csharp title="AppHost.cs" |
Contributor
There was a problem hiding this comment.
We should also provide the typescript sample, or explain why it's not supported
There was a problem hiding this comment.
Copilot, please address this feedback
Contributor
There was a problem hiding this comment.
Addressed in 9ec0e8c. I updated the “Set the deployment scope” section to include C#/TypeScript tabs and added a TypeScript note explaining that AzureBicepResourceScope/Resource.Scope aren’t currently exposed in the TypeScript AppHost APIs.
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#18976
@sebastienrosTargeting
release/13.5based on the source PR milestone13.5.Why
PR #18976 renamed
AzureBicepResourceScope.ForSubscription/ForTenanttoCreateForSubscription/CreateForTenant(verb-phrase naming per API review) before these factory methods shipped. The Customize Azure resources page did not previously document Bicep deployment scoping at all, so this adds a new section covering the API using its final, shipped names.What changed
src/frontend/src/content/docs/integrations/cloud/azure/customize-resources.mdx: added a new### Set the deployment scopesection under Custom Bicep templates, showing how to useAzureBicepResourceScope.CreateForSubscription(...)andAzureBicepResourceScope.CreateForTenant()to setResource.Scopeon a Bicep resource, with a C# example adapted from the shipped API and its unit test, plus a note about matchingtargetScopein the Bicep template.No pages were newly created; one existing page was updated.