Skip to content

Add reference documentation for secret()#1075

Open
Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Gijsreyn:reference-doc-secret
Open

Add reference documentation for secret()#1075
Gijsreyn wants to merge 1 commit intoPowerShell:mainfrom
Gijsreyn:reference-doc-secret

Conversation

@Gijsreyn
Copy link
Copy Markdown
Collaborator

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

@Gijsreyn Gijsreyn force-pushed the reference-doc-secret branch 2 times, most recently from a6a6ec5 to f2e4096 Compare August 27, 2025 01:11
@Gijsreyn
Copy link
Copy Markdown
Collaborator Author

@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).

Comment thread docs/reference/schemas/config/functions/secret.md
Copilot AI review requested due to automatic review settings May 5, 2026 18:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 jsonc fencing 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).

Comment thread docs/reference/cli/function/index.md
Comment thread docs/reference/cli/function/index.md
Comment thread docs/reference/schemas/config/functions/secret.md
@michaeltlombardi
Copy link
Copy Markdown
Collaborator

@SteveL-MSFT - LGTM, could you give a quick final check for technical accuracy?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants