Add reference documentation for secret()#1075
Add reference documentation for secret()#1075Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Conversation
a6a6ec5 to
f2e4096
Compare
|
@michaeltlombardi After revisiting the examples, I have removed examples 3 and 4. Additionally, examples 1 and 2 have been rewritten, as they cannot be used in a string concatenation (still wondering why it couldn't be done even though the ARM docs also always directly use it on a property). |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds reference documentation for the secret() function and adjusts CLI function-list docs formatting to support additional functions going forward.
Changes:
- Added a new reference page describing
secret()syntax, parameters, examples, and security considerations. - Modified the CLI function index page content/formatting (including a switch to
jsoncfencing and truncation of a function list snippet).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/reference/schemas/config/functions/secret.md | New reference page documenting the secret() configuration document function. |
| docs/reference/cli/function/index.md | Updates the CLI docs for listing functions (but currently replaces a section with a truncation placeholder). |
c1d3340 to
1f7c29a
Compare
1f7c29a to
a7963ef
Compare
|
@SteveL-MSFT - LGTM, could you give a quick final check for technical accuracy? |
There was a problem hiding this comment.
Looks correct as it's currently implemented. However, we should see about changing the extension contract to return a secureString or secureObject, but that's probably a big change as the internals would need to expect this. I think the consideration is whether we want to fix that before we publish this doc.
PR Summary
This pull request adds the reference documentation for the
secret()function. Also, minor tweaks were made to the CLI command function to accommodate the addition of more functions without breaking the documentation.PR Context