Skip to content

Commit d6554dd

Browse files
docs(azure): add explanatory sentences before every az command block
Every code block in the 25 new service articles now has a prose sentence immediately before it describing what the command does. Previously, many blocks were preceded only by a section heading.
1 parent 06faf63 commit d6554dd

24 files changed

Lines changed: 254 additions & 0 deletions

src/content/docs/azure/services/action-group.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This reconfigures the `az` CLI to send commands to the official Azure management
3636

3737
### Create a resource group
3838

39+
Create a resource group to hold all resources created in this guide:
40+
3941
```bash
4042
az group create --name rg-monit-demo --location eastus
4143
```
@@ -52,6 +54,8 @@ az group create --name rg-monit-demo --location eastus
5254
5355
### Create an action group
5456
57+
Create an action group with an email receiver as the notification endpoint:
58+
5559
```bash
5660
az monitor action-group create \
5761
--name my-action-group \
@@ -80,6 +84,8 @@ az monitor action-group create \
8084
8185
### Show and list action groups
8286
87+
Retrieve the details of the action group, then list all action groups in the resource group:
88+
8389
```bash
8490
az monitor action-group show \
8591
--name my-action-group \
@@ -130,6 +136,8 @@ az monitor action-group list \
130136
131137
### Update an action group
132138
139+
Update the action group to add a second email receiver:
140+
133141
```bash
134142
az monitor action-group update \
135143
--name my-action-group \
@@ -154,6 +162,8 @@ az monitor action-group update \
154162
155163
### Delete and verify
156164
165+
Delete the resource and confirm it no longer appears in the list:
166+
157167
```bash
158168
az monitor action-group delete \
159169
--name my-action-group \

src/content/docs/azure/services/api-management.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This reconfigures the `az` CLI to send commands to the official Azure management
3636

3737
### Create a resource group
3838

39+
Create a resource group to hold all resources created in this guide:
40+
3941
```bash
4042
az group create --name rg-apim-demo --location eastus
4143
```
@@ -52,6 +54,8 @@ az group create --name rg-apim-demo --location eastus
5254
5355
### Create an API Management service instance
5456
57+
Create an API Management instance in the Consumption tier:
58+
5559
```bash
5660
az apim create \
5761
--name my-apim \
@@ -80,6 +84,8 @@ az apim create \
8084
8185
### Show and list services
8286
87+
Retrieve the details of the service instance and list all instances in the resource group:
88+
8389
```bash
8490
az apim show --name my-apim --resource-group rg-apim-demo
8591
```
@@ -118,6 +124,8 @@ az apim list --resource-group rg-apim-demo
118124
119125
### Check service name availability
120126
127+
Check whether the service name is globally available before creating:
128+
121129
```bash
122130
az apim check-name --name my-apim
123131
```
@@ -149,6 +157,8 @@ az rest --method PUT \
149157
150158
### Create an API gateway
151159
160+
Create an API gateway resource within the service instance using the REST API:
161+
152162
```bash
153163
az rest --method PUT \
154164
--url "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/rg-apim-demo/providers/Microsoft.ApiManagement/gateways/my-gateway?api-version=2022-08-01" \
@@ -162,6 +172,8 @@ az rest --method PUT \
162172
163173
### Delete and verify
164174
175+
Delete the resource and confirm it no longer appears in the list:
176+
165177
```bash
166178
az apim delete --name my-apim --resource-group rg-apim-demo --yes
167179
az apim list --resource-group rg-apim-demo

src/content/docs/azure/services/application-insights.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This reconfigures the `az` CLI to send commands to the official Azure management
3636

3737
### Create a resource group
3838

39+
Create a resource group to hold all resources created in this guide:
40+
3941
```bash
4042
az group create --name rg-insights-demo --location eastus
4143
```
@@ -52,6 +54,8 @@ az group create --name rg-insights-demo --location eastus
5254
5355
### Create an Application Insights component
5456
57+
Create an Application Insights component linked to a Log Analytics workspace:
58+
5559
```bash
5660
az monitor app-insights component create \
5761
--app my-app-insights \
@@ -79,6 +83,8 @@ az monitor app-insights component create \
7983
8084
### Show and list components
8185
86+
Retrieve the details of the component and list all components in the resource group:
87+
8288
```bash
8389
az monitor app-insights component show \
8490
--app my-app-insights \
@@ -106,6 +112,8 @@ az monitor app-insights component list \
106112
107113
### Retrieve billing features
108114
115+
Retrieve the current billing features and daily data volume cap for the component:
116+
109117
```bash
110118
az monitor app-insights component billing show \
111119
--app my-app-insights \
@@ -126,6 +134,8 @@ az monitor app-insights component billing show \
126134
127135
### Update billing features
128136
137+
Update the daily data volume cap to limit ingestion costs:
138+
129139
```bash
130140
az monitor app-insights component billing update \
131141
--app my-app-insights \
@@ -147,6 +157,8 @@ az monitor app-insights component billing update \
147157
148158
### Delete and verify
149159
160+
Delete the resource and confirm it no longer appears in the list:
161+
150162
```bash
151163
az monitor app-insights component delete \
152164
--app my-app-insights \

src/content/docs/azure/services/autoscale-setting.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This reconfigures the `az` CLI to send commands to the official Azure management
3636

3737
### Create a resource group
3838

