AzureMetricQueryBuilder🔗

Constructor🔗

new AzureMetricQueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

aggregation🔗

The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.

aggregation(string $aggregation)

alias🔗

Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.

alias(string $alias)

allowedTimeGrainsMs🔗

Time grains that are supported by the metric.

@param array $allowedTimeGrainsMs

allowedTimeGrainsMs(array $allowedTimeGrainsMs)

customNamespace🔗

Used as the value for the metricNamespace property when it's different from the resource namespace.

customNamespace(string $customNamespace)

dimension🔗

@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration

dimension(string $dimension)

dimensionFilter🔗

@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration

dimensionFilter(string $dimensionFilter)

dimensionFilters🔗

Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Azuremonitor\AzureMetricDimension>> $dimensionFilters

dimensionFilters(array $dimensionFilters)

metricDefinition🔗

@deprecated Use metricNamespace instead

metricDefinition(string $metricDefinition)

metricName🔗

The metric to query data for within the specified metricNamespace. e.g. UsedCapacity

metricName(string $metricName)

metricNamespace🔗

metricNamespace is used as the resource type (or resource namespace).

It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts

Kept the name of the variable as metricNamespace to avoid backward incompatibility issues.

metricNamespace(string $metricNamespace)

region🔗

The Azure region containing the resource(s).

region(string $region)

resourceGroup🔗

@deprecated Use resources instead

resourceGroup(string $resourceGroup)

resourceName🔗

@deprecated Use resources instead

resourceName(string $resourceName)

resourceUri🔗

@deprecated Use resourceGroup, resourceName and metricNamespace instead

resourceUri(string $resourceUri)

resources🔗

Array of resource URIs to be queried.

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Azuremonitor\AzureMonitorResource>> $resources

resources(array $resources)

timeGrain🔗

The granularity of data points to be queried. Defaults to auto.

timeGrain(string $timeGrain)

timeGrainUnit🔗

@deprecated

timeGrainUnit(string $timeGrainUnit)

top🔗

Maximum number of records to return. Defaults to 10.

top(string $top)