examples do not work as-is with copy/paste as is apparently intended about azure-docs-cli HOT 3 CLOSED

@lmamakos
Thanks for your feedback! We will investigate and update as appropriate.

from azure-docs-cli.

@lmamakos
Thanks for bringing this to our attention.
I'm going to assign this to the document author so they can take a look at it accordingly.

from azure-docs-cli.

@lmamakos, When you see a parameter value in angled bracets <>, it is an indicator to replace what is inside of the brackets with an actual value from your own environment. This particular tutorial has prerequisite steps to create a resouce group with a random ID, thus the parameter value msdocs-rg-00000000 vs something like myResourceGroupName.

I do see your point in the docs within this tutorial assuming a customer knows to also quote their parameter value, so I've updated the instance you brought to our attention plus several others in PR #4347.

I appreciate your comments about our Copy button as well. Some scripts can run as-is, like this one:

for rgList in $(az group list --query "[?starts_with(name, 'msdocs') == \`true\`].name" -o tsv); 
do
    az group delete --name $rgList --yes --no-wait
done

However, most Azure CLI commands require an actual resource group name or subscription ID like this example:

rgName="myResourceGroupName"

# Delete storage accounts without a confirmation prompt.
for saList in $(az storage account list --resource-group $rgName \
    --query "[?starts_with(name, 'msdocs') == \`true\`].id" \
    --output tsv); do
    echo "deleting storage account $saList"
    az storage account delete --ids $saList --yes
done

I hear your point about the comment character, and here is a good discussion on this topic in StackExchange: zsh comment character. As the Azure CLI can be run in many environments, we have chosen to standardize on the # character for comments.

Thank you for your feedback and for helping us improve Azure CLI docs.

from azure-docs-cli.