Entities, lookup information, metrics, and API calls for Azure Resource Manager model

Entity list

The Microsoft Azure - Azure API Extractor monitors the following entities in the Azure Resource Manager model:

  • Resource Group
  • Virtual Machine

Entity relationship

The following table describes entity relationship details for the Resource Manager model:

Parent entityChild entityRelationship type

Resource Group - Azure

(rg:azu)

Virtual Machine - Azure

(gm:azu)

RG_CONTAINS_GM

Metric mapping details for the Resource Manager model

Configuration metrics for virtual machines

TrueSight Capacity Optimization metricAzure metric
CPU_NUMnumberOfCores
DISK_NUMmaxDataDiskCount
DISK_SIZEresourceDiskSizeInMB
LOCATION_SITElocation
OS_FAMILYproperties.osDisk.osType
OS_TYPEproperties.storageProfile.imageReference.offer
OS_VERproperties.storageProfile.imageReference.sku
REQUESTED_INSTANCE_TYPEproperties.hardwareProfile.vmSize
TOTAL_REAL_MEMmemoryInMB

Performance metrics for virtual machines

The following metrics are available for any VM when "Boot diagnostics" is enabled. (This option is enabled by default while creating VM.)

TrueSight Capacity Optimization metricAzure metric
CPU_UTIL(Percentage CPU)
DISK_READ_RATE(Disk Read Bytes)/3600
DISK_WRITE_RATE(Disk Write Bytes)/3600
DISK_TRANSFER_RATE(Disk Read Bytes+Disk Write Bytes)/3600
DISK_IO_READ_RATE(Disk Read Operations/Sec)
DISK_IO_WRITE_RATE(Disk Write Operations/Sec)
DISK_IO_RATE(Disk Read Operations/Sec+Disk Write Operations/Sec)
NET_OUT_BYTE_RATE(Network Out)/3600
NET_IN_BYTE_RATE(Network In)/3600
NET_BYTE_RATE(Network In+Network Out)/3600

Performance metrics for Linux virtual machines 

The following metrics are available for a Linux VM when the "Guest OS diagnostics" option is enabled in Azure. This option is by default disabled when you create the VM.

TrueSight Capacity Optimization metricAzure metric
CPU_UTIL_GUEST\Processor\PercentProcessorTime
CPU_UTIL_IDLE\Processor\PercentIdleTime
CPU_UTIL_USER\Processor\PercentUserTime
CPU_UTIL_SYSTEM\Processor\PercentPrivilegedTime
CPU_UTIL_WAIT\Processor\PercentIOWaitTime
MEM_FREE\Memory\AvailableMemory
MEM_CONSUMED\Memory\UsedMemory
MEM_UTIL\Memory\PercentUsedMemory
MEM_UTIL_CACHED\Memory\PercentUsedByCache
MEM_PAGE_RATE\Memory\PagesPerSec
MEM_PAGE_IN_RATE\Memory\PagesReadPerSec
MEM_PAGE_OUT_RATE\Memory\PagesWrittenPerSec
SWAP_SPACE_FREE\Memory\AvailableSwap
SWAP_SPACE_USED\Memory\UsedSwap
SWAP_SPACE_UTIL\Memory\PercentUsedSwap
DISK_IO_RATE_GUEST\PhysicalDisk\TransfersPerSecond
DISK_IO_READ_RATE_GUEST\PhysicalDisk\ReadsPerSecond
DISK_IO_WRITE_RATE_GUEST\PhysicalDisk\WritesPerSecond
DISK_TRANSFER_RATE_GUEST\PhysicalDisk\BytesPerSecond
DISK_WRITE_RATE_GUEST\PhysicalDisk\WriteBytesPerSecond
NET_OUT_BYTE_RATE_GUEST(\NetworkInterface\BytesTransmitted)/3600
NET_IN_BYTE_RATE_GUEST(\NetworkInterface\BytesReceived)/3600
NET_BYTE_RATE_GUEST(\NetworkInterface\BytesTotal)/3600
NET_OUT_PKT_RATE(\NetworkInterface\PacketsTransmitted)/3600
NET_IN_PKT_RATE(\NetworkInterface\PacketsReceived)/3600
NET_PKT_RATE(\NetworkInterface\PacketsTransmitted+\NetworkInterface\PacketsReceived)/3600
NET_IN_ERROR_RATE(\NetworkInterface\TotalRxErrors)/3600
NET_OUT_ERROR_RATE(\NetworkInterface\TotalTxErrors)/3600
NET_ERROR_RATE(\NetworkInterface\TotalRxErrors+\NetworkInterface\TotalTxErrors)/3600

Performance metrics for Windows VMs

The following metrics are available for Windows VMs when "Guest OS diagnostics" is enabled. This option is disabled by default while creating VM.

TrueSight Capacity Optimization metricAzure metric
CPU_UTIL_GUEST\Processor(_Total)\% Processor Time
CPU_UTIL_SYSTEM\Processor(_Total)\% Privileged Time

CPU_UTIL_USER

