(SCHEMA) Add extension secret to schema source #1083
Conversation
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
michaeltlombardi
approved these changes
Aug 28, 2025
|
@SteveL-MSFT - this looks correct to me from a docs perspective, just want the technical details double-checked. |
SteveL-MSFT
requested changes
Aug 29, 2025
Comment on lines
+16
to
+19
| The secret operation is expected to output a single line to stdout containing | ||
| the secret text. If the extension outputs no data to stdout, DSC treats it as | ||
| "no secret returned". If the extension outputs multiple lines, DSC treats that | ||
| as an error. |
There was a problem hiding this comment.
We should probably expand on this a bit more:
- Extensions MUST return the secret as a single line in plaintext with a zero exit code indicating success
- If the secret does NOT exist, then the extension MUST return no output AND a zero exit code indicating no failure of the extension
- If the extension cannot query/retrieve the secret (for example, needs the user to authenticate first), then the extension SHOULD return a detailed error message as a JSONLine to STDERR and MUST have a non-zero exit code
There was a problem hiding this comment.
@michaeltlombardi can help with the actual proposed text
|
|
||
| DSC expands structured entries as follows: | ||
|
|
||
| - `{ "nameArg": "<flag>" }` expands to `"<flag>", "<secret-name>"`. |
There was a problem hiding this comment.
@michaeltlombardi do we specify in other cases that the <flag> or parameter name MUST include any dashes, etc... as it's used verbatim?
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.
PR Summary
This changeset only adds the extension secret schema.
PR Context
Partially addresses #1082