Comments (3)
@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.
Related Issues (20)
- Soft-delete should not be appearing here HOT 5
- echo does not work and produces non functional content. HOT 3
- Incorrect example HOT 2
- Warning about behavior of job start HOT 1
- az cli subscription management CSS not working HOT 5
- `az ml workspace create` is not working. Getting error- Missing dependent resources in workspace json HOT 4
- fabric-name required but documentation says not required HOT 2
- Information related to certificate validation points to non-existent link HOT 3
- SpotRestorePolicy Error: "InvalidParameter" HOT 4
- No output example in documentation HOT 3
- az pipelines create cli notes for "Azure Repo" does not work HOT 1
- Customer feedback | authenticate-azure-cli-service-principal | avoid displaying password in console HOT 2
- Customer feedback | get-started-tutorial-2-environment-syntax | missing prerequisite HOT 2
- az load test create | `--test-plan` does not work as expected HOT 3
- Service Principal in Azure cannot create DevBox in azure portals HOT 3
- Missing Premium SKU reference HOT 2
- azure vm run-command invoke with RunPowerShellScript does not fail with Exit 1 HOT 2
- Provide alternative way without email ID as input for fetching the azure user object ID HOT 2
- Cannot specify both -n and -s or -d in create policy command. HOT 2
- Consider migrating to the Azure Linux based image for Azure CLI. HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from azure-docs-cli.