Skip to content

Commit 39ceb83

Browse files
committed
Updated command parameters with long-form formatting
1 parent 96d123f commit 39ceb83

8 files changed

+26
-26
lines changed

articles/aks/azure-blob-csi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ Using the Azure CLI, you can enable the Blob storage CSI driver on a new or exis
4747
To enable the driver on a new cluster, include the `--enable-blob-driver` parameter with the `az aks create` command as shown in the following example:
4848

4949
```azurecli
50-
az aks create --enable-blob-driver -n myAKSCluster -g myResourceGroup
50+
az aks create --enable-blob-driver --name myAKSCluster --resource-group myResourceGroup
5151
```
5252

5353
To enable the driver on an existing cluster, include the `--enable-blob-driver` parameter with the `az aks update` command as shown in the following example:
5454

5555
```azurecli
56-
az aks update --enable-blob-driver -n myAKSCluster -g myResourceGroup
56+
az aks update --enable-blob-driver --name myAKSCluster --resource-group myResourceGroup
5757
```
5858

5959
You're prompted to confirm there isn't an open-source Blob CSI driver installed. After you confirm, it may take several minutes to complete this action. Once it's complete, you should see in the output the status of enabling the driver on your cluster. The following example resembles the section indicating the results of the previous command:
@@ -72,7 +72,7 @@ Using the Azure CLI, you can disable the Blob storage CSI driver on an existing
7272
To disable the driver on an existing cluster, include the `--disable-blob-driver` parameter with the `az aks update` command as shown in the following example:
7373

7474
```azurecli
75-
az aks update --disable-blob-driver -n myAKSCluster -g myResourceGroup
75+
az aks update --disable-blob-driver --name myAKSCluster --resource-group myResourceGroup
7676
```
7777

7878
## Use a persistent volume with Azure Blob storage

articles/aks/azure-disk-customer-managed-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Either create a new resource group, or select an existing resource group hosting
8989
Run the following command to retrieve the DiskEncryptionSet value and set a variable:
9090

9191
```azurecli-interactive
92-
diskEncryptionSetId=$(az disk-encryption-set show --name mydiskEncryptionSetName --resource-gorup myResourceGroup --query "[id]" -o tsv)
92+
diskEncryptionSetId=$(az disk-encryption-set show --name mydiskEncryptionSetName --resource-group myResourceGroup --query "[id]" -o tsv)
9393
```
9494

9595
If you want to create a new resource group for the cluster, run the following command:

articles/aks/istio-meshconfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This guide assumes you followed the [documentation][istio-deploy-addon] to enabl
2323
1. Find out which revision of Istio is deployed on the cluster:
2424

2525
```bash
26-
az aks show -n $CLUSTER -g $RESOURCE_GROUP --query 'serviceMeshProfile'
26+
az aks show --name $CLUSTER --resource-group $RESOURCE_GROUP --query 'serviceMeshProfile'
2727
```
2828

2929
Output:

articles/aks/keda-deploy-add-on-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ To install the KEDA add-on, use `--enable-keda` when creating or updating a clus
7474
- Verify the KEDA add-on is installed on your cluster using the [`az aks show`][az-aks-show] command and set the `--query` parameter to `workloadAutoScalerProfile.keda.enabled`.
7575
7676
```azurecli-interactive
77-
az aks show -g myResourceGroup --name myAKSCluster --query "workloadAutoScalerProfile.keda.enabled"
77+
az aks show --resource-group myResourceGroup --name myAKSCluster --query "workloadAutoScalerProfile.keda.enabled"
7878
```
7979
8080
The following example output shows the KEDA add-on is installed on the cluster:

