Skip to content

Commit 74bb1f7

Browse files
Merge pull request #275317 from schaffererin/updateparams5
Updated command parameters with long-form formatting
2 parents caf2d33 + 4bb55b7 commit 74bb1f7

9 files changed

+65
-65
lines changed

articles/aks/api-server-vnet-integration.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ You can configure your AKS clusters with API Server VNet Integration in managed
7575
* Create a resource group using the [`az group create`][az-group-create] command.
7676
7777
```azurecli-interactive
78-
az group create -l westus2 -n <resource-group>
78+
az group create --location westus2 --name <resource-group>
7979
```
8080
8181
### Deploy a public cluster
8282
8383
* Deploy a public AKS cluster with API Server VNet integration for managed VNet using the [`az aks create`][az-aks-create] command with the `--enable-api-server-vnet-integration` flag.
8484
8585
```azurecli-interactive
86-
az aks create -n <cluster-name> \
87-
-g <resource-group> \
88-
-l <location> \
86+
az aks create --name <cluster-name> \
87+
--resource-group <resource-group> \
88+
--location <location> \
8989
--network-plugin azure \
9090
--enable-apiserver-vnet-integration
9191
```
@@ -95,9 +95,9 @@ You can configure your AKS clusters with API Server VNet Integration in managed
9595
* Deploy a private AKS cluster with API Server VNet integration for managed VNet using the [`az aks create`][az-aks-create] command with the `--enable-api-server-vnet-integration` and `--enable-private-cluster` flags.
9696
9797
```azurecli-interactive
98-
az aks create -n <cluster-name> \
99-
-g <resource-group> \
100-
-l <location> \
98+
az aks create --name <cluster-name> \
99+
--resource-group <resource-group> \
100+
--location <location> \
101101
--network-plugin azure \
102102
--enable-private-cluster \
103103
--enable-apiserver-vnet-integration
@@ -117,24 +117,24 @@ The cluster identity needs permissions to both the API server subnet and the nod
117117
* Create a resource group using the [`az group create`][az-group-create] command.
118118
119119
```azurecli-interactive
120-
az group create -l <location> -n <resource-group>
120+
az group create --location <location> --name <resource-group>
121121
```
122122

123123
### Create a virtual network
124124

125125
1. Create a virtual network using the [`az network vnet create`][az-network-vnet-create] command.
126126

127127
```azurecli-interactive
128-
az network vnet create -n <vnet-name> \
129-
-g <resource-group> \
130-
-l <location> \
128+
az network vnet create --name <vnet-name> \
129+
--resource-group <resource-group> \
130+
--location <location> \
131131
--address-prefixes 172.19.0.0/16
132132
```
133133
134134
2. Create an API server subnet using the [`az network vnet subnet create`][az-network-vnet-subnet-create] command.
135135
136136
```azurecli-interactive
137-
az network vnet subnet create -g <resource-group> \
137+
az network vnet subnet create --resource-group <resource-group> \
138138
--vnet-name <vnet-name> \
139139
--name <apiserver-subnet-name> \
140140
--delegations Microsoft.ContainerService/managedClusters \
@@ -144,7 +144,7 @@ az group create -l <location> -n <resource-group>
144144
3. Create a cluster subnet using the [`az network vnet subnet create`][az-network-vnet-subnet-create] command.
145145
146146
```azurecli-interactive
147-
az network vnet subnet create -g <resource-group> \
147+
az network vnet subnet create --resource-group <resource-group> \
148148
--vnet-name <vnet-name> \
149149
--name <cluster-subnet-name> \
150150
--address-prefixes 172.19.1.0/24
@@ -155,7 +155,7 @@ az group create -l <location> -n <resource-group>
155155
1. Create a managed identity using the [`az identity create`][az-identity-create] command.
156156
157157
```azurecli-interactive
158-
az identity create -g <resource-group> -n <managed-identity-name> -l <location>
158+
az identity create --resource-group <resource-group> --name <managed-identity-name> --location <location>
159159
```
160160
161161
2. Assign the Network Contributor role to the API server subnet using the [`az role assignment create`][az-role-assignment-create] command.
@@ -179,9 +179,9 @@ az group create -l <location> -n <resource-group>
179179
* Deploy a public AKS cluster with API Server VNet integration using the [`az aks create`][az-aks-create] command with the `--enable-api-server-vnet-integration` flag.
180180
181181
```azurecli-interactive
182-
az aks create -n <cluster-name> \
183-
-g <resource-group> \
184-
-l <location> \
182+
az aks create --name <cluster-name> \
183+
--resource-group <resource-group> \
184+
--location <location> \
185185
--network-plugin azure \
186186
--enable-apiserver-vnet-integration \
187187
--vnet-subnet-id <cluster-subnet-resource-id> \
@@ -194,9 +194,9 @@ az group create -l <location> -n <resource-group>
194194
* Deploy a private AKS cluster with API Server VNet integration using the [`az aks create`][az-aks-create] command with the `--enable-api-server-vnet-integration` and `--enable-private-cluster` flags.
195195
196196
```azurecli-interactive
197-
az aks create -n <cluster-name> \
198-
-g <resource-group> \
199-
-l <location> \
197+
az aks create --name <cluster-name> \
198+
--resource-group <resource-group> \
199+
--location <location> \
200200
--network-plugin azure \
201201
--enable-private-cluster \
202202
--enable-apiserver-vnet-integration \
@@ -217,8 +217,8 @@ This upgrade performs a node-image version upgrade on all node pools and restart
217217
* Update your cluster to API Server VNet Integration using the [`az aks update`][az-aks-update] command with the `--enable-apiserver-vnet-integration` flag.
218218
219219
```azurecli-interactive
220-
az aks update -n <cluster-name> \
221-
-g <resource-group> \
220+
az aks update --name <cluster-name> \
221+
--resource-group <resource-group> \
222222
--enable-apiserver-vnet-integration \
223223
--apiserver-subnet-id <apiserver-subnet-resource-id>
224224
```
@@ -235,8 +235,8 @@ AKS clusters configured with API Server VNet Integration can have public network
235235
* Enable private cluster mode using the [`az aks update`][az-aks-update] command with the `--enable-private-cluster` flag.
236236
237237
```azurecli-interactive
238-
az aks update -n <cluster-name> \
239-
-g <resource-group> \
238+
az aks update --name <cluster-name> \
239+
--resource-group <resource-group> \
240240
--enable-private-cluster
241241
```
242242
@@ -245,8 +245,8 @@ AKS clusters configured with API Server VNet Integration can have public network
245245
* Disable private cluster mode using the [`az aks update`][az-aks-update] command with the `--disable-private-cluster` flag.
246246
247247
```azurecli-interactive
248-
az aks update -n <cluster-name> \
249-
-g <resource-group> \
248+
az aks update --name <cluster-name> \
249+
--resource-group <resource-group> \
250250
--disable-private-cluster
251251
```
252252
@@ -255,7 +255,7 @@ AKS clusters configured with API Server VNet Integration can have public network
255255
* Configure `kubectl` to connect to your cluster using the [`az aks get-credentials`][az-aks-get-credentials] command.
256256
257257
```azurecli-interactive
258-
az aks get-credentials -g <resource-group> -n <cluster-name>
258+
az aks get-credentials --resource-group <resource-group> --name <cluster-name>
259259
```
260260
261261
## Next steps

articles/aks/app-routing-dns-ssl.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To connect to the Kubernetes cluster from your local computer, you use `kubectl`
3535
Configure kubectl to connect to your Kubernetes cluster using the [`az aks get-credentials`][az-aks-get-credentials] command.
3636

3737
```azurecli-interactive
38-
az aks get-credentials -g <ResourceGroupName> -n <ClusterName>
38+
az aks get-credentials --resource-group <ResourceGroupName> --name <ClusterName>
3939
```
4040

4141
## Terminate HTTPS traffic with certificates from Azure Key Vault
@@ -52,7 +52,7 @@ To enable support for HTTPS traffic, see the following prerequisites:
5252
Create an Azure Key Vault using the [`az keyvault create`][az-keyvault-create] command.
5353

5454
```azurecli-interactive
55-
az keyvault create -g <ResourceGroupName> -l <Location> -n <KeyVaultName> --enable-rbac-authorization true
55+
az keyvault create --resource-group <ResourceGroupName> --location <Location> --name <KeyVaultName> --enable-rbac-authorization true
5656
```
5757

5858
### Create and export a self-signed SSL certificate
@@ -79,7 +79,7 @@ For testing, you can use a self-signed public certificate instead of a Certifica
7979
Import the SSL certificate into Azure Key Vault using the [`az keyvault certificate import`][az-keyvault-certificate-import] command. If your certificate is password protected, you can pass the password through the `--password` flag.
8080

8181
```azurecli-interactive
82-
az keyvault certificate import --vault-name <KeyVaultName> -n <KeyVaultCertificateName> -f aks-ingress-tls.pfx [--password <certificate password if specified>]
82+
az keyvault certificate import --vault-name <KeyVaultName> --name <KeyVaultCertificateName> --file aks-ingress-tls.pfx [--password <certificate password if specified>]
8383
```
8484
8585
> [!IMPORTANT]
@@ -103,7 +103,7 @@ KEYVAULTID=$(az keyvault show --name <KeyVaultName> --query "id" --output tsv)
103103
Then update the app routing add-on to enable the Azure Key Vault secret store CSI driver and apply the role assignment.
104104
105105
```azurecli-interactive
106-
az aks approuting update -g <ResourceGroupName> -n <ClusterName> --enable-kv --attach-kv ${KEYVAULTID}
106+
az aks approuting update --resource-group <ResourceGroupName> --name <ClusterName> --enable-kv --attach-kv ${KEYVAULTID}
107107
```
108108
109109
## Enable Azure DNS integration
@@ -121,7 +121,7 @@ To enable support for DNS zones, review the following prerequisite:
121121
1. Create an Azure DNS zone using the [`az network dns zone create`][az-network-dns-zone-create] command.
122122
123123
```azurecli-interactive
124-
az network dns zone create -g <ResourceGroupName> -n <ZoneName>
124+
az network dns zone create --resource-group <ResourceGroupName> --name <ZoneName>
125125
```
126126
127127
### Attach Azure DNS zone to the application routing add-on
@@ -132,13 +132,13 @@ To enable support for DNS zones, review the following prerequisite:
132132
1. Retrieve the resource ID for the DNS zone using the [`az network dns zone show`][az-network-dns-zone-show] command and set the output to a variable named *ZONEID*.
133133
134134
```azurecli-interactive
135-
ZONEID=$(az network dns zone show -g <ResourceGroupName> -n <ZoneName> --query "id" --output tsv)
135+
ZONEID=$(az network dns zone show --resource-group <ResourceGroupName> --name <ZoneName> --query "id" --output tsv)
136136
```
137137
138138
1. Update the add-on to enable the integration with Azure DNS using the [`az aks approuting zone`][az-aks-approuting-zone] command. You can pass a comma-separated list of DNS zone resource IDs.
139139
140140
```azurecli-interactive
141-
az aks approuting zone add -g <ResourceGroupName> -n <ClusterName> --ids=${ZONEID} --attach-zones
141+
az aks approuting zone add --resource-group <ResourceGroupName> --name <ClusterName> --ids=${ZONEID} --attach-zones
142142
```
143143
144144
## Create the Ingress that uses a host name and a certificate from Azure Key Vault
@@ -148,7 +148,7 @@ The application routing add-on creates an Ingress class on the cluster named *we
148148
1. Get the certificate URI to use in the Ingress from Azure Key Vault using the [`az keyvault certificate show`][az-keyvault-certificate-show] command.
149149
150150
```azurecli-interactive
151-
az keyvault certificate show --vault-name <KeyVaultName> -n <KeyVaultCertificateName> --query "id" --output tsv
151+
az keyvault certificate show --vault-name <KeyVaultName> --name <KeyVaultCertificateName> --query "id" --output tsv
152152
```
153153
154154
The following example output shows the certificate URI returned from the command:

articles/aks/app-routing-migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In this article, you learn how to migrate your Azure Kubernetes Service (AKS) cl
2525
1. Enable the application routing add-on.
2626

2727
```azurecli-interactive
28-
az aks approuting enable -g <ResourceGroupName> -n <ClusterName>
28+
az aks approuting enable --resource-group <ResourceGroupName> --name <ClusterName>
2929
```
3030
3131
2. Update your Ingresses, setting `ingressClassName` to `webapprouting.kubernetes.azure.com`. Remove the `kubernetes.io/ingress.class` annotation. You also need to update the host to one that you own, as the application routing add-on doesn't have a managed cluster DNS zone. If you don't have a DNS zone, follow instructions to [create][app-routing-dns-create] and [configure][app-routing-dns-configure] one.
@@ -84,7 +84,7 @@ In this article, you learn how to migrate your Azure Kubernetes Service (AKS) cl
8484
4. Disable the HTTP application routing add-on.
8585
8686
```azurecli-interactive
87-
az aks disable-addons -g <ResourceGroupName> -n <ClusterName> --addons http_application_routing
87+
az aks disable-addons --resource-group <ResourceGroupName> --name <ClusterName> --addons http_application_routing
8888
```
8989
9090
## Remove and delete all HTTP application routing resources

articles/aks/app-routing-nginx-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To connect to the Kubernetes cluster from your local computer, you use `kubectl`
2525
Configure kubectl to connect to your Kubernetes cluster using the [`az aks get-credentials`][az-aks-get-credentials] command.
2626

2727
```azurecli-interactive
28-
az aks get-credentials -g <ResourceGroupName> -n <ClusterName>
28+
az aks get-credentials -resource-group <ResourceGroupName> --name <ClusterName>
2929
```
3030

3131
## Configuration of the NGINX ingress controller

articles/aks/app-routing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ With the retirement of [Open Service Mesh][open-service-mesh-docs] (OSM) by the
5454
To enable application routing on a new cluster, use the [`az aks create`][az-aks-create] command, specifying the `--enable-app-routing` flag.
5555

5656
```azurecli-interactive
57-
az aks create -g <ResourceGroupName> -n <ClusterName> -l <Location> --enable-app-routing
57+
az aks create --resource-group <ResourceGroupName> --name <ClusterName> --location <Location> --enable-app-routing
5858
```
5959

6060
### Enable on an existing cluster
6161

6262
To enable application routing on an existing cluster, use the [`az aks approuting enable`][az-aks-approuting-enable] command.
6363

6464
```azurecli-interactive
65-
az aks approuting enable -g <ResourceGroupName> -n <ClusterName>
65+
az aks approuting enable --resource-group <ResourceGroupName> --name <ClusterName>
6666
```
6767

6868
# [Open Service Mesh (OSM) (retired)](#tab/with-osm)
@@ -79,16 +79,16 @@ The following add-ons are required to support this configuration:
7979
Enable application routing on a new AKS cluster using the [`az aks create`][az-aks-create] command specifying the `--enable-app-routing` flag and the `--enable-addons` parameter with the `open-service-mesh` add-on:
8080

8181
```azurecli-interactive
82-
az aks create -g <ResourceGroupName> -n <ClusterName> -l <Location> --enable-app-routing --enable-addons open-service-mesh
82+
az aks create --resource-group <ResourceGroupName> --name <ClusterName> --location <Location> --enable-app-routing --enable-addons open-service-mesh
8383
```
8484

8585
### Enable on an existing cluster
8686

8787
To enable application routing on an existing cluster, use the [`az aks approuting enable`][az-aks-approuting-enable] command and the [`az aks enable-addons`][az-aks-enable-addons] command with the `--addons` parameter set to `open-service-mesh`:
8888

8989
```azurecli-interactive
90-
az aks approuting enable -g <ResourceGroupName> -n <ClusterName>
91-
az aks enable-addons -g <ResourceGroupName> -n <ClusterName> --addons open-service-mesh
90+
az aks approuting enable --resource-group <ResourceGroupName> --name <ClusterName>
91+
az aks enable-addons --resource-group <ResourceGroupName> --name <ClusterName> --addons open-service-mesh
9292
```
9393

9494
> [!NOTE]
@@ -104,15 +104,15 @@ az aks enable-addons -g <ResourceGroupName> -n <ClusterName> --addons open-servi
104104
To enable application routing on a new cluster, use the [`az aks create`][az-aks-create] command, specifying `--enable-app-routing` flag.
105105

106106
```azurecli-interactive
107-
az aks create -g <ResourceGroupName> -n <ClusterName> -l <Location> --enable-app-routing
107+
az aks create --resource-group <ResourceGroupName> --name <ClusterName> --location <Location> --enable-app-routing
108108
```
109109

110110
### Enable on an existing cluster
111111

112112
To enable application routing on an existing cluster, use the [`az aks approuting enable`][az-aks-approuting-enable] command:
113113

114114
```azurecli-interactive
115-
az aks approuting enable -g <ResourceGroupName> -n <ClusterName>
115+
az aks approuting enable --resource-group <ResourceGroupName> --name <ClusterName>
116116
```
117117

118118
---
@@ -124,7 +124,7 @@ To connect to the Kubernetes cluster from your local computer, you use [kubectl]
124124
Configure `kubectl` to connect to your Kubernetes cluster using the [az aks get-credentials][az-aks-get-credentials] command.
125125

126126
```azurecli-interactive
127-
az aks get-credentials -g <ResourceGroupName> -n <ClusterName>
127+
az aks get-credentials --resource-group <ResourceGroupName> -name <ClusterName>
128128
```
129129

130130
## Deploy an application

articles/aks/configure-kube-proxy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ You can view the full `kube-proxy` configuration structure in the [AKS Cluster S
110110
111111
```azurecli-interactive
112112
# Create a new cluster
113-
az aks create -g <resourceGroup> -n <clusterName> --kube-proxy-config kube-proxy.json
113+
az aks create --resource-group <resourceGroup> --name <clusterName> --kube-proxy-config kube-proxy.json
114114
115115
# Update an existing cluster
116-
az aks update -g <resourceGroup> -n <clusterName> --kube-proxy-config kube-proxy.json
116+
az aks update --resource-group <resourceGroup> --name <clusterName> --kube-proxy-config kube-proxy.json
117117
```
118118
119119
## Next steps

articles/aks/create-nginx-ingress-private-controller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ az network vnet create \
5252
You create a DNS zone using the [az network private-dns zone create][az-network-private-dns-zone-create] command, specifying the name of the zone and the resource group to create it in. The following example creates a DNS zone named *private.contoso.com* in the *myResourceGroup* resource group.
5353

5454
```azurecli-interactive
55-
az network private-dns zone create --resource-group myResourceGoup -n private.contoso.com
55+
az network private-dns zone create --resource-group myResourceGoup --name private.contoso.com
5656
```
5757

5858
You create a virtual network link to the DNS zone created earlier using the [az network private-dns link vnet create][az-network-private-dns-link-vnet-create] command. The following example creates a link named *myDNSLink* to the zone *private.contoso.com* for the virtual network *myAzureVNet*. Include the `--registration-enabled` parameter to specify the link is not registration enabled.

articles/aks/csi-storage-drivers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To enable CSI storage drivers on a new cluster, include one of the following par
5050
* `--enable-snapshot-controller` allows you to enable the [snapshot controller][snapshot-controller].
5151

5252
```azurecli
53-
az aks update -n myAKSCluster -g myResourceGroup --enable-disk-driver --enable-file-driver --enable-blob-driver --enable-snapshot-controller
53+
az aks update --name myAKSCluster --resource-group myResourceGroup --enable-disk-driver --enable-file-driver --enable-blob-driver --enable-snapshot-controller
5454
```
5555

5656
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 when enabling the Blob storage CSI driver:
@@ -72,13 +72,13 @@ To disable CSI storage drivers on a new cluster, include one of the following pa
7272
* `--disable-snapshot-controller` allows you to disable the [snapshot controller][snapshot-controller].
7373

7474
```azurecli
75-
az aks create -n myAKSCluster -g myResourceGroup --disable-disk-driver --disable-file-driver --disable-blob-driver --disable-snapshot-controller
75+
az aks create --name myAKSCluster --resource-group myResourceGroup --disable-disk-driver --disable-file-driver --disable-blob-driver --disable-snapshot-controller
7676
```
7777

7878
To disable CSI storage drivers on an existing cluster, use one of the parameters listed earlier depending on the storage system:
7979

8080
```azurecli
81-
az aks update -n myAKSCluster -g myResourceGroup --disable-disk-driver --disable-file-driver --disable-blob-driver --disable-snapshot-controller
81+
az aks update --name myAKSCluster --resource-group myResourceGroup --disable-disk-driver --disable-file-driver --disable-blob-driver --disable-snapshot-controller
8282
```
8383

8484
## Migrate custom in-tree storage classes to CSI

0 commit comments

Comments
 (0)