\Processor(_Total)\% User Time
CPU_MHZ\Processor Information(_Total)\Processor Frequency
MEM_VIRTUAL_USED_PCT\Memory\% Committed Bytes In Use
MEM_FREE\Memory\Available Bytes
MEM_UTIL(memoryInMB - \Memory\Available Bytes)/memoryInMB
MEM_VIRTUAL_ACTIVE\Memory\Committed Bytes
MEM_VIRTUAL_TOTAL\Memory\Commit Limit
MEM_VIRTUAL_FREE

\Memory\Commit Limit - \Memory\Committed Bytes

MEM_CACHE_FAULTS\Memory\Cache Faults/sec
MEM_PAGE_FAULT_RATE\Memory\Page Faults/sec
MEM_PAGE_IN_RATE\Memory\Page Reads/sec
MEM_PAGE_RATE\Memory\Pages/sec
MEM_PAGE_OUT_RATE\Memory\Pages/sec - \Memory\Page Reads/sec
MEM_POOL_PAGED\Memory\Pool Paged Bytes
MEM_NONPOOL_PAGED\Memory\Pool Nonpaged Bytes
MEM_TRANSITION_FAULTS\Memory\Transition Faults/sec
DISK_IO_RATE_GUEST\PhysicalDisk(_Total)\Disk Transfers/sec
DISK_IO_READ_RATE_GUEST\PhysicalDisk(_Total)\Disk Reads/sec
DISK_IO_WRITE_RATE_GUEST\PhysicalDisk(_Total)\Disk Writes/sec
DISK_TRANSFER_RATE_GUEST\PhysicalDisk(_Total)\Disk Bytes/sec
DISK_READ_RATE_GUEST\PhysicalDisk(_Total)\Disk Read Bytes/sec
DISK_WRITE_RATE_GUEST``\PhysicalDisk(_Total)\Disk Write Bytes/sec
LDISK_FREE\LogicalDisk(_Total)\Free Megabytes

API calls for the Azure Pay-As-You-Go accounts

The ETL makes the following REST API calls to retrieve data from the Azure Pay-As-You-Go accounts.

TaskResource Management API call
Authentication

POST https://login.windows.net/<tenant_id>/oauth2/token (Application ID, Authentication key)

List subscriptionsGET https://management.azure.com/subscriptions?api-version=2015-01-01
List resources for a subscriptionGET https://management.azure.com/subscriptions/<subscription_id>/resources?api-version=2015-01-01
Get details for computer VMsGET https://management.azure.com<resource_id>?$expand=instanceView&api-version=2015-05-01-preview
Get metric definitionGET https://managemen.azure.com<resource_id>/providers/microsoft.insights/metricdefinitions?api-version=2016-03-01
Get metric values

GET https://management.azure.com<resource_id>/providers/microsoft.insights/metrics?api-version2016-09-01&$filter=(<metric_names> and (aggregationType eq '<aggregation_type>') and startTime eq <start-date> and endTime eq <end_date> and timeGrain eq duration'PT1H'

Get metric definition for diagnostic metrics

GET https://management.azure.com<resource_id>/metricDefinitions?api-version=2014-04-01

Get metric values for diagnostic metricsGET https://<storage_account_name>/<table-name>()?$filter=<metric_filter_string>&<sasToken_obtained_in above_call>
Get virtual machine sizesGET https://management.azure.com/subscriptions/<region>/providers/Microsoft.Compute/locations/<region>/vmSizes?api-version=2015-05-01-preview
Get network interface detailsGET https://management.azure.com/<networkInterface>?api-version=2016-09-01&$expand=ipConfigurations/publicIPAddress
Get classic virtual machine detailsGET https://management.azure.com<resource-id>?api-version=2016-04-01&$expand=instanceView

For more information, see the  Azure Resource Manager .

API calls for the Azure Government cloud accounts

The ETL makes the following REST API calls to retrieve the data from the Azure Government cloud accounts:

TaskResource Management API call
Authentication

POST https://login.windows.net/<tenant_id>/oauth2/token (Application ID, Authentication key)

List subscriptionsGET https://management.usgovcloudapi.net/subscriptions?api-version=2015-01-01
List resources for a subscriptionGET https://management.usgovcloudapi.net/subscriptions/<subscription_id>/resources?api-version=2015-01-01
Get details for computer VMsGET https://management.usgovcloudapi.net<resource_id>?$expand=instanceView&api-version=2015-05-01-preview
Get metric definitionGET https://management.usgovcloudapi.net<resource_id>/providers/microsoft.insights/metricdefinitions?api-version=2016-03-01
Get metric values

GET https://management.usgovcloudapi.net<resource_id>/providers/microsoft.insights/metrics?api-version2016-09-01&$filter=(<metric_names> and (aggregationType eq '<aggregation_type>') and startTime eq <start-date> and endTime eq <end_date> and timeGrain eq duration'PT1H'

Get virtual machine sizesGET https://management.usgovcloudapi.net/subscriptions/<region>/providers/Microsoft.Compute/locations/<region>/vmSizes?api-version=2015-05-01-preview
Get network interface detailsGET https://management.usgovcloudapi.net/<networkInterface>?api-version=2016-09-01&$expand=ipConfigurations/publicIPAddress
Get classic virtual machine detailsGET https://management.usgovcloudapi.net<resource-id>?api-version=2016-04-01&$expand=instanceView

Was this page helpful? Yes No Submitting... Thank you

Comments