articles/aks/upgrade-aks-cluster.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -230,10 +230,10 @@ AKS accepts both integer values and a percentage value for max surge. An integer
230230
231231
```azurecli-interactive
232232
# Set max surge for a new node pool
233-
az aks nodepool add -n mynodepool -g MyResourceGroup --cluster-name MyManagedCluster --max-surge 33%
233+
az aks nodepool add --name mynodepool --resource-group MyResourceGroup --cluster-name MyManagedCluster --max-surge 33%
234234
235235
# Update max surge for an existing node pool
236-
az aks nodepool update -n mynodepool -g MyResourceGroup --cluster-name MyManagedCluster --max-surge 5
236+
az aks nodepool update --name mynodepool --resource-group MyResourceGroup --cluster-name MyManagedCluster --max-surge 5
237237
```
238238
239239
#### Set node drain timeout value
@@ -244,10 +244,10 @@ At times, you may have a long running workload on a certain pod and it can't be
244244
245245
```azurecli-interactive
246246
# Set drain timeout for a new node pool
247-
az aks nodepool add -n mynodepool -g MyResourceGroup --cluster-name MyManagedCluster --drain-timeout 100
247+
az aks nodepool add --name mynodepool --resource-group MyResourceGroup --cluster-name MyManagedCluster --drain-timeout 100
248248
249249
# Update drain timeout for an existing node pool
250-
az aks nodepool update -n mynodepool -g MyResourceGroup --cluster-name MyManagedCluster --drain-timeout 45
250+
az aks nodepool update --name mynodepool --resource-group MyResourceGroup --cluster-name MyManagedCluster --drain-timeout 45
251251
```
252252
253253
#### Set node soak time value
@@ -258,13 +258,13 @@ To allow for a duration of time to wait between draining a node and proceeding t
258258
259259
```azurecli-interactive
260260
# Set node soak time for a new node pool
261-
az aks nodepool add -n MyNodePool -g MyResourceGroup --cluster-name MyManagedCluster --node-soak-duration 10
261+
az aks nodepool add --name MyNodePool --resource-group MyResourceGroup --cluster-name MyManagedCluster --node-soak-duration 10
262262
263263
# Update node soak time for an existing node pool
264-
az aks nodepool update -n MyNodePool -g MyResourceGroup --cluster-name MyManagedCluster --max-surge 33% --node-soak-duration 5
264+
az aks nodepool update --name MyNodePool --resource-group MyResourceGroup --cluster-name MyManagedCluster --max-surge 33% --node-soak-duration 5
265265
266266
# Set node soak time when upgrading an existing node pool
267-
az aks nodepool upgrade -n MyNodePool -g MyResourceGroup --cluster-name MyManagedCluster --max-surge 33% --node-soak-duration 20
267+
az aks nodepool upgrade --name MyNodePool --resource-group MyResourceGroup --cluster-name MyManagedCluster --max-surge 33% --node-soak-duration 20
268268
```
269269
270270
## View upgrade events

articles/aks/use-ultra-disks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This feature can only be set at cluster creation or when creating a node pool.
2929
Create an AKS cluster that is able to leverage Azure ultra Disks by using the following CLI commands. Use the `--enable-ultra-ssd` parameter to set the `EnableUltraSSD` feature.
3030

3131
```azurecli-interactive
32-
az aks create -g MyResourceGroup -n myAKSCluster -l westus2 --node-vm-size Standard_D2s_v3 --zones 1 2 --node-count 2 --enable-ultra-ssd
32+
az aks create --resource-group MyResourceGroup --name myAKSCluster --location westus2 --node-vm-size Standard_D2s_v3 --zones 1 2 --node-count 2 --enable-ultra-ssd
3333
```
3434

3535
If you want to create a cluster without ultra disk support, you can do so by omitting the `--enable-ultra-ssd` parameter.

