Skip to content

QueryBuilder🔗

Constructor🔗

new QueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

azureLogAnalytics🔗

Azure Monitor Logs sub-query properties.

azureLogAnalytics(azureLogAnalytics: cog.Builder<azuremonitor.AzureLogsQuery>)

azureMonitor🔗

Azure Monitor Metrics sub-query properties.

azureMonitor(azureMonitor: cog.Builder<azuremonitor.AzureMetricQuery>)

azureResourceGraph🔗

Azure Resource Graph sub-query properties.

azureResourceGraph(azureResourceGraph: cog.Builder<azuremonitor.AzureResourceGraphQuery>)

azureTraces🔗

Application Insights Traces sub-query properties.

azureTraces(azureTraces: cog.Builder<azuremonitor.AzureTracesQuery>)

customNamespace🔗

Custom namespace used in template variable queries

customNamespace(customNamespace: string)

datasource🔗

New type for datasource reference

Not creating a new type until we figure out how to handle DS refs for group by, adhoc, and every place that uses DataSourceRef in TS.

datasource(ref: {
    name?: string;
})

grafanaTemplateVariableFn🔗

@deprecated Legacy template variable support.

grafanaTemplateVariableFn(grafanaTemplateVariableFn: cog.Builder<azuremonitor.GrafanaTemplateVariableQuery>)

hide🔗

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

hide(hide: boolean)

namespace🔗

Namespace used in template variable queries

namespace(namespace: string)

query🔗

Used only for exemplar queries from Prometheus

query(query: string)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

queryType(queryType: string)

refId🔗

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(refId: string)

region🔗

Region used in template variable queries

region(region: string)

resource🔗

Resource used in template variable queries

resource(resource: string)

resourceGroup🔗

Resource group used in template variable queries

resourceGroup(resourceGroup: string)

subscription🔗

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

Also used for template variable queries

subscription(subscription: string)

subscriptions🔗

Subscriptions to be queried via Azure Resource Graph.

subscriptions(subscriptions: string[])

version🔗

version(version: string)

See also🔗