Azure / Azure/azure-cli-extensions

az sentinel | missing examples in reference content

Open
#8,421 1 comment 0 reactions 0 assignees View on GitHub
bug sentinel Service Attention
Dominant language
Python
Stars
454
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
64

Description

### Describe the bug

### Bug category:
Missing information

### Request:
The [Azure CLI reference guidelines](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples) specifiy at least two examples for each command. Please review the Azure CLI reference guidelines for [examples](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples) and [parameters](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#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](https://docs.microsoft.com/cli/azure/sentinel/alert-rule) | GA | 6 | 382 |
| [az sentinel alert-rule action](https://docs.microsoft.com/cli/azure/sentinel/alert-rule/action) | GA | 5 | 126 |
| [az sentinel alert-rule template](https://docs.microsoft.com/cli/azure/sentinel/alert-rule/template) | GA | 2 | 106 |
| [az sentinel analytics-setting](https://docs.microsoft.com/cli/azure/sentinel/analytics-setting) | GA | 5 | 93 |
| [az sentinel automation-rule](https://docs.microsoft.com/cli/azure/sentinel/automation-rule) | GA | 5 | 173 |
| [az sentinel bookmark](https://docs.microsoft.com/cli/azure/sentinel/bookmark) | GA | 6 | 47 |
| [az sentinel bookmark relation](https://docs.microsoft.com/cli/azure/sentinel/bookmark/relation) | GA | 5 | 5 |
| [az sentinel data-connector](https://docs.microsoft.com/cli/azure/sentinel/data-connector) | GA | 7 | 557 |
| [az sentinel enrichment domain-whois](https://docs.microsoft.com/cli/azure/sentinel/enrichment/domain-whois) | GA | 1 | 39 |
| [az sentinel enrichment ip-geodata](https://docs.microsoft.com/cli/azure/sentinel/enrichment/ip-geodata) | GA | 1 | 24 |
| [az sentinel entity-query](https://docs.microsoft.com/cli/azure/sentinel/entity-query) | GA | 5 | 100 |
| [az sentinel entity-query template](https://docs.microsoft.com/cli/azure/sentinel/entity-query/template) | GA | 2 | 5 |
| [az sentinel incident](https://docs.microsoft.com/cli/azure/sentinel/incident) | GA | 10 | 266 |
| [az sentinel incident comment](https://docs.microsoft.com/cli/azure/sentinel/incident/comment) | GA | 5 | 53 |
| [az sentinel incident relation](https://docs.microsoft.com/cli/azure/sentinel/incident/relation) | GA | 5 | 31 |
| [az sentinel metadata](https://docs.microsoft.com/cli/azure/sentinel/metadata) | GA | 5 | 68 |
| [az sentinel office-consent](https://docs.microsoft.com/cli/azure/sentinel/office-consent) | GA | 3 | 16 |
| [az sentinel onboarding-state](https://docs.microsoft.com/cli/azure/sentinel/onboarding-state) | GA | 5 | 278 |
| [az sentinel setting](https://docs.microsoft.com/cli/azure/sentinel/setting) | GA | 5 | 211 |
| [az sentinel source-control](https://docs.microsoft.com/cli/azure/sentinel/source-control) | GA | 6 | 84 |
| [az sentinel threat-indicator](https://docs.microsoft.com/cli/azure/sentinel/threat-indicator) | GA | 8 | 188 |
| [az sentinel threat-indicator metric](https://docs.microsoft.com/cli/azure/sentinel/threat-indicator/metric) | GA | 1 | 11 |
| [az sentinel watchlist](https://docs.microsoft.com/cli/azure/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](https://docs.microsoft.com/cli/azure/sentinel/alert-rule/action#az-sentinel-alert-rule-action-create) | 7 | **yes** | 126 |
| [az sentinel alert-rule create](https://docs.microsoft.com/cli/azure/sentinel/alert-rule#az-sentinel-alert-rule-create) | 10 | **yes** | 459 |
| [az sentinel analytics-setting create](https://docs.microsoft.com/cli/azure/sentinel/analytics-setting#az-sentinel-analytics-setting-create) | 5 | **yes** | 93 |
| [az sentinel automation-rule create](https://docs.microsoft.com/cli/azure/sentinel/automation-rule#az-sentinel-automation-rule-create) | 8 | **yes** | 173 |
| [az sentinel bookmark create](https://docs.microsoft.com/cli/azure/sentinel/bookmark#az-sentinel-bookmark-create) | 20 | **yes** | 47 |
| [az sentinel bookmark relation create](https://docs.microsoft.com/cli/azure/sentinel/bookmark/relation#az-sentinel-bookmark-relation-create) | 6 | **yes** | 5 |
| [az sentinel data-connector create](https://docs.microsoft.com/cli/azure/sentinel/data-connector#az-sentinel-data-connector-create) | 24 | **yes** | 557 |
| [az sentinel entity-query create](https://docs.microsoft.com/cli/azure/sentinel/entity-query#az-sentinel-entity-query-create) | 5 | **yes** | 100 |
| [az sentinel incident comment create](https://docs.microsoft.com/cli/azure/sentinel/incident/comment#az-sentinel-incident-comment-create) | 6 | **yes** | 53 |
| [az sentinel incident create](https://docs.microsoft.com/cli/azure/sentinel/incident#az-sentinel-incident-create) | 17 | **yes** | 266 |
| [az sentinel incident relation create](https://docs.microsoft.com/cli/azure/sentinel/incident/relation#az-sentinel-incident-relation-create) | 6 | **yes** | 31 |
| [az sentinel metadata create](https://docs.microsoft.com/cli/azure/sentinel/metadata#az-sentinel-metadata-create) | 23 | **yes** | 68 |
| [az sentinel onboarding-state create](https://docs.microsoft.com/cli/azure/sentinel/onboarding-state#az-sentinel-onboarding-state-create) | 5 | **yes** | 278 |
| [az sentinel setting create](https://docs.microsoft.com/cli/azure/sentinel/setting#az-sentinel-setting-create) | 6 | **yes** | 211 |
| [az sentinel source-control create](https://docs.microsoft.com/cli/azure/sentinel/source-control#az-sentinel-source-control-create) | 13 | **yes** | 84 |
| [az sentinel threat-indicator create](https://docs.microsoft.com/cli/azure/sentinel/threat-indicator#az-sentinel-threat-indicator-create) | 30 | **yes** | 188 |
| [az sentinel watchlist create](https://docs.microsoft.com/cli/azure/sentinel/watchlist#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](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples)

### Environment Summary

Version 2.68.0

### Additional context

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the Azure CLI reference guidelines for examples and parameters, then inspect the source for the listed az sentinel command groups and create or add commands. Add the missing reference examples, including JSON examples where parameters accept JSON, and verify that the affected autogenerated reference pages contain the required examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, python
Domain
cli, cloud, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.