Skip to content

Commit c998028

Browse files
Merge pull request #275299 from schaffererin/updateparams1
Updated command parameters with long-form formatting
2 parents 8d2dad0 + bc4f29e commit c998028

10 files changed

+42
-42
lines changed

articles/aks/artifact-streaming.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Enablement on ACR is a prerequisite for Artifact Streaming on AKS. For more info
7676
4. Push or import an image to the registry using the [`az acr import`][az-acr-import] command.
7777
7878
```azurecli-interactive
79-
az acr import --source docker.io/jupyter/all-spark-notebook:latest -t jupyter/all-spark-notebook:latest
79+
az acr import --source docker.io/jupyter/all-spark-notebook:latest --repository jupyter/all-spark-notebook:latest
8080
```
8181
8282
5. Create a streaming artifact from the image using the [`az acr artifact-streaming create`][az-acr-artifact-streaming-create] command.
@@ -88,7 +88,7 @@ Enablement on ACR is a prerequisite for Artifact Streaming on AKS. For more info
8888
6. Verify the generated Artifact Streaming using the [`az acr manifest list-referrers`][az-acr-manifest-list-referrers] command.
8989
9090
```azurecli-interactive
91-
az acr manifest list-referrers -n jupyter/all-spark-notebook:latest
91+
az acr manifest list-referrers --name jupyter/all-spark-notebook:latest
9292
```
9393
9494
## Enable Artifact Streaming on AKS

