From 77eeb398b334063ef46db6c883e5a5ab311a8ace Mon Sep 17 00:00:00 2001 From: "aspire-repo-bot[bot]" <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Date: Fri, 15 May 2026 13:29:24 +0000 Subject: [PATCH] docs: document argument-based built-in resource commands (set-parameter/delete-parameter) Documents the changes from microsoft/aspire#17021 which renamed the built-in parameter commands and added structured arguments: - set-parameter (was parameter-set): accepts --value and --save-to-user-secrets - delete-parameter (was parameter-delete): accepts --delete-from-user-secrets Updates aspire-resource.mdx with a Built-in parameter commands section and adds a corresponding entry to the Aspire 13.4 what's new page. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../cli/commands/aspire-resource.mdx | 33 +++++++++++++++++- .../content/docs/whats-new/aspire-13-4.mdx | 34 +++++++++++++++++++ 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx index 8e897a27b..6bd4c7340 100644 --- a/src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx +++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-resource.mdx @@ -112,7 +112,38 @@ When executed without the `--apphost` option, the command: - **``** - The name of the resource command to execute, such as `start`, `stop`, or `restart`. + The name of the resource command to execute, such as `start`, `stop`, `restart`, `set-parameter`, or `delete-parameter`. + +## Built-in parameter commands + +Aspire provides two built-in resource commands for managing parameter resources at runtime. These commands accept named options and can be used non-interactively (for example, in scripts or automation): + +- **`set-parameter`** — Set the value of a parameter resource. The legacy name `parameter-set` is also accepted. + + | Option | Description | + | --- | --- | + | `--value ` | The value to assign to the parameter. Required. | + | `--save-to-user-secrets` | Save the value to the .NET user secrets store in addition to the running AppHost. Optional; defaults to preserving any existing saved state. | + + ```bash title="Aspire CLI" + aspire resource mydb-password set-parameter --value "MyStr0ngP@ssword" + aspire resource mydb-password set-parameter --value "MyStr0ngP@ssword" --save-to-user-secrets true + ``` + +- **`delete-parameter`** — Delete the current value of a parameter resource. The legacy name `parameter-delete` is also accepted. + + | Option | Description | + | --- | --- | + | `--delete-from-user-secrets` | Also remove the value from the .NET user secrets store. Optional. | + + ```bash title="Aspire CLI" + aspire resource mydb-password delete-parameter + aspire resource mydb-password delete-parameter --delete-from-user-secrets true + ``` + + ## Options diff --git a/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx b/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx index fe4dfef58..9b54cea19 100644 --- a/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx +++ b/src/frontend/src/content/docs/whats-new/aspire-13-4.mdx @@ -22,8 +22,42 @@ We'd love to hear what you think. Drop by [ +The old names (`parameter-set` and `parameter-delete`) are retained as aliases and continue to work. No action is required for existing scripts. + + +Built-in parameter commands + ## 🆙 Upgrade to Aspire 13.4