Skip to content

azureMonitor

grafonnet.query.azureMonitor

Subpackages

Index

Fields

fn withAzureLogAnalytics

withAzureLogAnalytics(value)

PARAMETERS:

  • value (object)

Azure Monitor Logs sub-query properties

fn withAzureLogAnalyticsMixin

withAzureLogAnalyticsMixin(value)

PARAMETERS:

  • value (object)

Azure Monitor Logs sub-query properties

fn withAzureMonitor

withAzureMonitor(value)

PARAMETERS:

  • value (object)

Azure Monitor Metrics sub-query properties.

fn withAzureMonitorMixin

withAzureMonitorMixin(value)

PARAMETERS:

  • value (object)

Azure Monitor Metrics sub-query properties.

fn withAzureResourceGraph

withAzureResourceGraph(value)

PARAMETERS:

  • value (object)

Azure Resource Graph sub-query properties.

fn withAzureResourceGraphMixin

withAzureResourceGraphMixin(value)

PARAMETERS:

  • value (object)

Azure Resource Graph sub-query properties.

fn withAzureTraces

withAzureTraces(value)

PARAMETERS:

  • value (object)

Application Insights Traces sub-query properties

fn withAzureTracesMixin

withAzureTracesMixin(value)

PARAMETERS:

  • value (object)

Application Insights Traces sub-query properties

fn withDatasource

withDatasource(value)

PARAMETERS:

  • value (string)

Set the datasource for this query.

fn withGrafanaTemplateVariableFn

withGrafanaTemplateVariableFn(value)

PARAMETERS:

  • value (object)

@deprecated Legacy template variable support.

fn withGrafanaTemplateVariableFnMixin

withGrafanaTemplateVariableFnMixin(value)

PARAMETERS:

  • value (object)

@deprecated Legacy template variable support.

fn withHide

