Skip to content

Commit da66601

Browse files
paolosalvatoripaolosalvatori
committed
docs(azure): add real command output to all 24 articles
1 parent 32d27b4 commit da66601

24 files changed

Lines changed: 2333 additions & 143 deletions

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

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ This reconfigures the `az` CLI to send commands to the official Azure management
4040
az group create --name rg-monit-demo --location eastus
4141
```
4242

43+
```bash title="Output"
44+
{
45+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-monit-demo",
46+
"location": "eastus",
47+
"name": "rg-monit-demo",
48+
"properties": { "provisioningState": "Succeeded" },
49+
"type": "Microsoft.Resources/resourceGroups"
50+
}
51+
```
52+
4353
### Create an action group
4454
4555
```bash
@@ -50,21 +60,20 @@ az monitor action-group create \
5060
--action email myemail admin@example.com
5161
```
5262
53-
```json title="Output"
63+
```bash title="Output"
5464
{
5565
"emailReceivers": [
5666
{
5767
"emailAddress": "admin@example.com",
5868
"name": "myemail",
59-
"status": "Enabled",
6069
"useCommonAlertSchema": false
6170
}
6271
],
6372
"groupShortName": "myag",
6473
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-monit-demo/providers/microsoft.insights/actionGroups/my-action-group",
6574
"name": "my-action-group",
6675
"resourceGroup": "rg-monit-demo",
67-
"type": "microsoft.insights/actionGroups"
76+
"type": "Microsoft.Insights/ActionGroups"
6877
}
6978
```
7079
@@ -74,11 +83,49 @@ az monitor action-group create \
7483
az monitor action-group show \
7584
--name my-action-group \
7685
--resource-group rg-monit-demo
86+
```
7787
88+
```bash title="Output"
89+
{
90+
"emailReceivers": [
91+
{
92+
"emailAddress": "admin@example.com",
93+
"name": "myemail",
94+
"useCommonAlertSchema": false
95+
}
96+
],
97+
"groupShortName": "myag",
98+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-monit-demo/providers/microsoft.insights/actionGroups/my-action-group",
99+
"name": "my-action-group",
100+
"resourceGroup": "rg-monit-demo",
101+
"type": "Microsoft.Insights/ActionGroups"
102+
}
103+
```
104+
105+
```bash
78106
az monitor action-group list \
79107
--resource-group rg-monit-demo
80108
```
81109
110+
```bash title="Output"
111+
[
112+
{
113+
"emailReceivers": [
114+
{
115+
"emailAddress": "admin@example.com",
116+
"name": "myemail",
117+
"useCommonAlertSchema": false
118+
}
119+
],
120+
"groupShortName": "myag",
121+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-monit-demo/providers/microsoft.insights/actionGroups/my-action-group",
122+
"name": "my-action-group",
123+
"resourceGroup": "rg-monit-demo",
124+
"type": "Microsoft.Insights/ActionGroups"
125+
}
126+
]
127+
```
128+
82129
### Update an action group
83130
84131
```bash
@@ -88,16 +135,36 @@ az monitor action-group update \
88135
--add-action email newcontact ops@example.com
89136
```
90137
138+
```bash title="Output"
139+
{
140+
"emailReceivers": [
141+
{ "emailAddress": "admin@example.com", "name": "myemail", "useCommonAlertSchema": false },
142+
{ "emailAddress": "ops@example.com", "name": "newcontact", "useCommonAlertSchema": false }
143+
],
144+
"groupShortName": "myag",
145+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-monit-demo/providers/microsoft.insights/actionGroups/my-action-group",
146+
"name": "my-action-group",
147+
"resourceGroup": "rg-monit-demo",
148+
"type": "Microsoft.Insights/ActionGroups"
149+
}
150+
```
151+
91152
### Delete and verify
92153
93154
```bash
94155
az monitor action-group delete \
95156
--name my-action-group \
96157
--resource-group rg-monit-demo
158+
```
97159
160+
```bash
98161
az monitor action-group list --resource-group rg-monit-demo
99162
```
100163
164+
```bash title="Output"
165+
[]
166+
```
167+
101168
## Features
102169
103170
- **Action group lifecycle:** Create, read, list, update, and delete action groups.

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

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ This reconfigures the `az` CLI to send commands to the official Azure management
4040
az group create --name rg-apim-demo --location eastus
4141
```
4242