39+
Create a resource group to hold all resources created in this guide:
40+
3941
```bash
4042
az group create --name rg-autoscale-demo --location eastus
4143
```
@@ -52,6 +54,8 @@ az group create --name rg-autoscale-demo --location eastus
5254
5355
### Create an App Service plan
5456
57+
Create an App Service plan to use as the autoscale target:
58+
5559
```bash
5660
az appservice plan create \
5761
--name my-plan \
@@ -75,6 +79,8 @@ az appservice plan create \
7579
7680
### Create an autoscale setting
7781
82+
Create an autoscale setting linked to the App Service plan:
83+
7884
```bash
7985
az monitor autoscale create \
8086
--name my-autoscale \
@@ -107,6 +113,8 @@ az monitor autoscale create \
107113
108114
### Add a scale-out rule
109115
116+
Add a scale-out rule that increases the instance count when average CPU usage rises above 70%:
117+
110118
```bash
111119
az monitor autoscale rule create \
112120
--autoscale-name my-autoscale \
@@ -137,6 +145,8 @@ az monitor autoscale rule create \
137145
138146
### Show and list autoscale settings
139147
148+
Retrieve the details of the autoscale setting and list all settings in the resource group:
149+
140150
```bash
141151
az monitor autoscale show \
142152
--name my-autoscale \
@@ -184,6 +194,8 @@ az monitor autoscale list \
184194
185195
### Delete and verify
186196
197+
Delete the resource and confirm it no longer appears in the list:
198+
187199
```bash
188200
az monitor autoscale delete \
189201
--name my-autoscale \

src/content/docs/azure/services/bastion-host.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ az network vnet subnet create \
107107
108108
### Create a Standard public IP address
109109
110+
Create a Standard SKU static public IP address required by the Bastion host:
111+
110112
```bash
111113
az network public-ip create \
112114
--name pip-bastion \
@@ -136,6 +138,8 @@ az network public-ip create \
136138
137139
### Create a bastion host
138140
141+
Create the Bastion host, linking it to the virtual network and the public IP address:
142+
139143
```bash
140144
az network bastion create \
141145
--name bastion-demo \
@@ -174,6 +178,8 @@ az network bastion create \
174178
175179
### Get and list bastion hosts
176180
181+
Retrieve the details of the Bastion host and list all Bastion instances in the resource group:
182+
177183
```bash
178184
az network bastion show \
179185
--name bastion-demo \
@@ -237,6 +243,8 @@ az network bastion list \
237243
238244
### Delete the bastion host
239245
246+
Delete the Bastion host and verify it no longer appears in the list:
247+
240248
```bash
241249
az network bastion delete \
242250
--name bastion-demo \

src/content/docs/azure/services/container-registry.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This reconfigures the `az` CLI to send commands to the official Azure management
3636

3737
### Create a resource group
3838

39+
Create a resource group to hold all resources created in this guide:
40+
3941
```bash
4042
az group create --name rg-acr-demo --location eastus
4143
```
@@ -52,6 +54,8 @@ az group create --name rg-acr-demo --location eastus
5254
5355
### Create a container registry
5456
57+
Create a Standard-tier Azure Container Registry:
58+
5559
```bash
5660
az acr create \
5761
--name myacrdemo \
@@ -77,12 +81,16 @@ az acr create \
7781
7882
### Log in with Docker
7983
84+
Authenticate the local Docker daemon to the registry using the Azure CLI:
85+
8086
```bash
8187
az acr login --name myacrdemo
8288
```
8389
8490
### Build and push an image
8591
92+
Build a local Docker image and push it to the registry endpoint:
93+
8694
```bash
8795
docker build -t myacrdemo.azurecr.io/hello:v1 .
8896
docker push myacrdemo.azurecr.io/hello:v1
@@ -99,12 +107,16 @@ az acr build \
99107
100108
### Pull an image
101109
110+
Pull the image back from the registry to confirm it was pushed correctly:
111+
102112
```bash
103113
docker pull myacrdemo.azurecr.io/hello:v1
104114
```
105115
106116
### List repositories
107117
118+
List all image repositories stored in the registry:
119+
108120
```bash
109121
az acr repository list --name myacrdemo
110122
```
@@ -115,6 +127,8 @@ az acr repository list --name myacrdemo
115127
116128
### Check name availability
117129
130+
Check that the registry name is globally available before creating:
131+
118132
```bash
119133
az acr check-name --name myacrdemo
120134
```
@@ -129,6 +143,8 @@ az acr check-name --name myacrdemo
129143
130144
### Update registry settings
131145
146+
Enable the admin user account on the registry:
147+
132148
```bash
133149
az acr update --name myacrdemo --resource-group rg-acr-demo --admin-enabled false
134150
```
@@ -149,6 +165,8 @@ az acr update --name myacrdemo --resource-group rg-acr-demo --admin-enabled fals
149165
150166
### Show registry usage
151167
168+
Show current storage usage statistics for the registry:
169+
152170
```bash
153171
az acr show-usage --name myacrdemo --resource-group rg-acr-demo
154172
```
@@ -166,6 +184,8 @@ az acr show-usage --name myacrdemo --resource-group rg-acr-demo
166184
167185
### Delete and verify
168186
187+
Delete the resource and confirm it no longer appears in the list:
188+
169189
```bash
170190
az acr delete --name myacrdemo --resource-group rg-acr-demo --yes
171191
az acr list --resource-group rg-acr-demo

0 commit comments

Comments
 (0)