withHide(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

fn withNamespace

withNamespace(value)

PARAMETERS:

  • value (string)

fn withQuery

withQuery(value)

PARAMETERS:

  • value (string)

Used only for exemplar queries from Prometheus

fn withQueryType

withQueryType(value)

PARAMETERS:

  • value (string)

Specify the query flavor TODO make this required and give it a default

fn withRefId

withRefId(value)

PARAMETERS:

  • value (string)

A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful.

fn withRegion

withRegion(value)

PARAMETERS:

  • value (string)

fn withResource

withResource(value)

PARAMETERS:

  • value (string)

fn withResourceGroup

withResourceGroup(value)

PARAMETERS:

  • value (string)

Template variables params. These exist for backwards compatiblity with legacy template variables.

fn withSubscription

withSubscription(value)

PARAMETERS:

  • value (string)

Azure subscription containing the resource(s) to be queried.

fn withSubscriptions

withSubscriptions(value)

PARAMETERS:

  • value (array)

Subscriptions to be queried via Azure Resource Graph.

fn withSubscriptionsMixin

withSubscriptionsMixin(value)

PARAMETERS:

  • value (array)

Subscriptions to be queried via Azure Resource Graph.

obj azureLogAnalytics

fn azureLogAnalytics.withBasicLogsQuery

azureLogAnalytics.withBasicLogsQuery(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

If set to true the query will be run as a basic logs query

fn azureLogAnalytics.withDashboardTime

azureLogAnalytics.withDashboardTime(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false.

fn azureLogAnalytics.withIntersectTime

azureLogAnalytics.withIntersectTime(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

@deprecated Use dashboardTime instead

fn azureLogAnalytics.withQuery

azureLogAnalytics.withQuery(value)

PARAMETERS:

  • value (string)

KQL query to be executed.

fn azureLogAnalytics.withResource

azureLogAnalytics.withResource(value)

PARAMETERS:

  • value (string)

@deprecated Use resources instead

fn azureLogAnalytics.withResources

azureLogAnalytics.withResources(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureLogAnalytics.withResourcesMixin

azureLogAnalytics.withResourcesMixin(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureLogAnalytics.withResultFormat

azureLogAnalytics.withResultFormat(value)

PARAMETERS:

  • value (string)
    • valid values: "table", "time_series", "trace", "logs"

Specifies the format results should be returned as.

fn azureLogAnalytics.withTimeColumn

azureLogAnalytics.withTimeColumn(value)

PARAMETERS:

  • value (string)

If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated

fn azureLogAnalytics.withWorkspace

azureLogAnalytics.withWorkspace(value)

PARAMETERS:

  • value (string)

Workspace ID. This was removed in Grafana 8, but remains for backwards compat.

obj azureMonitor

fn azureMonitor.withAggregation

azureMonitor.withAggregation(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withAlias

azureMonitor.withAlias(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withAllowedTimeGrainsMs

azureMonitor.withAllowedTimeGrainsMs(value)

PARAMETERS:

  • value (array)

Time grains that are supported by the metric.

fn azureMonitor.withAllowedTimeGrainsMsMixin

azureMonitor.withAllowedTimeGrainsMsMixin(value)

PARAMETERS:

  • value (array)

Time grains that are supported by the metric.

fn azureMonitor.withCustomNamespace

azureMonitor.withCustomNamespace(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withDimension

azureMonitor.withDimension(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withDimensionFilter

azureMonitor.withDimensionFilter(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withDimensionFilters

azureMonitor.withDimensionFilters(value)

PARAMETERS:

  • value (array)

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

fn azureMonitor.withDimensionFiltersMixin

azureMonitor.withDimensionFiltersMixin(value)

PARAMETERS:

  • value (array)

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

fn azureMonitor.withMetricDefinition

azureMonitor.withMetricDefinition(value)

PARAMETERS:

  • value (string)

@deprecated Use metricNamespace instead

fn azureMonitor.withMetricName

azureMonitor.withMetricName(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withMetricNamespace

azureMonitor.withMetricNamespace(value)

PARAMETERS:

  • value (string)

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.

fn azureMonitor.withRegion

azureMonitor.withRegion(value)

PARAMETERS:

  • value (string)

The Azure region containing the resource(s).

fn azureMonitor.withResourceGroup

azureMonitor.withResourceGroup(value)

PARAMETERS:

  • value (string)

@deprecated Use resources instead

fn azureMonitor.withResourceName

azureMonitor.withResourceName(value)

PARAMETERS:

  • value (string)

@deprecated Use resources instead

fn azureMonitor.withResourceUri

azureMonitor.withResourceUri(value)

PARAMETERS:

  • value (string)

@deprecated Use resourceGroup, resourceName and metricNamespace instead

fn azureMonitor.withResources

azureMonitor.withResources(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureMonitor.withResourcesMixin

azureMonitor.withResourcesMixin(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureMonitor.withTimeGrain

azureMonitor.withTimeGrain(value)

PARAMETERS:

  • value (string)

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

fn azureMonitor.withTimeGrainUnit

azureMonitor.withTimeGrainUnit(value)

PARAMETERS:

  • value (string)

@deprecated

fn azureMonitor.withTop

azureMonitor.withTop(value)

PARAMETERS:

  • value (string)

Maximum number of records to return. Defaults to 10.

obj azureResourceGraph

fn azureResourceGraph.withQuery

azureResourceGraph.withQuery(value)

PARAMETERS:

  • value (string)

Azure Resource Graph KQL query to be executed.

fn azureResourceGraph.withResultFormat

azureResourceGraph.withResultFormat(value)

PARAMETERS:

  • value (string)

Specifies the format results should be returned as. Defaults to table.

obj azureTraces

fn azureTraces.withFilters

azureTraces.withFilters(value)

PARAMETERS:

  • value (array)

Filters for property values.

fn azureTraces.withFiltersMixin

azureTraces.withFiltersMixin(value)

PARAMETERS:

  • value (array)

Filters for property values.

fn azureTraces.withOperationId

azureTraces.withOperationId(value)

PARAMETERS:

  • value (string)

Operation ID. Used only for Traces queries.

fn azureTraces.withQuery

azureTraces.withQuery(value)

PARAMETERS:

  • value (string)

KQL query to be executed.

fn azureTraces.withResources

azureTraces.withResources(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureTraces.withResourcesMixin

azureTraces.withResourcesMixin(value)

PARAMETERS:

  • value (array)

Array of resource URIs to be queried.

fn azureTraces.withResultFormat

azureTraces.withResultFormat(value)

PARAMETERS:

  • value (string)
    • valid values: "table", "time_series", "trace", "logs"

Specifies the format results should be returned as.

fn azureTraces.withTraceTypes

azureTraces.withTraceTypes(value)

PARAMETERS:

  • value (array)

Types of events to filter by.

fn azureTraces.withTraceTypesMixin

azureTraces.withTraceTypesMixin(value)

PARAMETERS:

  • value (array)

Types of events to filter by.

obj datasource

fn datasource.withType

datasource.withType(value)

PARAMETERS:

  • value (string)

The plugin type-id

fn datasource.withUid

datasource.withUid(value)

PARAMETERS:

  • value (string)

Specific datasource instance

obj grafanaTemplateVariableFn

fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery

grafanaTemplateVariableFn.withAppInsightsGroupByQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin

grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery

grafanaTemplateVariableFn.withAppInsightsMetricNameQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin

grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withMetricDefinitionsQuery

grafanaTemplateVariableFn.withMetricDefinitionsQuery(value)

PARAMETERS:

  • value (object)

@deprecated Use MetricNamespaceQuery instead

fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin

grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin(value)

PARAMETERS:

  • value (object)

@deprecated Use MetricNamespaceQuery instead

fn grafanaTemplateVariableFn.withMetricNamesQuery

grafanaTemplateVariableFn.withMetricNamesQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withMetricNamesQueryMixin

grafanaTemplateVariableFn.withMetricNamesQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withMetricNamespaceQuery

grafanaTemplateVariableFn.withMetricNamespaceQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin

grafanaTemplateVariableFn.withMetricNamespaceQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withResourceGroupsQuery

grafanaTemplateVariableFn.withResourceGroupsQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin

grafanaTemplateVariableFn.withResourceGroupsQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withResourceNamesQuery

grafanaTemplateVariableFn.withResourceNamesQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withResourceNamesQueryMixin

grafanaTemplateVariableFn.withResourceNamesQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withSubscriptionsQuery

grafanaTemplateVariableFn.withSubscriptionsQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin

grafanaTemplateVariableFn.withSubscriptionsQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withUnknownQuery

grafanaTemplateVariableFn.withUnknownQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withUnknownQueryMixin

grafanaTemplateVariableFn.withUnknownQueryMixin(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withWorkspacesQuery

grafanaTemplateVariableFn.withWorkspacesQuery(value)

PARAMETERS:

  • value (object)

fn grafanaTemplateVariableFn.withWorkspacesQueryMixin

grafanaTemplateVariableFn.withWorkspacesQueryMixin(value)

PARAMETERS:

  • value (object)

obj grafanaTemplateVariableFn.AppInsightsGroupByQuery

fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind
grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind()
fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName
grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery
grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery

fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind
grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind()
fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery
grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.MetricDefinitionsQuery

fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind
grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind()
fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace
grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery
grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup
grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName
grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription
grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.MetricNamesQuery

fn grafanaTemplateVariableFn.MetricNamesQuery.withKind
grafanaTemplateVariableFn.MetricNamesQuery.withKind()
fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace
grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery
grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup
grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName
grafanaTemplateVariableFn.MetricNamesQuery.withResourceName(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription
grafanaTemplateVariableFn.MetricNamesQuery.withSubscription(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.MetricNamespaceQuery

fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind
grafanaTemplateVariableFn.MetricNamespaceQuery.withKind()
fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace
grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery
grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup
grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName
grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription
grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.ResourceGroupsQuery

fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind
grafanaTemplateVariableFn.ResourceGroupsQuery.withKind()
fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery
grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription
grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.ResourceNamesQuery

fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind
grafanaTemplateVariableFn.ResourceNamesQuery.withKind()
fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace
grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery
grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup
grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription
grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.SubscriptionsQuery

fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind
grafanaTemplateVariableFn.SubscriptionsQuery.withKind()
fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery
grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.UnknownQuery

fn grafanaTemplateVariableFn.UnknownQuery.withKind
grafanaTemplateVariableFn.UnknownQuery.withKind()
fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery
grafanaTemplateVariableFn.UnknownQuery.withRawQuery(value)

PARAMETERS:

  • value (string)

obj grafanaTemplateVariableFn.WorkspacesQuery

fn grafanaTemplateVariableFn.WorkspacesQuery.withKind
grafanaTemplateVariableFn.WorkspacesQuery.withKind()
fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery
grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery(value)

PARAMETERS:

  • value (string)
fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription
grafanaTemplateVariableFn.WorkspacesQuery.withSubscription(value)

PARAMETERS:

  • value (string)