Skip to content

adding rundataextractrestricted documentation #127485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

gedrivera
Copy link

@gedrivera gedrivera commented Aug 7, 2025

This PR adds additional documentation around the new RunDataExtractRestricted command. Since the command operation is the same I have added it as a subsection of the RunDataExtract documentation.

  • Added a section on how the command differs.
  • Added an example of how to run the command with az cli
  • Added list of supported commands in the restricted list.

Copy link
Contributor

@gedrivera : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 04e07d2:

✅ Validation status: passed

File Status Preview URL Details
articles/operator-nexus/howto-baremetal-run-data-extract.md ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 447e4ab:

✅ Validation status: passed

File Status Preview URL Details
articles/operator-nexus/howto-baremetal-run-data-extract.md ✅Succeeded

For more details, please refer to the build report.

@v-dirichards
Copy link
Contributor

@eak13

Can you review the proposed changes?

Important: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator bot added the aq-pr-triaged tracking label for the PR review team label Aug 7, 2025
az networkcloud baremetalmachine run-data-extracts-restricted --name "<machine-name>" \
--resource-group "<cluster_MRG>" \
--subscription "<subscription>" \
--commands '[{"arguments":["<arg1>","<arg2>"],"command":"<command1>"}]' \
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we update the example to show one of the supported commands instead of just a generic argument?

Also, we should indicate the minimum API version requirements somewhere in this update as it won't be available without the 2025-07-01 Preview or 2025-09-01 GA API, right? Otherwise, it comes across as they can go run this now with any API version.

@eak13
Copy link
Contributor

eak13 commented Aug 8, 2025 via email

Copy link
Contributor

⚠️ PRMerger: You can’t sign off on draft PR

  • You signed off, but this PR is a draft and can’t be merged. If you’re ready for this PR to be reviewed, select Ready for review toward the bottom of the PR, then sign off again.

Copy link
Contributor

Learn Build status updates of commit 147a01d:

✅ Validation status: passed

File Status Preview URL Details
articles/operator-nexus/howto-baremetal-run-data-extract.md ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

Learn Build status updates of commit 8a1492c:

⚠️ Validation status: warnings

File Status Preview URL Details
articles/operator-nexus/howto-baremetal-run-data-extract.md ⚠️Warning Details

articles/operator-nexus/howto-baremetal-run-data-extract.md

  • Line 18, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Prerequisites''. Each second level heading (H2) in an article must be unique.
  • Line 724, Column 1: [Warning: duplicate-h2s - See documentation] Duplicate heading: 'H2 'Prerequisites''. Each second level heading (H2) in an article must be unique.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

```


[{"arguments":["--min-severity=8"],"command":"cluster-cve-report"}]' --output-directory ~/tmp

Choose a reason for hiding this comment

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

not needed



### Storage and Output
Output is stored in a blob container specified by the `commandOutputSettings`. By default the `run-data-extract` command uses the same commandOutputSettings however for security purposes `run-data-extracts-restricted` stores outputs in a seperate blob container. For how to specify the commandOutputSettings override for runcommand [please follow this guide]().

Choose a reason for hiding this comment

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

Here is the PR for how to setup the override settings. We might need this to be merged so we can reference it
https://github.com/MicrosoftDocs/azure-docs-pr/pull/303758/files

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

Successfully merging this pull request may close these issues.

4 participants