---
title: Azure compute_vm_scaleset metricset
description: This is the compute_vm_scaleset metricset of the module azure. This metricset allows users to retrieve all metrics from specified virtual machine scalesets...
url: https://www.elastic.co/elastic/docs-builder/docs/2455/reference/beats/metricbeat/metricbeat-metricset-azure-compute_vm_scaleset
applies_to:
  - Elastic Stack: Generally available in 9.0+
---

# Azure compute_vm_scaleset metricset
This is the compute_vm_scaleset metricset of the module azure.
This metricset allows users to retrieve all metrics from specified virtual machine scalesets.

## Metricset-specific configuration notes

<definitions>
  <definition term="refresh_list_interval">
    Resources will be retrieved at each fetch call (`period` interval), this means a number of Azure REST calls will be executed each time. This will be helpful if the azure users will be adding/removing resources that could match the configuration options so they will not added/removed to the list. To reduce on the number of API calls we are executing to retrieve the resources each time, users can configure this setting and make sure the list or resources will not be refreshed as often. This is also beneficial for performance and rate/ cost reasons ([https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits)).
  </definition>
  <definition term="resources">
    This will contain all options for identifying resources and configuring the desired metrics
  </definition>
</definitions>


### Config options to identify resources

<definitions>
  <definition term="resource_id">
    (*[]string*) The fully qualified ID’s of the resource, including the resource name and resource type. Has the format `/subscriptions/{{guid}}/resourceGroups/{{resource-group-name}}/providers/{{resource-provider-namespace}}/{resource-type}/{{resource-name}}`. Should return a list of resources.
  </definition>
  <definition term="resource_group">
    (*[]string*) This option will return all virtual machine scalesets inside the resource group.
  </definition>
</definitions>

If none of the options are entered then all virtual machine scalesets inside the subscription are taken in account. For each metric the primary aggregation assigned will be retrieved. A default non configurable timegrain of 5 min is set so users are advised to configure an interval of 300s or  a multiply of it.

## Fields

For a description of each field in the metricset, see the [exported fields](https://www.elastic.co/elastic/docs-builder/docs/2455/reference/beats/metricbeat/exported-fields-azure) section.
Here is an example document generated by this metricset:
```json
{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "azure": {
        "compute_vm_scaleset": {
            "cpu_credits_consumed": {
                "avg": 0.006999999999999999
            },
            "cpu_credits_remaining": {
                "avg": 84.72
            },
            "os_per_disk_qd": {
                "avg": 0
            },
            "os_per_disk_read_bytes_per_sec": {
                "avg": 0
            },
            "os_per_disk_read_operations_per_sec": {
                "avg": 0
            },
            "os_per_disk_write_bytes_per_sec": {
                "avg": 3846.531
            },
            "os_per_disk_write_operations_per_sec": {
                "avg": 0.5519999999999999
            }
        },
        "namespace": "Microsoft.Compute/virtualMachineScaleSets",
        "resource": {
            "group": "obs-infrastructure",
            "id": "/subscriptions/fd675b6f-b5e5-426e-ac45-d1f876d0ffa6/resourceGroups/obs-infrastructure/providers/Microsoft.Compute/virtualMachineScaleSets/obslinuxvmss",
            "name": "obslinuxvmss",
            "type": "Microsoft.Compute/virtualMachineScaleSets"
        },
        "subscription_id": "fd675b6f-b5e5-426e-ac45-d1f876d0ffa6",
        "timegrain": "PT5M"
    },
    "cloud": {
        "account": {
            "id": "fd675b6f-b5e5-426e-ac45-d1f876d0ffa6"
        },
        "instance": {
            "name": "obslinuxvmss"
        },
        "machine": {
            "type": "Standard_B1ls"
        },
        "provider": "azure",
        "region": "westeurope"
    },
    "event": {
        "dataset": "azure.compute_vm_scaleset",
        "duration": 115000,
        "module": "azure"
    },
    "host": {
        "name": "obslinuxvmss"
    },
    "metricset": {
        "name": "compute_vm_scaleset",
        "period": 10000
    },
    "service": {
        "type": "azure"
    }
}
```