-
Notifications
You must be signed in to change notification settings - Fork 21.8k
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
gedrivera
wants to merge
4
commits into
MicrosoftDocs:main
Choose a base branch
from
gedrivera:eduardori/rde-restricted-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+37
−0
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -711,3 +711,40 @@ The command provides a link (if using cluster manager storage) or another comman | |
|
||
> [!NOTE] | ||
> Storage Account could be locked resulting in `403 This request is not authorized to perform this operation.` due to networking or firewall restrictions. Refer to the [cluster manager storage](#deprecated-method-verify-access-to-the-cluster-manager-storage-account) or the [user managed storage](#send-command-output-to-a-user-specified-storage-account) sections for procedures to verify access. | ||
|
||
## Executing a run-data-extracts-restricted Command | ||
|
||
The `run-data-extracts-restricted` command is a duplicate of the standard run-data-extracts command, created to support fine-grained access control via RBAC (Role-Based Access Control). It allows customers to run sensitive data extraction operations on BareMetalMachines with elevated privileges. | ||
|
||
The `run-data-extracts-restricted` is implemented as a new and separate API action. The action is to be introduced in the `v20250701preview` and `v20250901` GA API, and is designed to mirror the behavior of the original command but with restricted access to specific sub-commands.The following list contains the allowed sub commands for`run-data-extracts-restricted`: | ||
|
||
- `cluster-cve-report` | ||
- `mde-agent-information` | ||
|
||
## Prerequisites | ||
* minimum supported API of v20250701preview` or `v20250901` and above | ||
* Storage Blob Container has been configured | ||
* The target bare metal machine is on and ready. | ||
* The syntax for these commands is based on the <TODO: need to confirm az networkcloud cli version>+ version of the az networkcloud CLI. | ||
* Get the Cluster Managed Resource group name (cluster_MRG) that you created for Cluster resource. | ||
|
||
Command execution can be performed using `az networkcloud baremetalmachine run-data-extracts-restricted` and it accepts arguments similarly to the `run-data-extract`. | ||
|
||
**Example** | ||
|
||
```azurecli-interactive | ||
az networkcloud baremetalmachine run-data-extracts-restricted --name "<machine-name>" \ | ||
--resource-group "<cluster_MRG>" \ | ||
--subscription "<subscriptionID>" \ | ||
--commands '[{"arguments":["--min-severity=8"],"command":"cluster-cve-report"}]' \ | ||
--limit-time-seconds "600" | ||
--output-directory ~/path/to/my/output/directory | ||
``` | ||
|
||
|
||
[{"arguments":["--min-severity=8"],"command":"cluster-cve-report"}]' --output-directory ~/tmp | ||
|
||
|
||
### 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](). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||
This will require a separate blob container also be configured prior to usage. To setup the storage blob container (please look here)[] |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not needed