Skip to content

MetricQueryBuilder🔗

Constructor🔗

func NewMetricQueryBuilder() *MetricQueryBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *MetricQueryBuilder) Build() (MetricQuery, error)

Aggregation🔗

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

func (builder *MetricQueryBuilder) Aggregation(aggregation string) *MetricQueryBuilder

Alias🔗

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

func (builder *MetricQueryBuilder) Alias(alias string) *MetricQueryBuilder

AllowedTimeGrainsMs🔗

Time grains that are supported by the metric.

func (builder *MetricQueryBuilder) AllowedTimeGrainsMs(allowedTimeGrainsMs []int64) *MetricQueryBuilder

CustomNamespace🔗

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

func (builder *MetricQueryBuilder) CustomNamespace(customNamespace string) *MetricQueryBuilder

Dimension🔗

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

func (builder *MetricQueryBuilder) Dimension(dimension string) *MetricQueryBuilder

DimensionFilter🔗

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

func (builder *MetricQueryBuilder) DimensionFilter(dimensionFilter string) *MetricQueryBuilder

DimensionFilters🔗

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

func (builder *MetricQueryBuilder) DimensionFilters(dimensionFilters []cog.Builder[azuremonitor.MetricDimension]) *MetricQueryBuilder

MetricDefinition🔗

@deprecated Use metricNamespace instead

func (builder *MetricQueryBuilder) MetricDefinition(metricDefinition string) *MetricQueryBuilder

MetricName🔗

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

func (builder *MetricQueryBuilder) MetricName(metricName string) *MetricQueryBuilder

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.

func (builder *MetricQueryBuilder) MetricNamespace(metricNamespace string) *MetricQueryBuilder

Region🔗

The Azure region containing the resource(s).

func (builder *MetricQueryBuilder) Region(region string) *MetricQueryBuilder

ResourceGroup🔗

@deprecated Use resources instead

func (builder *MetricQueryBuilder) ResourceGroup(resourceGroup string) *MetricQueryBuilder

ResourceName🔗

@deprecated Use resources instead

func (builder *MetricQueryBuilder) ResourceName(resourceName string) *MetricQueryBuilder

ResourceUri🔗

@deprecated Use resourceGroup, resourceName and metricNamespace instead

func (builder *MetricQueryBuilder) ResourceUri(resourceUri string) *MetricQueryBuilder

Resources🔗

Array of resource URIs to be queried.

func (builder *MetricQueryBuilder) Resources(resources []cog.Builder[azuremonitor.MonitorResource]) *MetricQueryBuilder

TimeGrain🔗

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

func (builder *MetricQueryBuilder) TimeGrain(timeGrain string) *MetricQueryBuilder

TimeGrainUnit🔗

@deprecated

func (builder *MetricQueryBuilder) TimeGrainUnit(timeGrainUnit string) *MetricQueryBuilder

Top🔗

Maximum number of records to return. Defaults to 10.

func (builder *MetricQueryBuilder) Top(top string) *MetricQueryBuilder

See also🔗