articles/aks/cluster-container-registry-integration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
3737
```azurecli-interactive
3838
MYACR=mycontainerregistry
3939
40-
az acr create -n $MYACR -g myContainerRegistryResourceGroup --sku basic
40+
az acr create --name $MYACR --resource-group myContainerRegistryResourceGroup --sku basic
4141
```
4242
4343
#### [Azure PowerShell](#tab/azure-powershell)
@@ -61,7 +61,7 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
6161
```azurecli-interactive
6262
MYACR=mycontainerregistry
6363
64-
az aks create -n myAKSCluster -g myResourceGroup --generate-ssh-keys --attach-acr $MYACR
64+
az aks create --name myAKSCluster --resource-group myResourceGroup --generate-ssh-keys --attach-acr $MYACR
6565
```
6666
6767
This command may take several minutes to complete.
@@ -97,10 +97,10 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
9797
9898
```azurecli-interactive
9999
# Attach using acr-name
100-
az aks update -n myAKSCluster -g myResourceGroup --attach-acr <acr-name>
100+
az aks update --name myAKSCluster --resource-group myResourceGroup --attach-acr <acr-name>
101101
102102
# Attach using acr-resource-id
103-
az aks update -n myAKSCluster -g myResourceGroup --attach-acr <acr-resource-id>
103+
az aks update --name myAKSCluster --resource-group myResourceGroup --attach-acr <acr-resource-id>
104104
```
105105
106106
> [!NOTE]
@@ -127,10 +127,10 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
127127
128128
```azurecli-interactive
129129
# Detach using acr-name
130-
az aks update -n myAKSCluster -g myResourceGroup --detach-acr <acr-name>
130+
az aks update --name myAKSCluster --resource-group myResourceGroup --detach-acr <acr-name>
131131
132132
# Detach using acr-resource-id
133-
az aks update -n myAKSCluster -g myResourceGroup --detach-acr <acr-resource-id>
133+
az aks update --name myAKSCluster --resource-group myResourceGroup --detach-acr <acr-resource-id>
134134
```
135135
136136
#### [Azure PowerShell](#tab/azure-powershell)
@@ -152,7 +152,7 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
152152
* Import an image from Docker Hub into your ACR using the [`az acr import`][az-acr-import] command.
153153
154154
```azurecli-interactive
155-
az acr import -n <acr-name> --source docker.io/library/nginx:latest --image nginx:v1
155+
az acr import --name <acr-name> --source docker.io/library/nginx:latest --image nginx:v1
156156
```
157157
158158
#### [Azure PowerShell](#tab/azure-powershell)
@@ -172,7 +172,7 @@ The AKS to ACR integration assigns the [**AcrPull** role][acr-pull] to the [Micr
172172
1. Ensure you have the proper AKS credentials using the [`az aks get-credentials`][az-aks-get-credentials] command.
173173
174174
```azurecli-interactive
175-
az aks get-credentials -g myResourceGroup -n myAKSCluster
175+
az aks get-credentials --resource-group myResourceGroup --name myAKSCluster
176176
```
177177
178178
2. Create a file called **acr-nginx.yaml** using the following sample YAML and replace **acr-name** with the name of your ACR.

articles/aks/edge-zones.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,10 +254,10 @@ az login
254254
az account set --subscription $SUBSCRIPTION
255255
256256
# Create the resource group
257-
az group create -n $RG_NAME -l $LOCATION
257+
az group create --name $RG_NAME --location $LOCATION
258258
259259
# Deploy the cluster in your designated Edge Zone
260-
az aks create -g $RG_NAME -n $CLUSTER_NAME --edge-zone $EDGE_ZONE_NAME --location $LOCATION
260+
az aks create --resource-group $RG_NAME --name $CLUSTER_NAME --edge-zone $EDGE_ZONE_NAME --location $LOCATION
261261
```
262262

263263
### [Azure portal](#tab/azure-portal)

articles/aks/learn/tutorial-kubernetes-workload-identity.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,15 @@ To help simplify steps to configure the identities required, the steps below def
7979
1. Create an AKS cluster using the [az aks create][az-aks-create] command with the `--enable-oidc-issuer` parameter to use the OIDC Issuer.
8080
8181
```azurecli-interactive
82-
az aks create -g "${RESOURCE_GROUP}" -n myAKSCluster --node-count 1 --enable-oidc-issuer --enable-workload-identity --generate-ssh-keys
82+
az aks create --resource-group "${RESOURCE_GROUP}" --name myAKSCluster --node-count 1 --enable-oidc-issuer --enable-workload-identity --generate-ssh-keys
8383
```
8484
8585
After a few minutes, the command completes and returns JSON-formatted information about the cluster.
8686
8787
2. Get the OIDC Issuer URL and save it to an environmental variable using the following command. Replace the default value for the arguments `-n`, which is the name of the cluster.
8888
8989
```azurecli-interactive
90-
export AKS_OIDC_ISSUER="$(az aks show -n myAKSCluster -g "${RESOURCE_GROUP}" --query "oidcIssuerProfile.issuerUrl" -otsv)"
90+
export AKS_OIDC_ISSUER="$(az aks show --name myAKSCluster --resource-group "${RESOURCE_GROUP}" --query "oidcIssuerProfile.issuerUrl" -o tsv)"
9191
```
9292
9393
The variable should contain the Issuer URL similar to the following example:
@@ -122,7 +122,7 @@ To help simplify steps to configure the identities required, the steps below def
122122
3. Add the Key Vault URL to the environment variable `KEYVAULT_URL` using the [az keyvault show][az-keyvault-show] command.
123123
124124
```bash
125-
export KEYVAULT_URL="$(az keyvault show -g "${RESOURCE_GROUP}" -n ${KEYVAULT_NAME} --query properties.vaultUri -o tsv)"
125+
export KEYVAULT_URL="$(az keyvault show --resource-group "${RESOURCE_GROUP}" --name ${KEYVAULT_NAME} --query properties.vaultUri -o tsv)"
126126
```
127127
128128
## Create a managed identity and grant permissions to access the secret
@@ -154,7 +154,7 @@ To help simplify steps to configure the identities required, the steps below def
154154
1. Create a Kubernetes service account and annotate it with the client ID of the managed identity created in the previous step using the [az aks get-credentials][az-aks-get-credentials] command. Replace the default value for the cluster name and the resource group name.
155155
156156
```azurecli-interactive
157-
az aks get-credentials -n myAKSCluster -g "${RESOURCE_GROUP}"
157+
az aks get-credentials --name myAKSCluster --resource-group "${RESOURCE_GROUP}"
158158
```
159159
160160
2. Copy the following multi-line input into your terminal and run the command to create the service account.

articles/aks/manage-node-pools.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ In this example, we upgrade the *mynodepool* node pool. Since there are two node
5858
3. List the status of your node pools using the [`az aks nodepool list`][az-aks-nodepool-list] command.
5959
6060
```azurecli-interactive
61-
az aks nodepool list -g myResourceGroup --cluster-name myAKSCluster
61+
az aks nodepool list --resource-group myResourceGroup --cluster-name myAKSCluster
6262
```
6363
6464
The following example output shows *mynodepool* is in the *Upgrading* state:
@@ -144,7 +144,7 @@ As your application workload demands change, you may need to scale the number of
144144
2. List the status of your node pools using the [`az aks node pool list`][az-aks-nodepool-list] command.
145145
146146
```azurecli-interactive
147-
az aks nodepool list -g myResourceGroup --cluster-name myAKSCluster
147+
az aks nodepool list --resource-group myResourceGroup --cluster-name myAKSCluster
148148
```
149149
150150
The following example output shows *mynodepool* is in the *Scaling* state with a new count of five nodes:
@@ -326,7 +326,7 @@ In the following example, we create a GPU-based node pool that uses the *Standar
326326
2. Check the status of the node pool using the [`az aks nodepool list`][az-aks-nodepool-list] command.
327327
328328
```azurecli-interactive
329-
az aks nodepool list -g myResourceGroup --cluster-name myAKSCluster
329+
az aks nodepool list --resource-group myResourceGroup --cluster-name myAKSCluster
330330
```
331331
332332
The following example output shows the *gpunodepool* node pool is *Creating* nodes with the specified *VmSize*:

articles/aks/manage-ssh-node-access.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Use the [`az aks create`][az-aks-create] command to create a new cluster, and in
142142
> After you disable the SSH service, you can't SSH into the cluster to perform administrative tasks or to troubleshoot.
143143
144144
```azurecli-interactive
145-
az aks create -g myResourceGroup -n myManagedCluster --ssh-access disabled
145+
az aks create --resource-group myResourceGroup --name myManagedCluster --ssh-access disabled
146146
```
147147

148148
After a few minutes, the command completes and returns JSON-formatted information about the cluster. The following example resembles the output and the results related to disabling SSH:
@@ -158,7 +158,7 @@ After a few minutes, the command completes and returns JSON-formatted informatio
158158
Use the [`az aks update`][az-aks-update] command to update an existing cluster, and include the `--ssh-access disabled` argument to disable SSH (preview) on all the node pools in the cluster.
159159

160160
```azurecli-interactive
161-
az aks update -g myResourceGroup -n myManagedCluster --ssh-access disabled
161+
az aks update --resource-group myResourceGroup --name myManagedCluster --ssh-access disabled
162162
```
163163

164164
After a few minutes, the command completes and returns JSON-formatted information about the cluster. The following example resembles the output and the results related to disabling SSH:
@@ -221,7 +221,7 @@ az aks nodepool upgrade --cluster-name myManagedCluster --name mynodepool --reso
221221
Use the [`az aks update`][az-aks-update] command to update an existing cluster, and include the `--ssh-access localuser` argument to re-enable SSH (preview) on all the node pools in the cluster.
222222

223223
```azurecli-interactive
224-
az aks update -g myResourceGroup -n myManagedCluster --ssh-access localuser
224+
az aks update --resource-group myResourceGroup --name myManagedCluster --ssh-access localuser
225225
```
226226

227227
The following message is returned while the process is performed:

articles/aks/private-clusters.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ Private cluster is available in public regions, Azure Government, and Microsoft
4848
Create a resource group using the [`az group create`][az-group-create] command. You can also use an existing resource group for your AKS cluster.
4949

5050
```azurecli-interactive
51-
az group create -l eastus -n myResourceGroup
51+
az group create --location eastus --name myResourceGroup
5252
```
5353

5454
### Default basic networking
5555

5656
Create a private cluster with default basic networking using the [`az aks create`][az-aks-create] command with the `--enable-private-cluster` flag.
5757

5858
```azurecli-interactive
59-
az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster
59+
az aks create --name <private-cluster-name> --resource-group-name <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster
6060
```
6161

6262
### Advanced networking
@@ -86,15 +86,15 @@ If you want to configure custom domains that can only be resolved internally, se
8686
Disable a public FQDN when creating a private AKS cluster using the `--disable-public-fqdn` flag.
8787

8888
```azurecli-interactive
89-
az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <private-dns-zone-mode> --disable-public-fqdn
89+
az aks create --name <private-cluster-name> --resource-group <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <private-dns-zone-mode> --disable-public-fqdn
9090
```
9191

9292
### Disable a public FQDN on an existing cluster
9393

9494
Disable a public FQDN on an existing AKS cluster using the [`az aks update`][az-aks-update] command with the `--disable-public-fqdn` flag.
9595

9696
```azurecli-interactive
97-
az aks update -n <private-cluster-name> -g <private-cluster-resource-group> --disable-public-fqdn
97+
az aks update --name <private-cluster-name> --resource-group <private-cluster-resource-group> --disable-public-fqdn
9898
```
9999

100100
## Configure a private DNS zone
@@ -128,7 +128,7 @@ You can configure private DNS zones using the following parameters:
128128
Create a private AKS cluster with a private DNS zone using the [`az aks create`][az-aks-create] command with the following flags:
129129
130130
```azurecli-interactive
131-
az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone [system|none]
131+
az aks create --name <private-cluster-name> --resource-group <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone [system|none]
132132
```
133133
134134
### Create a private AKS cluster with a custom private DNS zone or private DNS subzone
@@ -138,7 +138,7 @@ Create a private AKS cluster with a custom private DNS zone or subzone using the
138138
```azurecli-interactive
139139
# The custom private DNS zone name should be in the following format: "<subzone>.privatelink.<region>.azmk8s.io"
140140
141-
az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <custom private dns zone or custom private dns subzone resourceID>
141+
az aks create --name <private-cluster-name> --resource-group <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <custom private dns zone or custom private dns subzone resourceID>
142142
```
143143

144144
### Create a private AKS cluster with a custom private DNS zone and custom subdomain
@@ -148,7 +148,7 @@ Create a private AKS cluster with a custom private DNS zone and subdomain using
148148
```azurecli-interactive
149149
# The custom private DNS zone name should be in one of the following formats: "privatelink.<region>.azmk8s.io" or "<subzone>.privatelink.<region>.azmk8s.io"
150150
151-
az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <custom private dns zone resourceID> --fqdn-subdomain <subdomain>
151+
az aks create --name <private-cluster-name> --resource-group <private-cluster-resource-group> --load-balancer-sku standard --enable-private-cluster --enable-managed-identity --assign-identity <resourceID> --private-dns-zone <custom private dns zone resourceID> --fqdn-subdomain <subdomain>
152152
```
153153

154154
### Update a private cluster from a private DNS zone to public
@@ -159,7 +159,7 @@ az aks create -n <private-cluster-name> -g <private-cluster-resource-group> --lo
159159
Update a private cluster from `byo` or `system` to `none` using the [`az aks update`][az-aks-update] command with the following flags:
160160

161161
```azurecli-interactive
162-
az aks update -n <private-cluster-name> -g <private-cluster-resource-group> --private-dns-zone none
162+
az aks update --name <private-cluster-name> --resource-group <private-cluster-resource-group> --private-dns-zone none
163163
```
164164

165165
> [!NOTE]

articles/aks/quickstart-event-grid.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Create an AKS cluster using the [az aks create][az-aks-create] command. The foll
3131

3232
```azurecli-interactive
3333
az group create --name MyResourceGroup --location eastus
34-
az aks create -g MyResourceGroup -n MyAKS --location eastus --node-count 1 --generate-ssh-keys
34+
az aks create --resource-group yResourceGroup --name MyAKS --location eastus --node-count 1 --generate-ssh-keys
3535
```
3636

3737
### [Azure PowerShell](#tab/azure-powershell)
@@ -52,8 +52,8 @@ New-AzAksCluster -ResourceGroupName MyResourceGroup -Name MyAKS -Location eastus
5252
Create a namespace and event hub using [az eventhubs namespace create][az-eventhubs-namespace-create] and [az eventhubs eventhub create][az-eventhubs-eventhub-create]. The following example creates a namespace *MyNamespace* and an event hub *MyEventGridHub* in *MyNamespace*, both in the *MyResourceGroup* resource group.
5353

5454
```azurecli-interactive
55-
az eventhubs namespace create --location eastus --name MyNamespace -g MyResourceGroup
56-
az eventhubs eventhub create --name MyEventGridHub --namespace-name MyNamespace -g MyResourceGroup
55+
az eventhubs namespace create --location eastus --name MyNamespace --resource-group MyResourceGroup
56+
az eventhubs eventhub create --name MyEventGridHub --namespace-name MyNamespace --resource-group MyResourceGroup
5757
```
5858

5959
> [!NOTE]
@@ -62,8 +62,8 @@ az eventhubs eventhub create --name MyEventGridHub --namespace-name MyNamespace
6262
Subscribe to the AKS events using [az eventgrid event-subscription create][az-eventgrid-event-subscription-create]:
6363

6464
```azurecli-interactive
65-
SOURCE_RESOURCE_ID=$(az aks show -g MyResourceGroup -n MyAKS --query id --output tsv)
66-
ENDPOINT=$(az eventhubs eventhub show -g MyResourceGroup -n MyEventGridHub --namespace-name MyNamespace --query id --output tsv)
65+
SOURCE_RESOURCE_ID=$(az aks show --resource-group MyResourceGroup --name MyAKS --query id --output tsv)
66+
ENDPOINT=$(az eventhubs eventhub show --resource-group MyResourceGroup --name MyEventGridHub --namespace-name MyNamespace --query id --output tsv)
6767
az eventgrid event-subscription create --name MyEventGridSubscription \
6868
--source-resource-id $SOURCE_RESOURCE_ID \
6969
--endpoint-type eventhub \

articles/aks/tutorial-kubernetes-paas-services.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,13 @@ In previous tutorials, you used a RabbitMQ container to store orders submitted b
7171
1. Create an Azure Service Bus namespace using the [`az servicebus namespace create`][az-servicebus-namespace-create] command.
7272
7373
```azurecli-interactive
74-
az servicebus namespace create -n $SB_NS -g $RG_NAME -l $LOC_NAME
74+
az servicebus namespace create --name $SB_NS --resource-group $RG_NAME --location $LOC_NAME
7575
```
7676
7777
2. Create an Azure Service Bus queue using the [`az servicebus queue create`][az-servicebus-queue-create] command.
7878
7979
```azurecli-interactive
80-
az servicebus queue create -n orders -g $RG_NAME --namespace-name $SB_NS -g $RG_NAME
80+
az servicebus queue create --name orders --resource-group $RG_NAME --namespace-name $SB_NS
8181
```
8282
8383
3. Create an Azure Service Bus authorization rule using the [`az servicebus queue authorization-rule create`][az-servicebus-queue-authorization-rule-create] command.

0 commit comments

Comments
 (0)