Skip to content

Commit a2a5bbc

Browse files
authored
Clarify LogsQueryClient query parameter description (Azure#20467)
1 parent 946b290 commit a2a5bbc

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

sdk/monitor/azure-monitor-query/azure/monitor/query/_logs_query_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ def query(self, workspace_id, query, **kwargs):
6060
:param workspace_id: ID of the workspace. This is Workspace ID from the Properties blade in the
6161
Azure portal.
6262
:type workspace_id: str
63-
:param query: The Analytics query. Learn more about the `Analytics query syntax
64-
<https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/>`_.
63+
:param query: The Kusto query. Learn more about the `Kusto query syntax
64+
<https://docs.microsoft.com/azure/data-explorer/kusto/query/>`_.
6565
:type query: str
6666
:keyword timespan: The timespan for which to query the data. This can be a timedelta,
6767
a timedelta and a start datetime, or a start datetime/end datetime.
@@ -134,7 +134,7 @@ def query_batch(self, queries, **kwargs):
134134
135135
The response is returned in the same order as that of the requests sent.
136136
137-
:param queries: The list of queries that should be processed
137+
:param queries: The list of Kusto queries to execute.
138138
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQuery]
139139
:return: List of LogsQueryResult, or the result of cls(response)
140140
:rtype: list[~azure.monitor.query.LogsQueryResult]

sdk/monitor/azure-monitor-query/azure/monitor/query/aio/_logs_query_client_async.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ async def query(
5555
:param workspace_id: ID of the workspace. This is Workspace ID from the Properties blade in the
5656
Azure portal.
5757
:type workspace_id: str
58-
:param query: The Analytics query. Learn more about the `Analytics query syntax
59-
<https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/>`_.
58+
:param query: The Kusto query. Learn more about the `Kusto query syntax
59+
<https://docs.microsoft.com/azure/data-explorer/kusto/query/>`_.
6060
:type query: str
6161
:param timespan: The timespan for which to query the data. This can be a timedelta,
6262
a timedelta and a start datetime, or a start datetime/end datetime.
@@ -69,7 +69,7 @@ async def query(
6969
visualization options. By default, the API does not return information regarding the type of
7070
visualization to show. If your client requires this information, specify the preference
7171
:keyword additional_workspaces: A list of workspaces that are included in the query.
72-
These can be qualified workspace names, workspsce Ids or Azure resource Ids.
72+
These can be qualified workspace names, workspace Ids or Azure resource Ids.
7373
:paramtype additional_workspaces: list[str]
7474
:return: QueryResults, or the result of cls(response)
7575
:rtype: ~azure.monitor.query.LogsQueryResult
@@ -121,7 +121,7 @@ async def query_batch(
121121
122122
The response is returned in the same order as that of the requests sent.
123123
124-
:param queries: The list of queries that should be processed
124+
:param queries: The list of Kusto queries to execute.
125125
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQuery]
126126
:return: list of LogsQueryResult objects, or the result of cls(response)
127127
:rtype: list[~azure.monitor.query.LogsQueryResult]

0 commit comments

Comments
 (0)