Skip to content

az batch (Core & Extension) | missing examples in reference content #29672

@dbradish-microsoft

Description

@dbradish-microsoft

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:

Note: 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 batch account autostorage-keys GA 1 84
az batch application GA 5 185
az batch application package GA 5 324
az batch application summary GA 2 17
az batch file GA 2 146
az batch job GA 9 81
az batch job prep-release-status GA 1 13
az batch job task-counts GA 1 42
az batch job-schedule GA 9 541
az batch location GA 1 123
az batch location quotas GA 1 64
az batch node GA 5 327
az batch node file GA 4 87
az batch node remote-desktop GA 1 145
az batch node remote-login-settings GA 1 145
az batch node scheduling GA 2 7
az batch node service-logs GA 1 134
az batch node user GA 3 88
az batch pool GA 7 1206
az batch pool autoscale GA 3 147
az batch pool node-counts GA 1 72
az batch pool supported-images GA 1 1665
az batch pool usage-metrics GA 1 60
az batch private-endpoint-connection GA 2 24
az batch private-link-resource GA 2 6
az batch task GA 7 539
az batch task file GA 4 104
az batch task subtask GA 1 50

Reference commands with no examples:

Note: Some of these command subgroups have at least one example. This table is a list of all az batch commands with no example. PV values repeat when one GitHub file contains > 1 reference command. PVs are being provided as a general idea of customer interest.

Reference name Parameter count is Create 6 month PVs
az batch account autostorage-keys sync 2 84
az batch account create 12 yes 659
az batch account delete 4 659
az batch account keys list 2 154
az batch account list 1 659
az batch account login 4 659
az batch account outbound-endpoints 2 659
az batch application create 4 yes 182
az batch application delete 4 182
az batch application list 3 199
az batch application package activate 5 324
az batch application package create 5 yes 324
az batch application package delete 5 324
az batch application package list 4 324
az batch application package show 4 324
az batch application set 6 182
az batch application show 3 182
az batch application summary list 3 17
az batch application summary show 4 17
az batch file download 8 146
az batch file upload 8 146
az batch job create 18 yes 729
az batch job delete 7
az batch job disable 9
az batch job enable 8
az batch job list 7
az batch job prep-release-status list 6 13
az batch job reset 17
az batch job set 17
az batch job show 10
az batch job stop 9
az batch job task-counts show 4 42
az batch job-schedule create 23 yes 541
az batch job-schedule delete 0 541
az batch job-schedule disable 8 541
az batch job-schedule enable 8 541
az batch job-schedule list 6 541
az batch job-schedule reset 29 541
az batch job-schedule set 32 541
az batch job-schedule show 10 541
az batch job-schedule stop 0 541
az batch location list-skus 3 123
az batch location quotas show 1 64
az batch node delete 12 327
az batch node file delete 8 87
az batch node file download 11 87
az batch node file list 7 87
az batch node file show 8 87
az batch node list 6 327
az batch node reboot 6 327
az batch node reimage 6 327
az batch node remote-desktop download 6 145
az batch node remote-login-settings show 5 145
az batch node scheduling disable 6 7
az batch node scheduling enable 5 7
az batch node service-logs upload 10 134
az batch node show 6 327
az batch node user create 11 yes 88
az batch node user delete 7 88
az batch node user reset 10 88
az batch pool autoscale disable 4 147
az batch pool autoscale enable 5 147
az batch pool autoscale evaluate 9 147
az batch pool create 50 yes 1206
az batch pool delete 0 1206
az batch pool list 11 1206
az batch pool node-counts list 4 72
az batch pool reset 9 1206
az batch pool resize 30 1206
az batch pool set 0 1206
az batch pool show 10 1206
az batch pool supported-images list 4 1665
az batch pool usage-metrics list 6 60
az batch private-endpoint-connection list 3 24
az batch private-endpoint-connection show 3 24
az batch private-link-resource list 3 6
az batch private-link-resource show 3 6
az batch task create 19 yes 539
az batch task delete 10 539
az batch task file delete 8 104
az batch task file download 11 104
az batch task file list 7 104
az batch task file show 8 104
az batch task list 7 539
az batch task reactivate 4 539
az batch task reset 13 539
az batch task show 11 539
az batch task stop 9 539
az batch task subtask list 6 50

Related command

az batch

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.63.0

Additional context

No response

Metadata

Metadata

Labels

Auto-AssignAuto assign by botBatchaz batchService AttentionThis issue is responsible by Azure service team.Similar-Issueact-observability-squadbugThis issue requires a change to an existing behavior in the product in order to be resolved.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions