Query
Query metrics from Azure Monitor.

Query metrics from Azure Monitor.

yaml
type: "io.kestra.plugin.azure.monitoring.Query"

Examples

Query CPU utilization from Azure Monitor for multiple VMs

yaml
id: "query"
type: "io.kestra.plugin.azure.monitoring.Query"
id: azure_monitor_query
namespace: company.team
tasks:
  - id: query
    type: io.kestra.plugin.azure.monitoring.Query
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
    resourceIds:
      - "/subscriptions/xxx/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/vm1"
      - "/subscriptions/xxx/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/vm2"
    metricNames:
      - "Percentage CPU"
    metricsNamespace: "Microsoft.Compute/virtualMachines"
    window: PT5M
    aggregations:
      - "Average"
      - "Maximum"

Properties

endpoint*string

Azure Monitor Metrics regional endpoint

Must be the regional endpoint (e.g. https://westeurope.metrics.monitor.azure.com)

metricNames*array

SubTypestring

List of metric names to query

metricsNamespace*string

Metrics namespace

The namespace of the metrics, e.g., 'Microsoft.Compute/virtualMachines'

resourceIds*array

SubTypestring

List of Azure Resource IDs to query metrics from

tenantId*string

Tenant ID

aggregationsarray

SubTypestring

Aggregation types

List of aggregation types: Average, Total, Maximum, Minimum, Count

clientIdstring

Client ID

Client ID of the Azure service principal. If you don't have a service principal, refer to create a service principal with Azure CLI.

clientSecretstring

Client Secret

Service principal client secret. The tenantId, clientId and clientSecret of the service principal are required for this credential to acquire an access token.

filterstring

Filter expression to apply to the query

intervalstring

Formatduration

Time grain for data aggregation

ISO 8601 duration format, e.g., PT1M for 1 minute

orderBystring

Order by clause for sorting results

pemCertificatestring

PEM Certificate

text

Your stored PEM certificate.
The tenantId, clientId and clientCertificate of the service principal are required for this credential to acquire an access token.

rollupBystring

Dimension name(s) to roll up results by

For example, 'City' to combine multiple city dimension values into one time series

topintegerstring

Top N time series to return

windowstring

DefaultPT5M

Formatduration

Time window for metrics

Duration looking back from now, e.g., PT5M for 5 minutes

Outputs

datapointsinteger

Total number of datapoints fetched across all metrics and resources

metricsinteger

Total number of unique metrics fetched across all resources

resourcesinteger

Total number of resources queried

resultsarray

SubTypeobject

List of metrics results

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

Apache Pulsar

Tasks that publish, consume, and trigger workflows with Apache Pulsar.

Messaging

Git

Enterprise

Tasks that clone, sync, commit, and push Kestra apps and unit tests with Git repositories.

Tool

Query
Query metrics from Azure Monitor.

More Plugins in this Category

Core Plugins and tasks

Apache Pulsar

Git

1.3.1

QueryQuery metrics from Azure Monitor.

More Plugins in this Category

Core Plugins and tasks

Apache Pulsar

Git

1.3.1

Query
Query metrics from Azure Monitor.