Skip to content

Commit a9db2a1

Browse files
scottaddieiscai-msft
authored andcommitted
Small tweaks to Monitor Query SDK README (#20905)
1 parent 7dea0f9 commit a9db2a1

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

sdk/monitor/azure-monitor-query/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ except HttpResponseError as err:
140140

141141
#### Handle logs query response
142142

143-
The `query` API returns a union of `LogsQueryResult` and `LogsQueryPartialResult` while the `batch_query` API returns list of `LogsQueryResult`, `LogsQueryPartialResult` and `LogsQueryError` objects. Here's a hierarchy of the response:
143+
The `query_workspace` API returns a union of `LogsQueryResult` and `LogsQueryPartialResult` objects, while the `batch_query` API returns list of `LogsQueryResult`, `LogsQueryPartialResult`, and `LogsQueryError` objects. Here's a hierarchy of the response:
144144

145145
```
146146
LogsQueryResult
@@ -164,8 +164,7 @@ LogsQueryPartialResult
164164
|---column_types
165165
```
166166

167-
The `LogsQueryResult` directly iterates over the table as a convinience.
168-
For example, to handle a logs query response with tables and display it using pandas:
167+
The `LogsQueryResult` directly iterates over the table as a convenience. For example, to handle a logs query response with tables and display it using pandas:
169168

170169
```python
171170
response = client.query(...)
@@ -189,7 +188,7 @@ A full sample can be found [here](https://github.com/Azure/azure-sdk-for-python/
189188

190189
### Batch logs query
191190

192-
The following example demonstrates sending multiple queries at the same time using batch query API. The queries can either be represented as a list of `LogsBatchQuery` objects or a dictionary. This example uses the former approach.
191+
The following example demonstrates sending multiple queries at the same time using the batch query API. The queries can either be represented as a list of `LogsBatchQuery` objects or a dictionary. This example uses the former approach.
193192

194193
```python
195194
import os
@@ -287,7 +286,7 @@ A full sample can be found [here](https://github.com/Azure/azure-sdk-for-python/
287286

288287
### Metrics query
289288

290-
The following example gets metrics for an Event Grid subscription. The resource URI is that of an event grid topic.
289+
The following example gets metrics for an Event Grid subscription. The resource URI is that of an Event Grid topic.
291290

292291
The resource URI must be that of the resource for which metrics are being queried. It's normally of the format `/subscriptions/<id>/resourceGroups/<rg-name>/providers/<source>/topics/<resource-name>`.
293292

@@ -325,7 +324,7 @@ for metric in response.metrics:
325324

326325
#### Handle metrics query response
327326

328-
The metrics query API returns a `MetricsResult` object. The `MetricsResult` object contains properties such as a list of `Metric`-typed objects, `granularity`, `namespace`, and `timespan`. The `Metric` objects list can be accessed using the `metrics` param. Each `Metric` object in this list contains a list of `TimeSeriesElement` objects. Each `TimeSeriesElement` contains `data` and `metadata_values` properties. In visual form, the object hierarchy of the response resembles the following structure:
327+
The metrics query API returns a `MetricsResult` object. The `MetricsResult` object contains properties such as a list of `Metric`-typed objects, `granularity`, `namespace`, and `timespan`. The `Metric` objects list can be accessed using the `metrics` param. Each `Metric` object in this list contains a list of `TimeSeriesElement` objects. Each `TimeSeriesElement` object contains `data` and `metadata_values` properties. In visual form, the object hierarchy of the response resembles the following structure:
329328

330329
```
331330
MetricsResult

0 commit comments

Comments
 (0)