|
51 | 51 | "tags": [ |
52 | 52 | "AzureMonitorWorkspaces" |
53 | 53 | ], |
54 | | - "description": "Lists all workspaces in the specified resource group", |
| 54 | + "description": "Lists all Azure Monitor Workspaces in the specified resource group", |
55 | 55 | "operationId": "AzureMonitorWorkspaces_ListByResourceGroup", |
56 | 56 | "produces": [ |
57 | 57 | "application/json" |
|
85 | 85 | "nextLinkName": "nextLink" |
86 | 86 | }, |
87 | 87 | "x-ms-examples": { |
88 | | - "List monitor workspaces by resource group": { |
| 88 | + "List Azure Monitor Workspaces by resource group": { |
89 | 89 | "$ref": "./examples/AzureMonitorWorkspacesListByResourceGroup.json" |
90 | 90 | } |
91 | 91 | } |
|
96 | 96 | "tags": [ |
97 | 97 | "AzureMonitorWorkspaces" |
98 | 98 | ], |
99 | | - "description": "Lists all workspaces in the specified subscription", |
| 99 | + "description": "Lists all Azure Monitor Workspaces in the specified subscription", |
100 | 100 | "operationId": "AzureMonitorWorkspaces_ListBySubscription", |
101 | 101 | "produces": [ |
102 | 102 | "application/json" |
|
127 | 127 | "nextLinkName": "nextLink" |
128 | 128 | }, |
129 | 129 | "x-ms-examples": { |
130 | | - "List workspaces by subscription": { |
| 130 | + "List Azure Monitor Workspaces by subscription": { |
131 | 131 | "$ref": "./examples/AzureMonitorWorkspacesListBySubscription.json" |
132 | 132 | } |
133 | 133 | } |
|
138 | 138 | "tags": [ |
139 | 139 | "AzureMonitorWorkspaces" |
140 | 140 | ], |
141 | | - "description": "Returns the specific Azure Monitor workspace", |
| 141 | + "description": "Returns the specified Azure Monitor Workspace", |
142 | 142 | "operationId": "AzureMonitorWorkspaces_Get", |
143 | 143 | "produces": [ |
144 | 144 | "application/json" |
|
172 | 172 | } |
173 | 173 | }, |
174 | 174 | "x-ms-examples": { |
175 | | - "Get workspace": { |
| 175 | + "Get Azure Monitor Workspace": { |
176 | 176 | "$ref": "./examples/AzureMonitorWorkspacesGet.json" |
177 | 177 | } |
178 | 178 | } |
|
181 | 181 | "tags": [ |
182 | 182 | "AzureMonitorWorkspaces" |
183 | 183 | ], |
184 | | - "description": "Create or update a workspace", |
| 184 | + "description": "Creates or updates an Azure Monitor Workspace", |
185 | 185 | "operationId": "AzureMonitorWorkspaces_Create", |
186 | 186 | "consumes": [ |
187 | 187 | "application/json" |
|
205 | 205 | { |
206 | 206 | "in": "body", |
207 | 207 | "name": "azureMonitorWorkspaceProperties", |
208 | | - "description": "Properties that need to be specified to create a new workspace", |
| 208 | + "description": "Properties that need to be specified to create a new Azure Monitor Workspace", |
209 | 209 | "required": true, |
210 | 210 | "schema": { |
211 | 211 | "$ref": "#/definitions/AzureMonitorWorkspaceResource" |
|
214 | 214 | ], |
215 | 215 | "responses": { |
216 | 216 | "200": { |
217 | | - "description": "Azure Monitor workspace was successfully updated", |
| 217 | + "description": "Azure Monitor Workspace was successfully updated", |
218 | 218 | "schema": { |
219 | 219 | "$ref": "#/definitions/AzureMonitorWorkspaceResource" |
220 | 220 | } |
221 | 221 | }, |
222 | 222 | "201": { |
223 | | - "description": "Azure Monitor workspace was successfully created", |
| 223 | + "description": "Azure Monitor Workspace was successfully created", |
224 | 224 | "schema": { |
225 | 225 | "$ref": "#/definitions/AzureMonitorWorkspaceResource" |
226 | 226 | } |
|
233 | 233 | } |
234 | 234 | }, |
235 | 235 | "x-ms-examples": { |
236 | | - "Create or update workspace": { |
| 236 | + "Create or update an Azure Monitor Workspace": { |
237 | 237 | "$ref": "./examples/AzureMonitorWorkspacesCreate.json" |
238 | 238 | } |
239 | 239 | } |
|
242 | 242 | "tags": [ |
243 | 243 | "AzureMonitorWorkspaces" |
244 | 244 | ], |
245 | | - "description": "Updates part of a workspace", |
| 245 | + "description": "Updates part of an Azure Monitor Workspace", |
246 | 246 | "operationId": "AzureMonitorWorkspaces_Update", |
247 | 247 | "consumes": [ |
248 | 248 | "application/json" |
|
274 | 274 | ], |
275 | 275 | "responses": { |
276 | 276 | "200": { |
277 | | - "description": "Monitor workspace was successfully updated", |
| 277 | + "description": "Azure Monitor Workspace was successfully updated", |
278 | 278 | "schema": { |
279 | 279 | "$ref": "#/definitions/AzureMonitorWorkspaceResource" |
280 | 280 | } |
|
287 | 287 | } |
288 | 288 | }, |
289 | 289 | "x-ms-examples": { |
290 | | - "Update workspace": { |
| 290 | + "Update an Azure Monitor Workspace": { |
291 | 291 | "$ref": "./examples/AzureMonitorWorkspacesUpdate.json" |
292 | 292 | } |
293 | 293 | } |
|
296 | 296 | "tags": [ |
297 | 297 | "AzureMonitorWorkspaces" |
298 | 298 | ], |
299 | | - "description": "Delete a workspace", |
| 299 | + "description": "Deletes an Azure Monitor Workspace", |
300 | 300 | "operationId": "AzureMonitorWorkspaces_Delete", |
301 | 301 | "produces": [ |
302 | 302 | "application/json" |
|
317 | 317 | ], |
318 | 318 | "responses": { |
319 | 319 | "200": { |
320 | | - "description": "Workspace was successfully deleted" |
| 320 | + "description": "Azure Monitor Workspace was successfully deleted" |
321 | 321 | }, |
322 | 322 | "204": { |
323 | | - "description": "Workspace did not exist" |
| 323 | + "description": "Azure Monitor Workspace does not exist" |
324 | 324 | }, |
325 | 325 | "default": { |
326 | 326 | "description": "Error", |
|
330 | 330 | } |
331 | 331 | }, |
332 | 332 | "x-ms-examples": { |
333 | | - "Delete workspace": { |
| 333 | + "Delete an Azure Monitor Workspace": { |
334 | 334 | "$ref": "./examples/AzureMonitorWorkspacesDelete.json" |
335 | 335 | } |
336 | 336 | } |
|
339 | 339 | }, |
340 | 340 | "definitions": { |
341 | 341 | "Metrics": { |
342 | | - "description": "Information about metrics for the workspace", |
| 342 | + "description": "Properties related to the metrics container in the Azure Monitor Workspace", |
343 | 343 | "type": "object", |
344 | 344 | "properties": { |
345 | 345 | "prometheusQueryEndpoint": { |
346 | | - "description": "The Prometheus query endpoint for the workspace", |
| 346 | + "description": "The Prometheus query endpoint for the Azure Monitor Workspace", |
347 | 347 | "type": "string", |
348 | 348 | "readOnly": true, |
349 | 349 | "x-ms-mutability": [ |
|
365 | 365 | "type": "object", |
366 | 366 | "properties": { |
367 | 367 | "dataCollectionRuleResourceId": { |
368 | | - "description": "The Azure resource Id of the default data collection rule for this workspace.", |
| 368 | + "description": "The Azure resource Id of the default data collection rule for this Azure Monitor Workspace.", |
369 | 369 | "type": "string", |
370 | 370 | "readOnly": true, |
371 | 371 | "x-ms-mutability": [ |
372 | 372 | "read" |
373 | 373 | ] |
374 | 374 | }, |
375 | 375 | "dataCollectionEndpointResourceId": { |
376 | | - "description": "The Azure resource Id of the default data collection endpoint for this workspace.", |
| 376 | + "description": "The Azure resource Id of the default data collection endpoint for this Azure Monitor Workspace.", |
377 | 377 | "type": "string", |
378 | 378 | "readOnly": true, |
379 | 379 | "x-ms-mutability": [ |
|
383 | 383 | } |
384 | 384 | }, |
385 | 385 | "AzureMonitorWorkspace": { |
386 | | - "description": "Properties of an Azure Monitor workspace", |
| 386 | + "description": "Properties of an Azure Monitor Workspace", |
387 | 387 | "type": "object", |
388 | 388 | "properties": { |
389 | 389 | "accountId": { |
390 | | - "description": "The immutable ID of the Azure Monitor workspace. This property is read-only.", |
| 390 | + "description": "The immutable Id of the Azure Monitor Workspace. This property is read-only.", |
391 | 391 | "type": "string", |
392 | 392 | "readOnly": true, |
393 | 393 | "x-ms-mutability": [ |
394 | 394 | "read" |
395 | 395 | ] |
396 | 396 | }, |
397 | 397 | "metrics": { |
398 | | - "description": "Information about metrics for the Azure Monitor workspace", |
| 398 | + "description": "Properties related to the metrics container in the Azure Monitor Workspace", |
399 | 399 | "allOf": [ |
400 | 400 | { |
401 | 401 | "$ref": "#/definitions/Metrics" |
|
407 | 407 | ] |
408 | 408 | }, |
409 | 409 | "provisioningState": { |
410 | | - "description": "The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.", |
| 410 | + "description": "The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy.", |
411 | 411 | "enum": [ |
412 | 412 | "Creating", |
413 | 413 | "Succeeded", |
|
492 | 492 | } |
493 | 493 | }, |
494 | 494 | "AzureMonitorWorkspaceResourceForUpdate": { |
495 | | - "description": "Definition of ARM tracked top level resource properties for update operation", |
| 495 | + "description": "Definition of ARM tracked top level resource properties for the Update operation", |
496 | 496 | "type": "object", |
497 | 497 | "properties": { |
498 | 498 | "tags": { |
|
509 | 509 | "AzureMonitorWorkspaceNameParameter": { |
510 | 510 | "in": "path", |
511 | 511 | "name": "azureMonitorWorkspaceName", |
512 | | - "description": "The name of the Azure Monitor workspace. The name is case insensitive", |
| 512 | + "description": "The name of the Azure Monitor Workspace. The name is case insensitive", |
513 | 513 | "required": true, |
514 | 514 | "type": "string", |
515 | 515 | "pattern": "^(?!-)[a-zA-Z0-9-]+[^-]$", |
|
0 commit comments