Skip to content

Commit 6bfd718

Browse files
authored
Azure Monitor Query: Update documentation (Azure#39376)
* Azure Monitor Query: Update documentation * update readme
1 parent aa41c08 commit 6bfd718

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ MetricsQueryClient metricsQueryClient = new MetricsQueryClientBuilder()
108108
.buildClient();
109109
```
110110

111-
```java readme-sample-createMetricsBatchQueryClient
112-
MetricsClient metricsBatchQueryClient = new MetricsClientBuilder()
111+
```java readme-sample-createMetricsClient
112+
MetricsClient metricsClient = new MetricsClientBuilder()
113113
.credential(new DefaultAzureCredentialBuilder().build())
114114
.endpoint("{endpoint}")
115115
.buildClient();
@@ -129,7 +129,7 @@ MetricsQueryAsyncClient metricsQueryAsyncClient = new MetricsQueryClientBuilder(
129129
.buildAsyncClient();
130130
```
131131

132-
```java readme-sample-createMetricsBatchQueryAsyncClient
132+
```java readme-sample-createMetricsAsyncClient
133133
MetricsAsyncClient metricsAsyncClient = new MetricsClientBuilder()
134134
.credential(new DefaultAzureCredentialBuilder().build())
135135
.endpoint("{endpoint}")
@@ -196,8 +196,8 @@ Each set of metric values is a time series with the following characteristics:
196196
- [Handle metrics query response](#handle-metrics-query-response)
197197
- [Get average and count metrics](#get-average-and-count-metrics)
198198
- [Create a metrics client for non-public Azure clouds](#configure-clients-for-non-public-azure-clouds)
199-
- [Metrics batch query](#metrics-batch-query)
200-
- [Handle metrics batch query response](#handle-metrics-batch-query-response)
199+
- [Metrics query resources](#metrics-query-resources)
200+
- [Handle metrics query resources response](#handle-metrics-query-resources-response)
201201
### Logs query
202202

203203
```java readme-sample-logsquery
@@ -529,17 +529,17 @@ for (MetricResult metric : metricsQueryResult.getMetrics()) {
529529
}
530530
```
531531

532-
### Metrics batch query
532+
### Metrics query resources
533533

534-
#### Handle metrics batch query response
534+
#### Handle metrics query resources response
535535

536-
```java readme-sample-metricsquerybatch
537-
MetricsClient metricsBatchQueryClient = new MetricsClientBuilder()
536+
```java readme-sample-metricsquerymultipleresources
537+
MetricsClient metricsClient = new MetricsClientBuilder()
538538
.credential(new DefaultAzureCredentialBuilder().build())
539539
.endpoint("{endpoint}")
540540
.buildClient();
541541

542-
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsBatchQueryClient.queryResources(
542+
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsClient.queryResources(
543543
Arrays.asList("{resourceId1}", "{resourceId2}"),
544544
Arrays.asList("{metric1}", "{metric2}"),
545545
"{metricNamespace}");

sdk/monitor/azure-monitor-query/src/main/java/com/azure/monitor/query/MetricsClientBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public final class MetricsClientBuilder implements EndpointTrait<MetricsClientBu
3434
public MetricsClientBuilder() { }
3535

3636
/**
37-
* Sets the metrics batch query endpoint.
37+
* Sets the metrics endpoint.
3838
* @param endpoint the endpoint.
3939
* @return the {@link MetricsClientBuilder}.
4040
*/
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
/**
1515
* Sample demonstrates how to synchronously query metrics for multiple resources.
1616
*/
17-
public class MetricsBatchQuerySample {
17+
public class MetricsSample {
1818
/**
1919
* The main method to execute the sample.
2020
*
2121
* @param args Unused. Arguments to the program.
2222
*/
2323
public static void main(String[] args) {
24-
MetricsClient metricsBatchQueryClient = new MetricsClientBuilder()
24+
MetricsClient metricsClient = new MetricsClientBuilder()
2525
.credential(new DefaultAzureCredentialBuilder().build())
2626
.endpoint("https://westus2.monitoring.azure.com")
2727
.buildClient();
2828

29-
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsBatchQueryClient.queryResources(
29+
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsClient.queryResources(
3030
Arrays.asList("{resourceId1}", "{resourceId2}"),
3131
Arrays.asList("{metric1}", "{metric2}"),
3232
"{metricNamespace}");

sdk/monitor/azure-monitor-query/src/samples/java/com/azure/monitor/query/ReadmeSamples.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public void createLogsClients() {
5858
/**
5959
* Sample for creating sync and async clients for querying metrics.
6060
*/
61-
public void createMetricsClients() {
61+
public void createMetricsQueryClients() {
6262
// BEGIN: readme-sample-createMetricsQueryClient
6363
MetricsQueryClient metricsQueryClient = new MetricsQueryClientBuilder()
6464
.credential(new DefaultAzureCredentialBuilder().build())
@@ -72,20 +72,20 @@ public void createMetricsClients() {
7272
// END: readme-sample-createMetricsQueryAsyncClient
7373
}
7474

75-
public void createMetricsBatchClients() {
76-
// BEGIN: readme-sample-createMetricsBatchQueryClient
77-
MetricsClient metricsBatchQueryClient = new MetricsClientBuilder()
75+
public void createMetricsClients() {
76+
// BEGIN: readme-sample-createMetricsClient
77+
MetricsClient metricsClient = new MetricsClientBuilder()
7878
.credential(new DefaultAzureCredentialBuilder().build())
7979
.endpoint("{endpoint}")
8080
.buildClient();
81-
// END: readme-sample-createMetricsBatchQueryClient
81+
// END: readme-sample-createMetricsClient
8282

83-
// BEGIN: readme-sample-createMetricsBatchQueryAsyncClient
83+
// BEGIN: readme-sample-createMetricsAsyncClient
8484
MetricsAsyncClient metricsAsyncClient = new MetricsClientBuilder()
8585
.credential(new DefaultAzureCredentialBuilder().build())
8686
.endpoint("{endpoint}")
8787
.buildAsyncClient();
88-
// END: readme-sample-createMetricsBatchQueryAsyncClient
88+
// END: readme-sample-createMetricsAsyncClient
8989
}
9090

9191
/**
@@ -446,14 +446,14 @@ public void createMetricsClientWithSovereignCloud() {
446446
/**
447447
* Sample to demonstrate querying Azure Monitor for metrics.
448448
*/
449-
public void getMetricsBatch() {
450-
// BEGIN: readme-sample-metricsquerybatch
451-
MetricsClient metricsBatchQueryClient = new MetricsClientBuilder()
449+
public void getMetricsForMultipleResources() {
450+
// BEGIN: readme-sample-metricsquerymultipleresources
451+
MetricsClient metricsClient = new MetricsClientBuilder()
452452
.credential(new DefaultAzureCredentialBuilder().build())
453453
.endpoint("{endpoint}")
454454
.buildClient();
455455

456-
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsBatchQueryClient.queryResources(
456+
MetricsQueryResourcesResult metricsQueryResourcesResult = metricsClient.queryResources(
457457
Arrays.asList("{resourceId1}", "{resourceId2}"),
458458
Arrays.asList("{metric1}", "{metric2}"),
459459
"{metricNamespace}");
@@ -476,6 +476,6 @@ public void getMetricsBatch() {
476476
+ "; Average = " + mv.getAverage()));
477477
});
478478
}
479-
// END: readme-sample-metricsquerybatch
479+
// END: readme-sample-metricsquerymultipleresources
480480
}
481481
}

0 commit comments

Comments
 (0)