Skip to content

Commit ac60fb9

Browse files
author
Rakshith Bhyravabhotla
authored
Rename query (Azure#19952)
* Rename logs query request * rename LogsQueryResults * Revert "rename LogsQueryResults" This reverts commit 6d54741.
1 parent 455b3a0 commit ac60fb9

File tree

10 files changed

+38
-36
lines changed

10 files changed

+38
-36
lines changed

‎sdk/monitor/azure-monitor-query/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Release History
22

3+
34
## 1.0.0b3 (Unreleased)
45

56
### Features Added
@@ -11,6 +12,7 @@
1112
- `aggregation` param in the query API is renamed to `aggregations`
1213
- `batch_query` API now returns a list of responses.
1314
- `LogsBatchResults` model is now removed.
15+
- `LogsQueryRequest` is renamed to `LogsBatchQueryRequest`
1416

1517
### Bugs Fixed
1618

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,19 +194,19 @@ credential = DefaultAzureCredential()
194194
client = LogsQueryClient(credential)
195195

196196
requests = [
197-
LogsQueryRequest(
197+
LogsBatchQueryRequest(
198198
query="AzureActivity | summarize count()",
199199
duration=timedelta(hours=1),
200200
workspace_id=os.environ['LOG_WORKSPACE_ID']
201201
),
202-
LogsQueryRequest(
202+
LogsBatchQueryRequest(
203203
query= """AppRequests | take 10 |
204204
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
205205
duration=timedelta(hours=1),
206206
start_time=datetime(2021, 6, 2),
207207
workspace_id=os.environ['LOG_WORKSPACE_ID']
208208
),
209-
LogsQueryRequest(
209+
LogsBatchQueryRequest(
210210
query= "AppRequests | take 2",
211211
workspace_id=os.environ['LOG_WORKSPACE_ID']
212212
),

‎sdk/monitor/azure-monitor-query/azure/monitor/query/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
LogsQueryResultColumn,
1515
MetricsResult,
1616
LogsBatchResultError,
17-
LogsQueryRequest,
17+
LogsBatchQueryRequest,
1818
MetricNamespace,
1919
MetricDefinition,
2020
MetricsMetadataValue,
@@ -33,7 +33,7 @@
3333
"LogsQueryResults",
3434
"LogsQueryResultColumn",
3535
"LogsQueryResultTable",
36-
"LogsQueryRequest",
36+
"LogsBatchQueryRequest",
3737
"MetricsQueryClient",
3838
"MetricNamespace",
3939
"MetricDefinition",

‎sdk/monitor/azure-monitor-query/azure/monitor/query/_log_query_client.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
from ._generated.models import BatchRequest, QueryBody as LogsQueryBody
1414
from ._helpers import get_authentication_policy, process_error, construct_iso8601, order_results
15-
from ._models import LogsQueryResults, LogsQueryRequest, LogsQueryResult
15+
from ._models import LogsQueryResults, LogsBatchQueryRequest, LogsQueryResult
1616

1717
if TYPE_CHECKING:
1818
from azure.core.credentials import TokenCredential
@@ -131,14 +131,14 @@ def query(self, workspace_id, query, duration=None, **kwargs):
131131
process_error(e)
132132

133133
def batch_query(self, queries, **kwargs):
134-
# type: (Union[Sequence[Dict], Sequence[LogsQueryRequest]], Any) -> Sequence[LogsQueryResult]
134+
# type: (Union[Sequence[Dict], Sequence[LogsBatchQueryRequest]], Any) -> Sequence[LogsQueryResult]
135135
"""Execute a list of analytics queries. Each request can be either a LogQueryRequest
136136
object or an equivalent serialized model.
137137
138138
The response is returned in the same order as that of the requests sent.
139139
140140
:param queries: The list of queries that should be processed
141-
:type queries: list[dict] or list[~azure.monitor.query.LogsQueryRequest]
141+
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQueryRequest]
142142
:return: BatchResponse, or the result of cls(response)
143143
:rtype: ~list[~azure.monitor.query.LogsQueryResult]
144144
:raises: ~azure.core.exceptions.HttpResponseError
@@ -153,7 +153,7 @@ def batch_query(self, queries, **kwargs):
153153
:caption: Get a response for multiple Log Queries.
154154
"""
155155
try:
156-
queries = [LogsQueryRequest(**q) for q in queries]
156+
queries = [LogsBatchQueryRequest(**q) for q in queries]
157157
except (KeyError, TypeError):
158158
pass
159159
try:

‎sdk/monitor/azure-monitor-query/azure/monitor/query/_models.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def _from_generated(cls, generated):
142142
metrics=[Metric._from_generated(m) for m in generated.value] # pylint: disable=protected-access
143143
)
144144

145-
class LogsQueryRequest(InternalLogQueryRequest):
145+
class LogsBatchQueryRequest(InternalLogQueryRequest):
146146
"""A single request in a batch.
147147
148148
Variables are only populated by the server, and will be ignored when sending a request.

‎sdk/monitor/azure-monitor-query/azure/monitor/query/aio/_log_query_client_async.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
from .._generated.models import BatchRequest, QueryBody as LogsQueryBody
1414
from .._helpers import process_error, construct_iso8601, order_results
15-
from .._models import LogsQueryResults, LogsQueryRequest, LogsQueryResult
15+
from .._models import LogsQueryResults, LogsBatchQueryRequest, LogsQueryResult
1616
from ._helpers_asyc import get_authentication_policy
1717

1818
if TYPE_CHECKING:
@@ -116,7 +116,7 @@ async def query(
116116

117117
async def batch_query(
118118
self,
119-
queries: Union[Sequence[Dict], Sequence[LogsQueryRequest]],
119+
queries: Union[Sequence[Dict], Sequence[LogsBatchQueryRequest]],
120120
**kwargs: Any
121121
) -> Sequence[LogsQueryResult]:
122122
"""Execute a list of analytics queries. Each request can be either a LogQueryRequest
@@ -125,13 +125,13 @@ async def batch_query(
125125
The response is returned in the same order as that of the requests sent.
126126
127127
:param queries: The list of queries that should be processed
128-
:type queries: list[dict] or list[~azure.monitor.query.LogsQueryRequest]
128+
:type queries: list[dict] or list[~azure.monitor.query.LogsBatchQueryRequest]
129129
:return: BatchResponse, or the result of cls(response)
130130
:rtype: ~list[~azure.monitor.query.LogsQueryResult]
131131
:raises: ~azure.core.exceptions.HttpResponseError
132132
"""
133133
try:
134-
queries = [LogsQueryRequest(**q) for q in queries]
134+
queries = [LogsBatchQueryRequest(**q) for q in queries]
135135
except (KeyError, TypeError):
136136
pass
137137
try:

‎sdk/monitor/azure-monitor-query/samples/sample_batch_query.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from datetime import datetime, timedelta
55
import os
66
import pandas as pd
7-
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
7+
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest
88
from azure.identity import DefaultAzureCredential
99

1010

@@ -14,19 +14,19 @@
1414

1515
# [START send_batch_query]
1616
requests = [
17-
LogsQueryRequest(
17+
LogsBatchQueryRequest(
1818
query="AzureActivity | summarize count()",
1919
duration=timedelta(hours=1),
2020
workspace_id= os.environ['LOG_WORKSPACE_ID']
2121
),
22-
LogsQueryRequest(
22+
LogsBatchQueryRequest(
2323
query= """AppRequests | take 10 |
2424
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
2525
duration=timedelta(hours=1),
2626
start_time=datetime(2021, 6, 2),
2727
workspace_id= os.environ['LOG_WORKSPACE_ID']
2828
),
29-
LogsQueryRequest(
29+
LogsBatchQueryRequest(
3030
query= "AppRequests | take 5",
3131
workspace_id= os.environ['LOG_WORKSPACE_ID'],
3232
include_statistics=True

‎sdk/monitor/azure-monitor-query/tests/async/test_logs_client_async.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import os
33
from azure.identity.aio import ClientSecretCredential
44
from azure.core.exceptions import HttpResponseError
5-
from azure.monitor.query import LogsQueryRequest
5+
from azure.monitor.query import LogsBatchQueryRequest
66
from azure.monitor.query.aio import LogsQueryClient
77

88
def _credential():
@@ -44,18 +44,18 @@ async def test_logs_batch_query():
4444
client = LogsQueryClient(_credential())
4545

4646
requests = [
47-
LogsQueryRequest(
47+
LogsBatchQueryRequest(
4848
query="AzureActivity | summarize count()",
4949
timespan="PT1H",
5050
workspace_id= os.environ['LOG_WORKSPACE_ID']
5151
),
52-
LogsQueryRequest(
52+
LogsBatchQueryRequest(
5353
query= """AppRequests | take 10 |
5454
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
5555
timespan="PT1H",
5656
workspace_id= os.environ['LOG_WORKSPACE_ID']
5757
),
58-
LogsQueryRequest(
58+
LogsBatchQueryRequest(
5959
query= "AppRequests | take 2",
6060
workspace_id= os.environ['LOG_WORKSPACE_ID']
6161
),
@@ -90,19 +90,19 @@ async def test_logs_batch_query_additional_workspaces():
9090
query = "union * | where TimeGenerated > ago(100d) | project TenantId | summarize count() by TenantId"
9191

9292
requests = [
93-
LogsQueryRequest(
93+
LogsBatchQueryRequest(
9494
query,
9595
timespan="PT1H",
9696
workspace_id= os.environ['LOG_WORKSPACE_ID'],
9797
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
9898
),
99-
LogsQueryRequest(
99+
LogsBatchQueryRequest(
100100
query,
101101
timespan="PT1H",
102102
workspace_id= os.environ['LOG_WORKSPACE_ID'],
103103
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
104104
),
105-
LogsQueryRequest(
105+
LogsBatchQueryRequest(
106106
query,
107107
workspace_id= os.environ['LOG_WORKSPACE_ID'],
108108
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]

‎sdk/monitor/azure-monitor-query/tests/test_logs_client.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import os
33
from azure.identity import ClientSecretCredential
44
from azure.core.exceptions import HttpResponseError
5-
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
5+
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest
66

77
def _credential():
88
credential = ClientSecretCredential(
@@ -66,18 +66,18 @@ def test_logs_batch_query():
6666
client = LogsQueryClient(_credential())
6767

6868
requests = [
69-
LogsQueryRequest(
69+
LogsBatchQueryRequest(
7070
query="AzureActivity | summarize count()",
7171
timespan="PT1H",
7272
workspace_id= os.environ['LOG_WORKSPACE_ID']
7373
),
74-
LogsQueryRequest(
74+
LogsBatchQueryRequest(
7575
query= """AppRequests | take 10 |
7676
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
7777
timespan="PT1H",
7878
workspace_id= os.environ['LOG_WORKSPACE_ID']
7979
),
80-
LogsQueryRequest(
80+
LogsBatchQueryRequest(
8181
query= "AppRequests | take 2",
8282
workspace_id= os.environ['LOG_WORKSPACE_ID']
8383
),
@@ -102,19 +102,19 @@ def test_logs_batch_query_with_statistics_in_some():
102102
client = LogsQueryClient(_credential())
103103

104104
requests = [
105-
LogsQueryRequest(
105+
LogsBatchQueryRequest(
106106
query="AzureActivity | summarize count()",
107107
timespan="PT1H",
108108
workspace_id= os.environ['LOG_WORKSPACE_ID']
109109
),
110-
LogsQueryRequest(
110+
LogsBatchQueryRequest(
111111
query= """AppRequests|
112112
summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId""",
113113
timespan="PT1H",
114114
workspace_id= os.environ['LOG_WORKSPACE_ID'],
115115
include_statistics=True
116116
),
117-
LogsQueryRequest(
117+
LogsBatchQueryRequest(
118118
query= "AppRequests",
119119
workspace_id= os.environ['LOG_WORKSPACE_ID'],
120120
include_statistics=True
@@ -150,19 +150,19 @@ def test_logs_batch_query_additional_workspaces():
150150
query = "union * | where TimeGenerated > ago(100d) | project TenantId | summarize count() by TenantId"
151151

152152
requests = [
153-
LogsQueryRequest(
153+
LogsBatchQueryRequest(
154154
query,
155155
timespan="PT1H",
156156
workspace_id= os.environ['LOG_WORKSPACE_ID'],
157157
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
158158
),
159-
LogsQueryRequest(
159+
LogsBatchQueryRequest(
160160
query,
161161
timespan="PT1H",
162162
workspace_id= os.environ['LOG_WORKSPACE_ID'],
163163
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]
164164
),
165-
LogsQueryRequest(
165+
LogsBatchQueryRequest(
166166
query,
167167
workspace_id= os.environ['LOG_WORKSPACE_ID'],
168168
additional_workspaces=[os.environ['SECONDARY_WORKSPACE_ID']]

‎sdk/monitor/azure-monitor-query/tests/test_logs_timespans.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
from azure.identity import ClientSecretCredential
88
from azure.core.exceptions import HttpResponseError
9-
from azure.monitor.query import LogsQueryClient, LogsQueryRequest
9+
from azure.monitor.query import LogsQueryClient, LogsBatchQueryRequest
1010

1111
from azure.monitor.query._helpers import construct_iso8601
1212

0 commit comments

Comments
 (0)