Customer feedback | az lab vm apply-artifacts | No JSON example given for `--artifacts` parameter

[dbradish-microsoft]

Describe the bug

This GitHub issue is being moved from MicrosoftDocs/azure-docs-cli issue 4701. This customer feedback is also being added to issue 29479 as this is another cusotmer complaint about this recurring documentation issue.

---

Engineering request

1. Please review Azure CLI reference example guidelines.
2. Add a long-summary description to the az lab vm apply-artifacts --artifacts parameter so customers have a clear example of what this JSON file format should look like.
3. Add a code block example that demonstrates the use of the --artifacts parameter

Customer feedback

Type of issue
Missing information

Feedback
When using az lab vm commands, it's possible to use in some cases the --artifacts argument. However, the schema expected for this argument is specified nowhere. I tried extracting it from the ARM template of the formula in the portal, it does not work. There are no links to documentation regarding this file.

Page URL
https://learn.microsoft.com/en-us/cli/azure/lab/vm?view=azure-cli-latest

Content source URL
https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/lab/vm.yml

Document Id
ef65acdc-464a-08c7-b013-d9e3f1560977

Related command

az lab vm apply-artifacts

Errors

.

Issue script & Debug output

.

Expected behavior

.

Environment Summary

Azure CLI 2.65.0

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[github-actions]

Here are some similar issues that might help you. Please check if they can solve your problem.

• Customer feedback | JSON and YAML file formats not provided | both Core & Extension #29479