az sentinel | missing examples in reference content #8421
Description
Describe the bug
Bug category:
Missing information
Request:
The Azure CLI reference guidelines specifiy at least two examples for each command. Please review the Azure CLI reference guidelines for examples and parameters and add missing content to your source code.
If a parameter accepts JSON content, provide a JSON example in the parameter long or short summary, or in a separate code block.
Issue summary:
Understanding that not all “create” commands directly generate Microsoft revenue, every “create” or “add” minimally make a revenue-producing Azure resource possible. Consequently, create commands are the most important examples to add. Of secondary importance are reference commands with complex parameters (JSON, YAML, URLs, complex Azure resource IDs, multi-valued lists, key:value pairs, conditional parameters, parameter pairs ...).
Subgroups with no examples:
The commands for these subgroups are in the second table (below). Page views (PVs) for a subgroup are "the sum of all PVs for every autogenerated reference doc in that subgroup." When there is > 1 command in a single GitHub file, the same PV amount is counted for both commands. PVs are being provided as a general idea of customer interest.
| Subgroup name | Status | Command count | 6 month PVs |
|---|---|---|---|
| az sentinel alert-rule | GA | 6 | 382 |
| az sentinel alert-rule action | GA | 5 | 126 |
| az sentinel alert-rule template | GA | 2 | 106 |
| az sentinel analytics-setting | GA | 5 | 93 |
| az sentinel automation-rule | GA | 5 | 173 |
| az sentinel bookmark | GA | 6 | 47 |
| az sentinel bookmark relation | GA | 5 | 5 |
| az sentinel data-connector | GA | 7 | 557 |
| az sentinel enrichment domain-whois | GA | 1 | 39 |
| az sentinel enrichment ip-geodata | GA | 1 | 24 |
| az sentinel entity-query | GA | 5 | 100 |
| az sentinel entity-query template | GA | 2 | 5 |
| az sentinel incident | GA | 10 | 266 |
| az sentinel incident comment | GA | 5 | 53 |
| az sentinel incident relation | GA | 5 | 31 |
| az sentinel metadata | GA | 5 | 68 |
| az sentinel office-consent | GA | 3 | 16 |
| az sentinel onboarding-state | GA | 5 | 278 |
| az sentinel setting | GA | 5 | 211 |
| az sentinel source-control | GA | 6 | 84 |
| az sentinel threat-indicator | GA | 8 | 188 |
| az sentinel threat-indicator metric | GA | 1 | 11 |
| az sentinel watchlist | GA | 5 | 445 |
Create reference commands with no examples:
As there are 107 az sentinel reference commands without examples, the following table is a list of create or add commands that have the potential to increase Microsoft revenue.
| Reference name | Parameter count | is Create | 6 month PVs |
|---|---|---|---|
| az sentinel alert-rule action create | 7 | yes | 126 |
| az sentinel alert-rule create | 10 | yes | 459 |
| az sentinel analytics-setting create | 5 | yes | 93 |
| az sentinel automation-rule create | 8 | yes | 173 |
| az sentinel bookmark create | 20 | yes | 47 |
| az sentinel bookmark relation create | 6 | yes | 5 |
| az sentinel data-connector create | 24 | yes | 557 |
| az sentinel entity-query create | 5 | yes | 100 |
| az sentinel incident comment create | 6 | yes | 53 |
| az sentinel incident create | 17 | yes | 266 |
| az sentinel incident relation create | 6 | yes | 31 |
| az sentinel metadata create | 23 | yes | 68 |
| az sentinel onboarding-state create | 5 | yes | 278 |
| az sentinel setting create | 6 | yes | 211 |
| az sentinel source-control create | 13 | yes | 84 |
| az sentinel threat-indicator create | 30 | yes | 188 |
| az sentinel watchlist create | 24 | yes | 445 |
Related command
az sentinel
Errors
.
Issue script & Debug output
.
Expected behavior
Azure CLI published guidelines for reference examples
Environment Summary
Version 2.68.0
Additional context
No response