articles/azure-monitor/containers/kubernetes-monitoring-enable.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,16 @@ Use the `-enable-azure-monitor-metrics` option `az aks create` or `az aks update
101101

102102
```azurecli
103103
### Use default Azure Monitor workspace
104-
az aks create/update --enable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group>
104+
az aks create/update --enable-azure-monitor-metrics --name <cluster-name> --resource-group <cluster-resource-group>
105105
106106
### Use existing Azure Monitor workspace
107-
az aks create/update --enable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group> --azure-monitor-workspace-resource-id <workspace-name-resource-id>
107+
az aks create/update --enable-azure-monitor-metrics --name <cluster-name> --resource-group <cluster-resource-group> --azure-monitor-workspace-resource-id <workspace-name-resource-id>
108108
109109
### Use an existing Azure Monitor workspace and link with an existing Grafana workspace
110-
az aks create/update --enable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group> --azure-monitor-workspace-resource-id <azure-monitor-workspace-name-resource-id> --grafana-resource-id <grafana-workspace-name-resource-id>
110+
az aks create/update --enable-azure-monitor-metrics --name <cluster-name> --resource-group <cluster-resource-group> --azure-monitor-workspace-resource-id <azure-monitor-workspace-name-resource-id> --grafana-resource-id <grafana-workspace-name-resource-id>
111111
112112
### Use optional parameters
113-
az aks create/update --enable-azure-monitor-metrics -n <cluster-name> -g <cluster-resource-group> --ksm-metric-labels-allow-list "namespaces=[k8s-label-1,k8s-label-n]" --ksm-metric-annotations-allow-list "pods=[k8s-annotation-1,k8s-annotation-n]"
113+
az aks create/update --enable-azure-monitor-metrics --name <cluster-name> --resource-group <cluster-resource-group> --ksm-metric-labels-allow-list "namespaces=[k8s-label-1,k8s-label-n]" --ksm-metric-annotations-allow-list "pods=[k8s-annotation-1,k8s-annotation-n]"
114114
```
115115

116116
#### Arc-enabled cluster
@@ -360,16 +360,16 @@ Use one of the following commands to enable monitoring of your AKS and Arc-enabl
360360

361361
```azurecli
362362
### Use default Log Analytics workspace
363-
az aks enable-addons -a monitoring -n <cluster-name> -g <cluster-resource-group-name>
363+
az aks enable-addons --addon monitoring --name <cluster-name> --resource-group <cluster-resource-group-name>
364364
365365
### Use existing Log Analytics workspace
366-
az aks enable-addons -a monitoring -n <cluster-name> -g <cluster-resource-group-name> --workspace-resource-id <workspace-resource-id>
366+
az aks enable-addons --addon monitoring --name <cluster-name> --resource-group <cluster-resource-group-name> --workspace-resource-id <workspace-resource-id>
367367
```
368368

369369
**Example**
370370

371371
```azurecli
372-
az aks enable-addons -a monitoring -n "my-cluster" -g "my-resource-group" --workspace-resource-id "/subscriptions/my-subscription/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/workspaces/my-workspace"
372+
az aks enable-addons --addon monitoring --name "my-cluster" --resource-group "my-resource-group" --workspace-resource-id "/subscriptions/my-subscription/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/workspaces/my-workspace"
373373
```
374374

375375

@@ -756,7 +756,7 @@ ama-logs-rs 1/1 1 1 24d
756756
Use the `aks show` command to find out whether the solution is enabled, the Log Analytics workspace resource ID, and summary information about the cluster.
757757

758758
```azurecli
759-
az aks show -g <resourceGroupofAKSCluster> -n <nameofAksCluster>
759+
az aks show --resource-group <resourceGroupofAKSCluster> --name <nameofAksCluster>
760760
```
761761

762762
The command will return JSON-formatted information about the solution. The `addonProfiles` section should include information on the `omsagent` as in the following example:

articles/backup/azure-kubernetes-service-cluster-manage-backups.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To install Backup Extension, you need to register `Microsoft.KubernetesConfigura
3333
The registration may take up to *10 minutes*. To monitor the registration process, run the following command:
3434

3535
```azurecli-interactive
36-
az provider show -n Microsoft.KubernetesConfiguration -o table
36+
az provider show --name Microsoft.KubernetesConfiguration --output table
3737
```
3838

3939
### Register the Trusted Access
@@ -130,10 +130,10 @@ To enable Trusted Access between Backup vault and AKS cluster, use the following
130130

131131
```azurecli-interactive
132132
az aks trustedaccess rolebinding create \
133-
-g <aksclusterrg> \
133+
--resource-group <aksclusterrg> \
134134
--cluster-name <aksclustername> \
135-
-n <randomRoleBindingName> \
136-
--source-resource-id $(az dataprotection backup-vault show -g <vaultrg> --vault <VaultName> --query id -o tsv) \
135+
--name <randomRoleBindingName> \
136+
--source-resource-id $(az dataprotection backup-vault show --resource-group <vaultrg> --vault <VaultName> --query id -o tsv) \
137137
--roles Microsoft.DataProtection/backupVaults/backup-operator
138138
```
139139

0 commit comments

Comments
 (0)