Skip to content

Commit

Permalink
Clarify LogsQueryClient query parameter description (#20467)
Browse files Browse the repository at this point in the history
  • Loading branch information
scottaddie authored Aug 31, 2021
1 parent 946b290 commit a2a5bbc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ def query(self, workspace_id, query, **kwargs):
:param workspace_id: ID of the workspace. This is Workspace ID from the Properties blade in the
Azure portal.
:type workspace_id: str
:param query: The Analytics query. Learn more about the `Analytics query syntax
<https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/>`_.
:param query: The Kusto query. Learn more about the `Kusto query syntax
<https://docs.microsoft.com/azure/data-explorer/kusto/query/>`_.
:type query: str
:keyword timespan: The timespan for which to query the data. This can be a timedelta,
a timedelta and a start datetime, or a start datetime/end datetime.
Expand Down Expand Up @@ -134,7 +134,7 @@ def query_batch(self, queries, **kwargs):
The response is returned in the same order as that of the requests sent.
:param queries: The list of queries that should be processed
:param queries: The list of Kusto queries to execute.
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQuery]
:return: List of LogsQueryResult, or the result of cls(response)
:rtype: list[~azure.monitor.query.LogsQueryResult]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ async def query(
:param workspace_id: ID of the workspace. This is Workspace ID from the Properties blade in the
Azure portal.
:type workspace_id: str
:param query: The Analytics query. Learn more about the `Analytics query syntax
<https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/>`_.
:param query: The Kusto query. Learn more about the `Kusto query syntax
<https://docs.microsoft.com/azure/data-explorer/kusto/query/>`_.
:type query: str
:param timespan: The timespan for which to query the data. This can be a timedelta,
a timedelta and a start datetime, or a start datetime/end datetime.
Expand All @@ -69,7 +69,7 @@ async def query(
visualization options. By default, the API does not return information regarding the type of
visualization to show. If your client requires this information, specify the preference
:keyword additional_workspaces: A list of workspaces that are included in the query.
These can be qualified workspace names, workspsce Ids or Azure resource Ids.
These can be qualified workspace names, workspace Ids or Azure resource Ids.
:paramtype additional_workspaces: list[str]
:return: QueryResults, or the result of cls(response)
:rtype: ~azure.monitor.query.LogsQueryResult
Expand Down Expand Up @@ -121,7 +121,7 @@ async def query_batch(
The response is returned in the same order as that of the requests sent.
:param queries: The list of queries that should be processed
:param queries: The list of Kusto queries to execute.
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQuery]
:return: list of LogsQueryResult objects, or the result of cls(response)
:rtype: list[~azure.monitor.query.LogsQueryResult]
Expand Down

0 comments on commit a2a5bbc

Please sign in to comment.