43+
```bash title="Output"
44+
{
45+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-apim-demo",
46+
"location": "eastus",
47+
"name": "rg-apim-demo",
48+
"properties": { "provisioningState": "Succeeded" },
49+
"type": "Microsoft.Resources/resourceGroups"
50+
}
51+
```
52+
4353
### Create an API Management service instance
4454
4555
```bash
@@ -52,32 +62,73 @@ az apim create \
5262
--publisher-name "My Organization"
5363
```
5464
55-
```json title="Output"
65+
```bash title="Output"
5666
{
67+
"gatewayUrl": "https://my-apim.azure-api.net",
5768
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-apim-demo/providers/Microsoft.ApiManagement/service/my-apim",
69+
"location": "East US",
5870
"name": "my-apim",
5971
"provisioningState": "Succeeded",
72+
"publisherEmail": "admin@example.com",
73+
"publisherName": "My Organization",
6074
"resourceGroup": "rg-apim-demo",
61-
"sku": {
62-
"name": "Consumption"
63-
},
64-
"type": "Microsoft.ApiManagement/service"
75+
"sku": { "capacity": 0, "name": "Consumption" },
76+
"type": "Microsoft.ApiManagement/service",
77+
...
6578
}
6679
```
6780
6881
### Show and list services
6982
7083
```bash
7184
az apim show --name my-apim --resource-group rg-apim-demo
85+
```
86+
87+
```bash title="Output"
88+
{
89+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-apim-demo/providers/Microsoft.ApiManagement/service/my-apim",
90+
"location": "East US",
91+
"name": "my-apim",
92+
"provisioningState": "Succeeded",
93+
"publisherEmail": "admin@example.com",
94+
"publisherName": "My Organization",
95+
"resourceGroup": "rg-apim-demo",
96+
"sku": { "capacity": 0, "name": "Consumption" },
97+
"type": "Microsoft.ApiManagement/service"
98+
}
99+
```
100+
101+
```bash
72102
az apim list --resource-group rg-apim-demo
73103
```
74104
105+
```bash title="Output"
106+
[
107+
{
108+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-apim-demo/providers/Microsoft.ApiManagement/service/my-apim",
109+
"name": "my-apim",
110+
"provisioningState": "Succeeded",
111+
"resourceGroup": "rg-apim-demo",
112+
"sku": { "capacity": 0, "name": "Consumption" },
113+
"type": "Microsoft.ApiManagement/service"
114+
}
115+
]
116+
```
117+
75118
### Check service name availability
76119
77120
```bash
78121
az apim check-name --name my-apim
79122
```
80123
124+
```bash title="Output"
125+
{
126+
"message": "",
127+
"nameAvailable": true,
128+
"reason": "Valid"
129+
}
130+
```
131+
81132
### Create an API
82133
83134
Use the REST API or Azure SDK directly to create an API definition within the service:

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

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ This reconfigures the `az` CLI to send commands to the official Azure management
4040
az group create --name rg-insights-demo --location eastus
4141
```
4242

43+
```bash title="Output"
44+
{
45+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-insights-demo",
46+
"location": "eastus",
47+
"name": "rg-insights-demo",
48+
"properties": { "provisioningState": "Succeeded" },
49+
"type": "Microsoft.Resources/resourceGroups"
50+
}
51+
```
52+
4353
### Create an Application Insights component
4454
4555
```bash
@@ -51,12 +61,14 @@ az monitor app-insights component create \
5161
--application-type web
5262
```
5363
54-
```json title="Output"
64+
```bash title="Output"
5565
{
5666
"appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
67+
"connectionString": "InstrumentationKey=xxxxxxxx-...;IngestionEndpoint=https://eastus.in.applicationinsights.azure.com/;...",
5768
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-insights-demo/providers/microsoft.insights/components/my-app-insights",
5869
"instrumentationKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
5970
"kind": "web",
71+
"location": "eastus",
6072
"name": "my-app-insights",
6173
"provisioningState": "Succeeded",
6274
"resourceGroup": "rg-insights-demo",
@@ -70,7 +82,22 @@ az monitor app-insights component create \
7082
az monitor app-insights component show \
7183
--app my-app-insights \
7284
--resource-group rg-insights-demo
85+
```
86+
87+
```bash title="Output"
88+
{
89+
"appId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
90+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-insights-demo/providers/microsoft.insights/components/my-app-insights",
91+
"instrumentationKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
92+
"kind": "web",
93+
"name": "my-app-insights",
94+
"provisioningState": "Succeeded",
95+
"resourceGroup": "rg-insights-demo",
96+
"type": "microsoft.insights/components"
97+
}
98+
```
7399
100+
```bash
74101
az monitor app-insights component list \
75102
--resource-group rg-insights-demo
76103
```
@@ -83,6 +110,18 @@ az monitor app-insights component billing show \
83110
--resource-group rg-insights-demo
84111
```
85112
113+
```bash title="Output"
114+
{
115+
"currentBillingFeatures": ["Basic"],
116+
"dataVolumeCap": {
117+
"cap": 100.0,
118+
"maxHistoryCap": 1000.0,
119+
"resetTime": 0,
120+
"warningThreshold": 90
121+
}
122+
}
123+
```
124+
86125
### Update billing features
87126
88127
```bash
@@ -92,18 +131,36 @@ az monitor app-insights component billing update \
92131
--cap 100
93132
```
94133
134+
```bash title="Output"
135+
{
136+
"currentBillingFeatures": ["Basic"],
137+
"dataVolumeCap": {
138+
"cap": 100.0,
139+
"maxHistoryCap": 1000.0,
140+
"resetTime": 0,
141+
"warningThreshold": 90
142+
}
143+
}
144+
```
145+
95146
### Delete and verify
96147
97148
```bash
98149
az monitor app-insights component delete \
99150
--app my-app-insights \
100151
--resource-group rg-insights-demo \
101152
--yes
153+
```
102154
155+
```bash
103156
az monitor app-insights component list \
104157
--resource-group rg-insights-demo
105158
```
106159
160+
```bash title="Output"
161+
[]
162+
```
163+
107164
## Features
108165
109166
- **Component lifecycle:** Create, read, list, and delete Application Insights components.

0 commit comments

Comments
 (0)