Index
All Classes and Interfaces|All Packages
A
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Adds a custom Http pipeline policy.
- AggregationType - Enum in com.azure.monitor.query.metrics.models
-
Defines values for AggregationType.
- Asynchronous clients - Search tag in Overview
- Section
- audience(MetricsAudience) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets the metrics audience.
- Authenticate using Microsoft Entra ID - Search tag in Overview
- Section
- AVERAGE - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value Average.
- AZURE_CHINA - Static variable in class com.azure.monitor.query.metrics.models.MetricsAudience
-
Static value for Azure China.
- AZURE_PUBLIC_CLOUD - Static variable in class com.azure.monitor.query.metrics.models.MetricsAudience
-
Static value for Azure Public Cloud.
- AZURE_US_GOVERNMENT - Static variable in class com.azure.monitor.query.metrics.models.MetricsAudience
-
Static value for Azure US Government.
- Azure Monitor Metrics Query client library for Java - Search tag in Overview
- Section
B
- BITS_PER_SECOND - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Rate unit of binary digits per second.
- buildAsyncClient() - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Creates an asynchronous client with the configured options in this builder.
- buildClient() - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Creates a synchronous client with the configured options in this builder.
- BYTE_SECONDS - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of data transfer or storage.
- BYTES - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of memory in bytes.
- BYTES_PER_SECOND - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Rate unit of memory in bytes per second.
C
- clientOptions(ClientOptions) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Set the
ClientOptions
used for creating the client. - com.azure.monitor.query.metrics - package com.azure.monitor.query.metrics
-
Package containing the classes for MetricsQuery.
- com.azure.monitor.query.metrics.models - package com.azure.monitor.query.metrics.models
-
Package containing the data models for Metrics.
- configuration(Configuration) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The configuration store that is used during construction of the service client.
- Configure client for Azure sovereign cloud - Search tag in Overview
- Section
- Contributing - Search tag in Overview
- Section
- CORES - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of processing power.
- COUNT - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value Count.
- COUNT - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of raw quantity.
- COUNT_PER_SECOND - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Rate unit of raw quantity per second.
- credential(TokenCredential) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The TokenCredential used for authentication.
E
- endpoint(String) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets the metrics endpoint.
- equals(Object) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
- Examples - Search tag in Overview
- Section
- Execute the query - Search tag in Overview
- Section
F
- fromJson(JsonReader) - Static method in class com.azure.monitor.query.metrics.models.MetricValue
-
Reads an instance of MetricValue from the JsonReader.
- fromString(String) - Static method in enum com.azure.monitor.query.metrics.models.AggregationType
-
Parses a serialized value to a AggregationType instance.
- fromString(String) - Static method in class com.azure.monitor.query.metrics.models.MetricsAudience
-
Creates an instance of MetricsAudience.
- fromString(String) - Static method in class com.azure.monitor.query.metrics.models.MetricUnit
-
Creates or finds a MetricUnit from its string representation.
G
- getAggregations() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the list of aggregations that should be applied to the metrics data.
- getAverage() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the average property: The average value in the time range.
- Get average and count metrics - Search tag in Overview
- Section
- getCost() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the integer value representing the cost of the query, for data case.
- getCount() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the count property: The number of samples in the time range.
- getDescription() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the description of the metric.
- getEndTime() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
-
Returns the end time of this
MetricsQueryTimeInterval
instance. - getError() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the error message encountered querying this specific metric.
- getFilter() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the filter to be applied to the query.
- getGranularity() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the interval (window size) for which the metric data was returned in.
- getGranularity() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the interval (window size) for which the metric data was returned in.
- getId() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the metrics id.
- getLatest() - Static method in enum com.azure.monitor.query.metrics.MetricsServiceVersion
-
Gets the latest service version supported by this client library.
- getMaximum() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the maximum property: The greatest value in the time range.
- getMetadata() - Method in class com.azure.monitor.query.metrics.models.TimeSeriesElement
-
Returns the metadata values if filter is specified in the request.
- getMetricByName(String) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the metric result for the
metricName
. - getMetricName() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the name of the metrics.
- getMetrics() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the value of the collection.
- getMetricsQueryResults() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesResult
-
Get the metrics results for individual queries.
- getMinimum() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the minimum property: The least value in the time range.
- getNamespace() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the namespace of the metrics being queried
- getOrderBy() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the order in which the query results should be ordered.
- getResourceId() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the resource id of the resource this metrics result belongs to.
- getResourceRegion() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the region of the resource being queried for metrics.
- getResourceType() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the resource type of the metric resource.
- getRollupBy() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Gets the dimension name(s) to rollup results by.
- getStartTime() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
-
Returns the start time of this
MetricsQueryTimeInterval
instance. - getTimeInterval() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the time span for which the metrics data is queried.
- getTimeInterval() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Returns the time interval for which the data was retrieved.
- getTimeSeries() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the time series returned when a data query is performed.
- getTimeStamp() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the timeStamp property: The timestamp for the metric value in ISO 8601 format.
- Getting started - Search tag in Overview
- Section
- getTop() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Returns the number of top metrics values to query.
- getTotal() - Method in class com.azure.monitor.query.metrics.models.MetricValue
-
Get the total property: The sum of all of the values in the time range.
- getUnit() - Method in class com.azure.monitor.query.metrics.models.MetricResult
-
Returns the metrics unit of the metrics.
- getValues() - Method in class com.azure.monitor.query.metrics.models.TimeSeriesElement
-
Returns a list of data points representing the metric values.
- getVersion() - Method in enum com.azure.monitor.query.metrics.MetricsServiceVersion
H
- Handle metrics query response - Search tag in Overview
- Section
- hashCode() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
- httpClient(HttpClient) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The HTTP client used to send the request.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The logging configuration for HTTP requests and responses.
I
- Include direct dependency - Search tag in Overview
- Section
- Include the BOM file - Search tag in Overview
- Section
- Include the package - Search tag in Overview
- Section
K
- Key concepts - Search tag in Overview
- Section
M
- MAXIMUM - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value Maximum.
- MetricResult - Class in com.azure.monitor.query.metrics.models
-
The metrics result of a query.
- MetricResult(String, String, MetricUnit, String, List<TimeSeriesElement>, String, ResponseError) - Constructor for class com.azure.monitor.query.metrics.models.MetricResult
-
Creates an instance of the result data of a query.
- MetricsAsyncClient - Class in com.azure.monitor.query.metrics
-
This class provides an asynchronous client that contains all the query operations that use batch requests to retrieve metrics for multiple resources.
- MetricsAudience - Class in com.azure.monitor.query.metrics.models
-
The audience indicating the authorization scope of metrics query clients.
- MetricsAudience() - Constructor for class com.azure.monitor.query.metrics.models.MetricsAudience
-
Deprecated.Creates an instance of MetricsAudience.
- MetricsClient - Class in com.azure.monitor.query.metrics
-
This class provides synchronous client that contains all the query operations that use batch requests to retrieve metrics for multiple resources.
- MetricsClientBuilder - Class in com.azure.monitor.query.metrics
-
Fluent builder for creating instances of
MetricsClient
andMetricsAsyncClient
. - MetricsClientBuilder() - Constructor for class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Creates an instance of MetricsClientBuilder.
- Metrics data structure - Search tag in Overview
- Section
- Metrics query - Search tag in Overview
- Section
- Metrics query resources - Search tag in Overview
- Section
- MetricsQueryResourcesOptions - Class in com.azure.monitor.query.metrics.models
-
The model class to configure the metrics query options.
- MetricsQueryResourcesOptions() - Constructor for class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Creates an instance of MetricsQueryResourcesOptions.
- MetricsQueryResourcesResult - Class in com.azure.monitor.query.metrics.models
-
The result of a metrics query.
- MetricsQueryResourcesResult(List<MetricsQueryResult>) - Constructor for class com.azure.monitor.query.metrics.models.MetricsQueryResourcesResult
-
Creates an instance of MetricsBatchResult.
- MetricsQueryResult - Class in com.azure.monitor.query.metrics.models
-
The response to a metrics query.
- MetricsQueryResult(Integer, MetricsQueryTimeInterval, Duration, String, String, List<MetricResult>) - Constructor for class com.azure.monitor.query.metrics.models.MetricsQueryResult
-
Creates an instance of the response to a metrics query.
- MetricsQueryTimeInterval - Class in com.azure.monitor.query.metrics.models
-
Class to represent a time interval.
- MetricsQueryTimeInterval(OffsetDateTime, OffsetDateTime) - Constructor for class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
-
Creates an instance of
MetricsQueryTimeInterval
using the start and endOffsetDateTimes
. - MetricsServiceVersion - Enum in com.azure.monitor.query.metrics
-
Service version of MetricsClient.
- MetricUnit - Class in com.azure.monitor.query.metrics.models
-
The unit of the metric.
- MetricUnit() - Constructor for class com.azure.monitor.query.metrics.models.MetricUnit
-
Deprecated.Use the
MetricUnit.fromString(String)
factory method. - MetricValue - Class in com.azure.monitor.query.metrics.models
-
Represents a metric value.
- MILLI_CORES - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of processing power in 1/1000th of a CPU core.
- MILLI_SECONDS - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of time in 1/1000th of a second.
- MINIMUM - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value Minimum.
N
- NANO_CORES - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of processing power in one billionth of a CPU core.
- Next steps - Search tag in Overview
- Section
- NONE - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value None.
P
- parse(String) - Static method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
-
This method takes an ISO 8601 formatted time interval string and returns an instance of
MetricsQueryTimeInterval
. - PERCENT - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Percentage unit.
- pipeline(HttpPipeline) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The HTTP pipeline to send requests through.
- Prerequisites - Search tag in Overview
- Section
Q
- queryResources(List<String>, List<String>, String) - Method in class com.azure.monitor.query.metrics.MetricsAsyncClient
-
Returns all the Azure Monitor metrics requested for the batch of resources.
- queryResources(List<String>, List<String>, String) - Method in class com.azure.monitor.query.metrics.MetricsClient
-
Returns all the Azure Monitor metrics requested for the batch of resources.
- queryResourcesWithResponse(List<String>, List<String>, String, MetricsQueryResourcesOptions) - Method in class com.azure.monitor.query.metrics.MetricsAsyncClient
-
Returns all the Azure Monitor metrics requested for the batch of resources.
- queryResourcesWithResponse(List<String>, List<String>, String, MetricsQueryResourcesOptions, Context) - Method in class com.azure.monitor.query.metrics.MetricsClient
-
Returns all the Azure Monitor metrics requested for the batch of resources.
R
- retryOptions(RetryOptions) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets the
RetryOptions
used for creating the client. - retryPolicy(RetryPolicy) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
S
- SECONDS - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
Unit of time in seconds.
- serviceVersion(MetricsServiceVersion) - Method in class com.azure.monitor.query.metrics.MetricsClientBuilder
-
The service version to use when creating the client.
- setAggregations(List<AggregationType>) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the list of aggregations that should be applied to the metrics data.
- setFilter(String) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the filter to be applied to the query.
- setGranularity(Duration) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the interval (window size) for which the metric data was returned in.
- setOrderBy(String) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the order in which the query results should be ordered.
- setRollupBy(String) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the dimension name(s) to rollup results by.
- setTimeInterval(MetricsQueryTimeInterval) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the time span for which the metrics data is queried.
- setTop(Integer) - Method in class com.azure.monitor.query.metrics.models.MetricsQueryResourcesOptions
-
Sets the number of top metrics values to query.
- Synchronous clients - Search tag in Overview
- Section
T
- TimeSeriesElement - Class in com.azure.monitor.query.metrics.models
-
A time series result type.
- TimeSeriesElement(List<MetricValue>, Map<String, String>) - Constructor for class com.azure.monitor.query.metrics.models.TimeSeriesElement
-
Creates an instance of
TimeSeriesElement
with a list of data points representing the metric values. - toJson(JsonWriter) - Method in class com.azure.monitor.query.metrics.models.MetricValue
- toString() - Method in enum com.azure.monitor.query.metrics.models.AggregationType
- toString() - Method in class com.azure.monitor.query.metrics.models.MetricsQueryTimeInterval
- TOTAL - Enum constant in enum com.azure.monitor.query.metrics.models.AggregationType
-
Enum value Total.
- Troubleshooting - Search tag in Overview
- Section
U
- UNSPECIFIED - Static variable in class com.azure.monitor.query.metrics.models.MetricUnit
-
No specified unit.
V
- V2024_02_01 - Enum constant in enum com.azure.monitor.query.metrics.MetricsServiceVersion
-
Enum value 2024-02-01.
- valueOf(String) - Static method in enum com.azure.monitor.query.metrics.MetricsServiceVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.monitor.query.metrics.models.AggregationType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.monitor.query.metrics.MetricsServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.monitor.query.metrics.models.AggregationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.monitor.query.metrics.models.MetricsAudience
-
Get the collection of MetricsAudience values.
- values() - Static method in class com.azure.monitor.query.metrics.models.MetricUnit
-
Gets known MetricUnit values.
All Classes and Interfaces|All Packages