Skip to content

MonitorQuery🔗

Definition🔗

export interface MonitorQuery {
    // 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.
    refId: string;
    // If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
    hide?: boolean;
    // Specify the query flavor
    // TODO make this required and give it a default
    queryType?: string;
    // Azure subscription containing the resource(s) to be queried.
    // Also used for template variable queries
    subscription?: string;
    // Subscriptions to be queried via Azure Resource Graph.
    subscriptions?: string[];
    // Azure Monitor Metrics sub-query properties.
    azureMonitor?: azuremonitor.MetricQuery;
    // Azure Monitor Logs sub-query properties.
    azureLogAnalytics?: azuremonitor.LogsQuery;
    // Azure Resource Graph sub-query properties.
    azureResourceGraph?: azuremonitor.ResourceGraphQuery;
    // Application Insights Traces sub-query properties.
    azureTraces?: azuremonitor.TracesQuery;
    // @deprecated Legacy template variable support.
    grafanaTemplateVariableFn?: azuremonitor.GrafanaTemplateVariableQuery;
    // Resource group used in template variable queries
    resourceGroup?: string;
    // Namespace used in template variable queries
    namespace?: string;
    // Resource used in template variable queries
    resource?: string;
    // Region used in template variable queries
    region?: string;
    // Custom namespace used in template variable queries
    customNamespace?: string;
    // For mixed data sources the selected datasource is on the query level.
    // For non mixed scenarios this is undefined.
    // TODO find a better way to do this ^ that's friendly to schema
    // TODO this shouldn't be unknown but DataSourceRef | null
    datasource?: any;
    // Used only for exemplar queries from Prometheus
    query?: string;
    _implementsDataqueryVariant(): void;
}

See also🔗