From ccf13b9719524b8e77d5e1a21f78aaa30d1b2077 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Sun, 11 May 2025 20:07:11 +0300 Subject: [PATCH] az*, cradle-install: add option placeholders (#16433) --- pages/common/az-account.md | 4 ++-- pages/common/az-acr.md | 10 +++++----- pages/common/az-advisor.md | 6 +++--- pages/common/az-aks.md | 10 +++++----- pages/common/az-apim.md | 10 +++++----- pages/common/az-appconfig.md | 10 +++++----- pages/common/az-bicep.md | 4 ++-- pages/common/az-devops.md | 10 +++++----- pages/common/az-disk.md | 10 +++++----- pages/common/az-group.md | 8 ++++---- pages/common/az-image.md | 10 +++++----- pages/common/az-logicapp.md | 12 ++++++------ pages/common/az-login.md | 8 ++++---- pages/common/az-network.md | 4 ++-- pages/common/az-pipelines.md | 14 +++++++------- pages/common/az-provider.md | 6 +++--- pages/common/az-redis.md | 8 ++++---- pages/common/az-repos.md | 4 ++-- pages/common/az-serial-console.md | 2 +- pages/common/az-sshkey.md | 6 +++--- pages/common/az-storage-account.md | 8 ++++---- pages/common/az-storage-container.md | 6 +++--- pages/common/az-storage-entity.md | 10 +++++----- pages/common/az-storage-queue.md | 6 +++--- pages/common/az-storage-table.md | 6 +++--- pages/common/az-tag.md | 8 ++++---- pages/common/az-upgrade.md | 2 +- pages/common/az-version.md | 2 +- pages/common/az-vm.md | 10 +++++----- pages/common/az-webapp.md | 6 +++--- pages/common/cradle-install.md | 2 +- 31 files changed, 111 insertions(+), 111 deletions(-) diff --git a/pages/common/az-account.md b/pages/common/az-account.md index 756a1c3d16..3faff64730 100644 --- a/pages/common/az-account.md +++ b/pages/common/az-account.md @@ -10,7 +10,7 @@ - Set a `subscription` to be the currently active subscription: -`az account set --subscription {{subscription_id}}` +`az account set {{[-s|--subscription]}} {{subscription_id}}` - List supported regions for the currently active subscription: @@ -22,4 +22,4 @@ - Print details of the currently active subscription in a specific format: -`az account show --output {{json|tsv|table|yaml}}` +`az account show {{[-o|--output]}} {{json|tsv|table|yaml}}` diff --git a/pages/common/az-acr.md b/pages/common/az-acr.md index 263a09bfd6..bd98193073 100644 --- a/pages/common/az-acr.md +++ b/pages/common/az-acr.md @@ -6,11 +6,11 @@ - Create a managed container registry: -`az acr create --name {{registry_name}} --resource-group {{resource_group}} --sku {{sku}}` +`az acr create {{[-n|--name]}} {{registry_name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{sku}}` - Login to a registry: -`az acr login --name {{registry_name}}` +`az acr login {{[-n|--name]}} {{registry_name}}` - Tag a local image for ACR: @@ -26,12 +26,12 @@ - Delete an image from a registry: -`az acr repository delete --name {{registry_name}} --repository {{image_name}}:{{tag}}` +`az acr repository delete {{[-n|--name]}} {{registry_name}} --repository {{image_name}}:{{tag}}` - Delete a managed container registry: -`az acr delete --name {{registry_name}} --resource-group {{resource_group}} --yes` +`az acr delete {{[-n|--name]}} {{registry_name}} {{[-g|--resource-group]}} {{resource_group}} {{[-y|--yes]}}` - List images within a registry: -`az acr repository list --name {{registry_name}} --output table` +`az acr repository list {{[-n|--name]}} {{registry_name}} --output table` diff --git a/pages/common/az-advisor.md b/pages/common/az-advisor.md index 9ed3d960db..6acc713001 100644 --- a/pages/common/az-advisor.md +++ b/pages/common/az-advisor.md @@ -10,7 +10,7 @@ - Show Azure Advisor configuration for the given subscription or resource group: -`az advisor configuration show --resource_group {{resource_group}}` +`az advisor configuration show {{[-g|--resource-group]}} {{resource_group}}` - List Azure Advisor recommendations: @@ -18,8 +18,8 @@ - Enable Azure Advisor recommendations: -`az advisor recommendation enable --resource_group {{resource_group}}` +`az advisor recommendation enable {{[-g|--resource-group]}} {{resource_group}}` - Disable Azure Advisor recommendations: -`az advisor recommendation disable --resource_group {{resource_group}}` +`az advisor recommendation disable {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/az-aks.md b/pages/common/az-aks.md index 8654855f12..ed999c6cd4 100644 --- a/pages/common/az-aks.md +++ b/pages/common/az-aks.md @@ -6,20 +6,20 @@ - List AKS clusters: -`az aks list --resource-group {{resource_group}}` +`az aks list {{[-g|--resource-group]}} {{resource_group}}` - Create a new AKS cluster: -`az aks create --resource-group {{resource_group}} --name {{name}} --node-count {{count}} --node-vm-size {{size}}` +`az aks create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}} {{[-c|--node-count]}} {{count}} --node-vm-size {{size}}` - Delete an AKS cluster: -`az aks delete --resource-group {{resource_group}} --name {{name}}` +`az aks delete {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` - Get the access credentials for an AKS cluster: -`az aks get-credentials --resource-group {{resource_group}} --name {{name}}` +`az aks get-credentials {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` - Get the upgrade versions available for an AKS cluster: -`az aks get-upgrades --resource-group {{resource_group}} --name {{name}}` +`az aks get-upgrades {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}}` diff --git a/pages/common/az-apim.md b/pages/common/az-apim.md index 046b9dee08..11c41acd78 100644 --- a/pages/common/az-apim.md +++ b/pages/common/az-apim.md @@ -6,20 +6,20 @@ - List API Management services within a resource group: -`az apim list --resource-group {{resource_group}}` +`az apim list {{[-g|--resource-group]}} {{resource_group}}` - Create an API Management service instance: -`az apim create --name {{name}} --resource-group {{resource_group}} --publisher-email {{email}} --publisher-name {{name}}` +`az apim create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --publisher-email {{email}} --publisher-name {{name}}` - Delete an API Management service: -`az apim delete --name {{name}} --resource-group {{resource_group}}` +`az apim delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Show details of an API Management service instance: -`az apim show --name {{name}} --resource-group {{resource_group}}` +`az apim show {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Update an API Management service instance: -`az apim update --name {{name}} --resource-group {{resource_group}}` +`az apim update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/az-appconfig.md b/pages/common/az-appconfig.md index 5d099f8683..6fb82e8abc 100644 --- a/pages/common/az-appconfig.md +++ b/pages/common/az-appconfig.md @@ -6,11 +6,11 @@ - Create an App Configuration: -`az appconfig create --name {{name}} --resource-group {{group_name}} --location {{location}}` +`az appconfig create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{group_name}} {{[-l|--location]}} {{location}}` - Delete a specific App Configuration: -`az appconfig delete --resource-group {{rg_name}} --name {{appconfig_name}}` +`az appconfig delete {{[-g|--resource-group]}} {{rg_name}} {{[-n|--name]}} {{appconfig_name}}` - List all App Configurations under the current subscription: @@ -18,12 +18,12 @@ - List all App Configurations under a specific resource group: -`az appconfig list --resource-group {{rg_name}}` +`az appconfig list {{[-g|--resource-group]}} {{rg_name}}` - Show properties of an App Configuration: -`az appconfig show --name {{appconfig_name}}` +`az appconfig show {{[-n|--name]}} {{appconfig_name}}` - Update a specific App Configuration: -`az appconfig update --resource-group {{rg_name}} --name {{appconfig_name}}` +`az appconfig update {{[-g|--resource-group]}} {{rg_name}} {{[-n|--name]}} {{appconfig_name}}` diff --git a/pages/common/az-bicep.md b/pages/common/az-bicep.md index c7222be12e..ca69ec116e 100644 --- a/pages/common/az-bicep.md +++ b/pages/common/az-bicep.md @@ -10,11 +10,11 @@ - Build a Bicep file: -`az bicep build --file {{path/to/file.bicep}}` +`az bicep build {{[-f|--file]}} {{path/to/file.bicep}}` - Attempt to decompile an ARM template file to a Bicep file: -`az bicep decompile --file {{path/to/template_file.json}}` +`az bicep decompile {{[-f|--file]}} {{path/to/template_file.json}}` - Upgrade Bicep CLI to the latest version: diff --git a/pages/common/az-devops.md b/pages/common/az-devops.md index 507baca4fc..a4d5791690 100644 --- a/pages/common/az-devops.md +++ b/pages/common/az-devops.md @@ -6,20 +6,20 @@ - Set the Personal Access Token (PAT) to login to a particular organization: -`az devops login --organization {{organization_url}}` +`az devops login {{[--org|--organization]}} {{organization_url}}` - Open a project in the browser: -`az devops project show --project {{project_name}} --open` +`az devops project show {{[-p|--project]}} {{project_name}} --open` - List members of a specific team working on a particular project: -`az devops team list-member --project {{project_name}} --team {{team_name}}` +`az devops team list-member {{[-p|--project]}} {{project_name}} --team {{team_name}}` - Check the Azure DevOps CLI current configuration: -`az devops configure --list` +`az devops configure {{[-l|--list]}}` - Configure the Azure DevOps CLI behavior by setting a default project and a default organization: -`az devops configure --defaults project={{project_name}} organization={{organization_url}}` +`az devops configure {{[-d|--defaults]}} project={{project_name}} organization={{organization_url}}` diff --git a/pages/common/az-disk.md b/pages/common/az-disk.md index e787e26765..c2dbb07ca8 100644 --- a/pages/common/az-disk.md +++ b/pages/common/az-disk.md @@ -6,20 +6,20 @@ - Create a managed disk: -`az disk create --resource-group {{resource_group}} --name {{disk_name}} --size-gb {{size_in_gb}}` +`az disk create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[-z|--size-gb]}}{{size_in_gb}}` - List managed disks in a resource group: -`az disk list --resource-group {{resource_group}}` +`az disk list {{[-g|--resource-group]}} {{resource_group}}` - Delete a managed disk: -`az disk delete --resource-group {{resource_group}} --name {{disk_name}}` +`az disk delete {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}}` - Grant read or write access to a managed disk (for export): -`az disk grant-access --resource-group {{resource_group}} --name {{disk_name}} --access-level {{Read|Write}} --duration-in-seconds {{seconds}}` +`az disk grant-access {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[--access|--access-level]}} {{Read|Write}} --duration-in-seconds {{seconds}}` - Update disk size: -`az disk update --resource-group {{resource_group}} --name {{disk_name}} --size-gb {{new_size_in_gb}}` +`az disk update {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{disk_name}} {{[-z|--size-gb]}} {{new_size_in_gb}}` diff --git a/pages/common/az-group.md b/pages/common/az-group.md index 2a01359b05..0ae091a470 100644 --- a/pages/common/az-group.md +++ b/pages/common/az-group.md @@ -6,16 +6,16 @@ - Create a new resource group: -`az group create --name {{name}} --location {{location}}` +`az group create {{[-n|--name]}} {{name}} {{[-l|--location]}} {{location}}` - Check if a resource group exists: -`az group exists --name {{name}}` +`az group exists {{[-n|--name]}} {{name}}` - Delete a resource group: -`az group delete --name {{name}}` +`az group delete {{[-n|--name]}} {{name}}` - Wait until a condition of the resource group is met: -`az group wait --name {{name}} --{{created|deleted|exists|updated}}` +`az group wait {{[-n|--name]}} {{name}} --{{created|deleted|exists|updated}}` diff --git a/pages/common/az-image.md b/pages/common/az-image.md index c5ee798b87..d01278ac06 100644 --- a/pages/common/az-image.md +++ b/pages/common/az-image.md @@ -6,20 +6,20 @@ - List the custom images under a resource group: -`az image list --resource-group {{resource_group}}` +`az image list {{[-g|--resource-group]}} {{resource_group}}` - Create a custom image from managed disks or snapshots: -`az image create --resource-group {{resource_group}} --name {{name}} --os-type {{windows|linux}} --source {{os_disk_source}}` +`az image create {{[-g|--resource-group]}} {{resource_group}} {{[-n|--name]}} {{name}} --os-type {{windows|linux}} --source {{os_disk_source}}` - Delete a custom image: -`az image delete --name {{name}} --resource-group {{resource_group}}` +`az image delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Show details of a custom image: -`az image show --name {{name}} --resource-group {{resource_group}}` +`az image show {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Update custom images: -`az image update --name {{name}} --resource-group {{resource_group}} --set {{property=value}}` +`az image update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --set {{property=value}}` diff --git a/pages/common/az-logicapp.md b/pages/common/az-logicapp.md index daea7b040a..379cbc4cb2 100644 --- a/pages/common/az-logicapp.md +++ b/pages/common/az-logicapp.md @@ -6,24 +6,24 @@ - Create a logic app: -`az logicapp create --name {{name}} --resource-group {{resource_group}} --storage-account {{storage_account}}` +`az logicapp create {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} {{[-s|--storage-account]}} {{storage_account}}` - Delete a logic app: -`az logicapp delete --name {{name}} --resource-group {{resource_group}}` +`az logicapp delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - List logic apps: -`az logicapp list --resource-group {{resource_group}}` +`az logicapp list {{[-g|--resource-group]}} {{resource_group}}` - Restart a logic app: -`az logicapp restart --name {{name}} --resource-group {{resource_group}}` +`az logicapp restart {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Start a logic app: -`az logicapp start --name {{name}} --resource-group {{resource_group}}` +`az logicapp start {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Stop a logic app: -`az logicapp stop --name {{name}} --resource-group {{resource_group}}` +`az logicapp stop {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/az-login.md b/pages/common/az-login.md index 22740e6619..161dc32fee 100644 --- a/pages/common/az-login.md +++ b/pages/common/az-login.md @@ -10,16 +10,16 @@ - Log in with a service principal using a client secret: -`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{secret}} --tenant {{someone.onmicrosoft.com}}` +`az login --service-principal {{[-u|--username]}} {{http://azure-cli-service-principal}} {{[-p|--password]}} {{secret}} --tenant {{someone.onmicrosoft.com}}` - Log in with a service principal using a client certificate: -`az login --service-principal --username {{http://azure-cli-service-principal}} --password {{path/to/cert.pem}} --tenant {{someone.onmicrosoft.com}}` +`az login --service-principal {{[-u|--username]}} {{http://azure-cli-service-principal}} {{[-p|--password]}} {{path/to/cert.pem}} {{[-t|--tenant]}} {{someone.onmicrosoft.com}}` - Log in using a VM's system assigned identity: -`az login --identity` +`az login {{[-i|--identity]}}` - Log in using a VM's user assigned identity: -`az login --identity --username /subscriptions/{{subscription_id}}/resourcegroups/{{my_rg}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{my_id}}` +`az login {{[-i|--identity]}} {{[-u|--username]}} /subscriptions/{{subscription_id}}/resourcegroups/{{my_rg}}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{{my_id}}` diff --git a/pages/common/az-network.md b/pages/common/az-network.md index 8ad2d45bf1..6cbc28158d 100644 --- a/pages/common/az-network.md +++ b/pages/common/az-network.md @@ -14,8 +14,8 @@ - Create a virtual network: -`az network vnet create --address-prefixes {{10.0.0.0/16}} --name {{vnet}} --resource_group {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` +`az network vnet create --address-prefixes {{10.0.0.0/16}} {{[-n|--name]}} {{vnet}} {{[-g|--resource-group]}} {{group_name}} --submet-name {{subnet}} --subnet-prefixes {{10.0.0.0/24}}` - Enable accelerated networking for a network interface card: -`az network nic update --accelerated-networking true --name {{nic}} --resource-group {{resource_group}}` +`az network nic update --accelerated-networking true {{[-n|--name]}} {{nic}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/az-pipelines.md b/pages/common/az-pipelines.md index a403f7a67b..26a609f65d 100644 --- a/pages/common/az-pipelines.md +++ b/pages/common/az-pipelines.md @@ -6,28 +6,28 @@ - Create a new Azure Pipeline (YAML based): -`az pipelines create --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --description {{description}} --repository {{repository_name}} --branch {{branch_name}}` +`az pipelines create {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}} --description {{description}} --repository {{repository_name}} --branch {{branch_name}}` - Delete a specific pipeline: -`az pipelines delete --org {{organization_url}} --project {{project_name}} --id {{pipeline_id}}` +`az pipelines delete {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --id {{pipeline_id}}` - List pipelines: -`az pipelines list --org {{organization_url}} --project {{project_name}}` +`az pipelines list {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}}` - Enqueue a specific pipeline to run: -`az pipelines run --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` +`az pipelines run {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}}` - Get the details of a specific pipeline: -`az pipelines show --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}}` +`az pipelines show {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}}` - Update a specific pipeline: -`az pipelines update --org {{organization_url}} --project {{project_name}} --name {{pipeline_name}} --new-name {{pipeline_new_name}} --new-folder-path {{user1/production_pipelines}}` +`az pipelines update {{[--org|--organization]}} {{organization_url}} {{[-p|--project]}} {{project_name}} --name {{pipeline_name}} --new-name {{pipeline_new_name}} --new-folder-path {{user1/production_pipelines}}` - List all agents in a pool: -`az pipelines agent list --org {{organization_url}} --pool-id {{agent_pool}}` +`az pipelines agent list {{[--org|--organization]}} {{organization_url}} --pool-id {{agent_pool}}` diff --git a/pages/common/az-provider.md b/pages/common/az-provider.md index b9b7c59af4..5f34cd5d74 100644 --- a/pages/common/az-provider.md +++ b/pages/common/az-provider.md @@ -6,11 +6,11 @@ - Register a provider: -`az provider register --namespace {{Microsoft.PolicyInsights}}` +`az provider register {{[-n|--namespace]}} {{Microsoft.PolicyInsights}}` - Unregister a provider: -`az provider unregister --namespace {{Microsoft.Automation}}` +`az provider unregister {{[-n|--namespace]}} {{Microsoft.Automation}}` - List all providers for a subscription: @@ -18,7 +18,7 @@ - Show information about a specific provider: -`az provider show --namespace {{Microsoft.Storage}}` +`az provider show {{[-n|--namespace]}} {{Microsoft.Storage}}` - List all resource types for a specific provider: diff --git a/pages/common/az-redis.md b/pages/common/az-redis.md index 19338d7829..e2a1dcc46e 100644 --- a/pages/common/az-redis.md +++ b/pages/common/az-redis.md @@ -6,16 +6,16 @@ - Create a new Redis cache instance: -`az redis create --location {{location}} --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` +`az redis create --location {{location}} {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` - Update a Redis cache: -`az redis update --name {{name}} --resource-group {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` +`az redis update {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} --sku {{Basic|Premium|Standard}} --vm-size {{c0|c1|c2|c3|c4|c5|c6|p1|p2|p3|p4|p5}}` - Export data stored in a Redis cache: -`az redis export --container {{container}} --file-format {{file-format}} --name {{name}} --prefix {{prefix}} --resource-group {{resource_group}}` +`az redis export --container {{container}} --file-format {{file-format}} {{[-n|--name]}} {{name}} --prefix {{prefix}} {{[-g|--resource-group]}} {{resource_group}}` - Delete a Redis cache: -`az redis delete --name {{name}} --resource-group {{resource_group}} --yes` +`az redis delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}} {{[-y|--yes]}}` diff --git a/pages/common/az-repos.md b/pages/common/az-repos.md index 790b7c6c30..67e744c5c3 100644 --- a/pages/common/az-repos.md +++ b/pages/common/az-repos.md @@ -6,7 +6,7 @@ - List all repos in a specific project: -`az repos list --project {{project_name}}` +`az repos list {{[-p|--project]}} {{project_name}}` - Add policy on a specific branch of a specific repository to restrict basic merge: @@ -18,4 +18,4 @@ - List all active Pull Requests on a specific repository within a specific project: -`az repos pr list --project {{project_name}} --repository {{repository_name}} --status active` +`az repos pr list {{[-p|--project]}} {{project_name}} {{[-r|--repository]}} {{repository_name}} --status active` diff --git a/pages/common/az-serial-console.md b/pages/common/az-serial-console.md index 75cb397ea7..a65e8ea6eb 100644 --- a/pages/common/az-serial-console.md +++ b/pages/common/az-serial-console.md @@ -6,7 +6,7 @@ - Connect to a serial console: -`az serial-console connect --resource-group {{Resource_Group_Name}} --name {{Virtual_Machine_Name}}` +`az serial-console connect {{[-g|--resource-group]}} {{Resource_Group_Name}} {{[-n|--name]}} {{Virtual_Machine_Name}}` - Terminate the connection: diff --git a/pages/common/az-sshkey.md b/pages/common/az-sshkey.md index e07eb6c14a..042415135f 100644 --- a/pages/common/az-sshkey.md +++ b/pages/common/az-sshkey.md @@ -6,11 +6,11 @@ - Create a new SSH key: -`az sshkey create --name {{name}} --resource-group {{resource_group}}` +`az sshkey create --name {{name}} {{[-g|--resource-group]}} {{resource_group}}` - Upload an existing SSH key: -`az sshkey create --name {{name}} --resource-group {{resource_group}} --public-key "{{@path/to/key.pub}}"` +`az sshkey create --name {{name}} {{[-g|--resource-group]}} {{resource_group}} --public-key "{{@path/to/key.pub}}"` - List all SSH public keys: @@ -18,4 +18,4 @@ - Show information about an SSH public key: -`az sshkey show --name {{name}} --resource-group {{resource_group}}` +`az sshkey show --name {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/az-storage-account.md b/pages/common/az-storage-account.md index 495fa36eed..367fdbbb01 100644 --- a/pages/common/az-storage-account.md +++ b/pages/common/az-storage-account.md @@ -6,16 +6,16 @@ - Create an storage account: -`az storage account create --name {{storage_account_name}} --resource-group {{azure_resource_group}} --location {{azure_location}} --sku {{storage_account_sku}}` +`az storage account create {{[-n|--name]}} {{storage_account_name}} {{[-g|--resource-group]}} {{azure_resource_group}} --location {{azure_location}} --sku {{storage_account_sku}}` - Generate a shared access signature for a specific storage account: -`az storage account generate-sas --account-name {{storage_account_name}} --name {{account_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --services {{storage_services}} --resource-types {{resource_types}}` +`az storage account generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{account_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --services {{storage_services}} --resource-types {{resource_types}}` - List storage accounts: -`az storage account list --resource-group {{azure_resource_group}}` +`az storage account list {{[-g|--resource-group]}} {{azure_resource_group}}` - Delete a specific storage account: -`az storage account delete --name {{storage_account_name}} --resource-group {{azure_resource_group}}` +`az storage account delete {{[-n|--name]}} {{storage_account_name}} {{[-g|--resource-group]}} {{azure_resource_group}}` diff --git a/pages/common/az-storage-container.md b/pages/common/az-storage-container.md index 4526e05c4f..8354b83793 100644 --- a/pages/common/az-storage-container.md +++ b/pages/common/az-storage-container.md @@ -6,11 +6,11 @@ - Create a container in a storage account: -`az storage container create --account-name {{storage_account_name}} --name {{container_name}} --public-access {{access_level}} --fail-on-exist` +`az storage container create --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --public-access {{access_level}} --fail-on-exist` - Generate a shared access signature for the container: -`az storage container generate-sas --account-name {{storage_account_name}} --name {{container_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` +`az storage container generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` - List containers in a storage account: @@ -18,4 +18,4 @@ - Mark the specified container for deletion: -`az storage container delete --account-name {{storage_account_name}} --name {{container_name}} --fail-not-exist` +`az storage container delete --account-name {{storage_account_name}} {{[-n|--name]}} {{container_name}} --fail-not-exist` diff --git a/pages/common/az-storage-entity.md b/pages/common/az-storage-entity.md index c9327d58be..2e9491a7e6 100644 --- a/pages/common/az-storage-entity.md +++ b/pages/common/az-storage-entity.md @@ -6,20 +6,20 @@ - Insert an entity into a table: -`az storage entity insert --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity insert {{[-e|--entity]}} {{space_separated_key_value_pairs}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Delete an existing entity from a table: -`az storage entity delete --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity delete --partition-key {{partition_key}} --row-key {{row_key}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Update an existing entity by merging its properties: -`az storage entity merge --entity {{space_separated_key_value_pairs}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity merge {{[-e|--entity]}} {{space_separated_key_value_pairs}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - List entities which satisfy a query: -`az storage entity query --filter {{query_filter}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity query --filter {{query_filter}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` - Get an entity from the specified table: -`az storage entity show --partition-key {{partition_key}} --row-key {{row_key}} --table-name {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` +`az storage entity show --partition-key {{partition_key}} --row-key {{row_key}} {{[-t|--table-name]}} {{table_name}} --account-name {{storage_account_name}} --account-key {{storage_account_key}}` diff --git a/pages/common/az-storage-queue.md b/pages/common/az-storage-queue.md index ca75291682..60e8055cff 100644 --- a/pages/common/az-storage-queue.md +++ b/pages/common/az-storage-queue.md @@ -6,11 +6,11 @@ - Create a queue: -`az storage queue create --account-name {{storage_account_name}} --name {{queue_name}} --metadata {{queue_metadata}}` +`az storage queue create --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --metadata {{queue_metadata}}` - Generate a shared access signature for the queue: -`az storage queue generate-sas --account-name {{storage_account_name}} --name {{queue_name}} --permissions {{queue_permissions}} --expiry {{expiry_date}} --https-only` +`az storage queue generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --permissions {{queue_permissions}} --expiry {{expiry_date}} --https-only` - List queues in a storage account: @@ -18,4 +18,4 @@ - Delete the specified queue and any messages it contains: -`az storage queue delete --account-name {{storage_account_name}} --name {{queue_name}} --fail-not-exist` +`az storage queue delete --account-name {{storage_account_name}} {{[-n|--name]}} {{queue_name}} --fail-not-exist` diff --git a/pages/common/az-storage-table.md b/pages/common/az-storage-table.md index a93faeb9b4..afc4eb1e29 100644 --- a/pages/common/az-storage-table.md +++ b/pages/common/az-storage-table.md @@ -6,11 +6,11 @@ - Create a new table in the storage account: -`az storage table create --account-name {{storage_account_name}} --name {{table_name}} --fail-on-exist` +`az storage table create --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --fail-on-exist` - Generate a shared access signature for the table: -`az storage table generate-sas --account-name {{storage_account_name}} --name {{table_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` +`az storage table generate-sas --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --permissions {{sas_permissions}} --expiry {{expiry_date}} --https-only` - List tables in a storage account: @@ -18,4 +18,4 @@ - Delete the specified table and any data it contains: -`az storage table delete --account-name {{storage_account_name}} --name {{table_name}} --fail-not-exist` +`az storage table delete --account-name {{storage_account_name}} {{[-n|--name]}} {{table_name}} --fail-not-exist` diff --git a/pages/common/az-tag.md b/pages/common/az-tag.md index 2a1d64dfad..95176fd05d 100644 --- a/pages/common/az-tag.md +++ b/pages/common/az-tag.md @@ -6,15 +6,15 @@ - Create a tag value: -`az tag add-value --name {{tag_name}} --value {{tag_value}}` +`az tag add-value {{[-n|--name]}} {{tag_name}} --value {{tag_value}}` - Create a tag in the subscription: -`az tag create --name {{tag_name}}` +`az tag create {{[-n|--name]}} {{tag_name}}` - Delete a tag from the subscription: -`az tag delete --name {{tag_name}}` +`az tag delete {{[-n|--name]}} {{tag_name}}` - List all tags on a subscription: @@ -22,4 +22,4 @@ - Delete a tag value for a specific tag name: -`az tag remove-value --name {{tag_name}} --value {{tag_value}}` +`az tag remove-value {{[-n|--name]}} {{tag_name}} --value {{tag_value}}` diff --git a/pages/common/az-upgrade.md b/pages/common/az-upgrade.md index 0bab1237a8..f5cfefd3ee 100644 --- a/pages/common/az-upgrade.md +++ b/pages/common/az-upgrade.md @@ -14,4 +14,4 @@ - Upgrade Azure CLI and Extensions without prompting for confirmation: -`az version --all --yes` +`az version --all {{[-y|--yes]}}` diff --git a/pages/common/az-version.md b/pages/common/az-version.md index 366ceb94d5..843e54715d 100644 --- a/pages/common/az-version.md +++ b/pages/common/az-version.md @@ -10,4 +10,4 @@ - Show the current version of Azure CLI modules and extensions in a given format: -`az version --output {{json|table|tsv}}` +`az version {{[-o|--output]}} {{json|table|tsv}}` diff --git a/pages/common/az-vm.md b/pages/common/az-vm.md index e6d7d3dd03..c2917ded27 100644 --- a/pages/common/az-vm.md +++ b/pages/common/az-vm.md @@ -10,23 +10,23 @@ - Create a virtual machine using the default Ubuntu image and generate SSH keys: -`az vm create --resource-group {{rg}} --name {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` +`az vm create {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}} --image {{UbuntuLTS}} --admin-user {{azureuser}} --generate-ssh-keys` - Stop a Virtual Machine: -`az vm stop --resource-group {{rg}} --name {{vm_name}}` +`az vm stop {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Deallocate a Virtual Machine: -`az vm deallocate --resource-group {{rg}} --name {{vm_name}}` +`az vm deallocate {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Start a Virtual Machine: -`az vm start --resource-group {{rg}} --name {{vm_name}}` +`az vm start {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - Restart a Virtual Machine: -`az vm restart --resource-group {{rg}} --name {{vm_name}}` +`az vm restart {{[-g|--resource-group]}} {{rg}} {{[-n|--name]}} {{vm_name}}` - List VM images available in the Azure Marketplace: diff --git a/pages/common/az-webapp.md b/pages/common/az-webapp.md index 3c85f83f54..497d7b02fd 100644 --- a/pages/common/az-webapp.md +++ b/pages/common/az-webapp.md @@ -6,11 +6,11 @@ - List available runtimes for a web application: -`az webapp list-runtimes --os-type {{windows|linux}}` +`az webapp list-runtimes {{[-os|--os-type]}} {{windows|linux}}` - Create a web application: -`az webapp up --name {{name}} --location {{location}} --runtime {{runtime}}` +`az webapp up {{[-n|--name]}} {{name}} {{[-l|--location]}} {{location}} {{[-r|--runtime]}} {{runtime}}` - List all web applications: @@ -18,4 +18,4 @@ - Delete a specific web application: -`az webapp delete --name {{name}} --resource-group {{resource_group}}` +`az webapp delete {{[-n|--name]}} {{name}} {{[-g|--resource-group]}} {{resource_group}}` diff --git a/pages/common/cradle-install.md b/pages/common/cradle-install.md index bb6a068045..42a85d83e0 100644 --- a/pages/common/cradle-install.md +++ b/pages/common/cradle-install.md @@ -9,7 +9,7 @@ - Forcefully overwrite files: -`cradle install --force` +`cradle install {{[-f|--force]}}` - Skip running SQL migrations: