Add documentation for x-radius-sensitive annotation#97
Draft
lakshmimsft wants to merge 3 commits intomainfrom
Draft
Add documentation for x-radius-sensitive annotation#97lakshmimsft wants to merge 3 commits intomainfrom
lakshmimsft wants to merge 3 commits intomainfrom
Conversation
Signed-off-by: lakshmimsft <ljavadekar@microsoft.com>
zachcasper
requested changes
Feb 10, 2026
Contributor
zachcasper
left a comment
There was a problem hiding this comment.
Suggested wording clarification
| - Properties that are required must be listed in the `required` block. | ||
| - Properties that are set by the Recipe only after the resource is deployed must be marked as `readOnly: true`. | ||
| - Have a `type`. Valid types are:`integer`, `string`, `object`, `enum`, and `array`. | ||
| - Properties that contain sensitive data such as passwords, tokens, or keys must be marked with `x-radius-sensitive: true`. This annotation can be applied to properties of type `string` or `object`. Radius will automatically encrypt these fields before database storage and redact them during deployment. Internally, when generating Bicep types, these properties of type `string` will map to `secureString`, and `object` map to `secureObject`. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Properties that contain sensitive data such as passwords, tokens, or keys must be marked with `x-radius-sensitive: true`. This annotation can be applied to properties of type `string` or `object`. Radius will automatically encrypt these fields before database storage and redact them during deployment. Internally, when generating Bicep types, these properties of type `string` will map to `secureString`, and `object` map to `secureObject`. | |
| - Properties that contain sensitive data such as passwords, tokens, or keys must be marked with `x-radius-sensitive: true`. This annotation can be applied to properties of type `string` or `object`. Radius will temporarily encrypted the data using the `radius-encryption-key` secret then store in the Radius data store until deployment completes. Once the deployment completes (successful or otherwise), the data is deleted. |
Contributor
Author
There was a problem hiding this comment.
that's a bit incorrect. the data is encrypted temporarily but it is deleted during deployment even before recipe processing. data is not persisted till the deployment completes/fails. Updating to:
Radius will encrypt the data using the radius-encryption-key secret and store it temporarily in the Radius data store; it will be deleted during deployment processing.
|
|
||
| - `context.properties.data` (object, required): A map of secret names to objects containing values and optional encoding. Each key in the `data` object maps to an object with: | ||
| - `value` (string, required): The secret value. | ||
| - `value` (string, required): The secret value. This field is annotated with `x-radius-sensitive`, which means Radius will encrypt it before database storage and redact it during deployment. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `value` (string, required): The secret value. This field is annotated with `x-radius-sensitive`, which means Radius will encrypt it before database storage and redact it during deployment. | |
| - `value` (string, required): The secret value. This field is annotated with `x-radius-sensitive`, which means Radius will temporarily encrypted the data using the `radius-encryption-key` secret then store in the Radius data store until deployment completes. Once the deployment completes (successful or otherwise), the data is deleted. |
Contributor
Author
There was a problem hiding this comment.
the suggestion is not accurate. keeping it as is unless there are other wording suggestions.
Signed-off-by: lakshmimsft <ljavadekar@microsoft.com>
9231a82 to
1bb1c84
Compare
Signed-off-by: lakshmimsft <ljavadekar@microsoft.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.
Description
Add documentation for custom annotation
x-radius-sensitiveRelated GitHub Issue: link
Testing
Contributor Checklist
rad resource-type showis correctenum: []required: []for every object property (not just the top-level properties)readOnly: true