Entities, lookup information, metrics, and API calls for Azure Resource Manager model
This topic provides information about the entity relationship, mapping between the Azure metrics and the BMC Helix Continuous Optimization 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
- App Service
- Virtual Machine
Entity relationship
The following table describes entity relationship details for the Resource Manager model:
Parent entity | Child entity | Description | Display status |
---|---|---|---|
Resource Group - Azure (rg:azu) | Virtual Machine - Azure (gm:azu) | Resource group contains Azure VM | Visible |
Resource Group - Azure (rg:azu) | App Service - Azure (as:azu) | Resource group contains Azure App service | Visible |
Lookup information
The following table explains the lookup fields for Azure entities that you can use to quickly find the required entity.
Entity type | Lookup fields |
|
---|---|---|
| Strong | Weak |
Cloud Service - Azure | CLOUD_SERVICE_NAME | Not applicable |
Deployment - Azure | DEPLOYMENT_GUID, RESOURCE_ID | Not applicable |
Role - Azure | PARENT_DEPLOYMENT_GUID&&ROLE_NAME | Not applicable |
Virtual Machine - Azure | RESOURCE_ID, UUID | HOSTNAME, NAME |
App Service - Azure | RESOURCE_ID | DEFAULT_HOSTNAME |
Resource Group - Azure | RESOURCE_ID | Not applicable |
Business Service | APPLICATION_NAME | Not applicable |
Configuration metrics for virtual machines
BMC Helix Continuous Optimizationmetric | Azure metric | Formula |
---|---|---|
CPU_NUM | numberOfCores | Not applicable |
DISK_NUM | maxDataDiskCount | Not applicable |
DISK_SIZE | Derived | Sum(BYDISK_SIZE) |
BYDISK_SIZE |
| Not applicable |
LOCATION_SITE | location | Not applicable |
OS_FAMILY | properties.osDisk.osType | Not applicable |
OS_TYPE | properties.storageProfile.imageReference.offer | Not applicable |
OS_VER | properties.storageProfile.imageReference.sku | Not applicable |
REQUESTED_INSTANCE_TYPE | properties.hardwareProfile.vmSize | Not applicable |
REGION_ID | Location | Not applicable |
REGION_NAME | displayName | Not applicable |
SUBSCRIPTION_ID | SubscriptionID | Not applicable |
SUBSCRIPTION_NAME | SubscriptionName | Not applicable |
TOTAL_REAL_MEM | memoryInMB | resourceDiskSizeInMB*1024*1024 |
TOTAL_LDISK_SIZE1 | \LogicalDisk(_Total)\Free Megabytes and \ | ((\LogicalDisk(_Total)\Free Megabytes*1024*1024)*100) / |
CPU_MHZ1 | \Processor Information(_Total)\Processor Frequency | Not applicable |
VM_LAST_STATUS (Guest Machine last known power status. Set to poweredOn if the guest machine is running, otherwise poweredOff.) | ProvisioningState | Not applicable |
1 - These metrics are available only:
- For Microsoft Windows operating system.
- If the Guest OS diagnostics or the Monitor Agent settings are enabled for your virtual machines.
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.)
BMC Helix Continuous Optimizationmetric | Azure metric | Formula |
---|---|---|
CPU_UTIL | Percentage CPU | PERCENTAGE_CPU/100 |
CPU_USED_NUM | Derived | CPU_NUM*(PERCENTAGE_CPU)/100 |
DISK_READ_RATE | Disk Read Bytes | DISK_READ_BYTES/3600 |
DISK_WRITE_RATE | Disk Write Bytes | DISK_WRITE_BYTES/3600 |
DISK_TRANSFER_RATE | Derived | (DISK_READ_BYTES+DISK_WRITE_BYTES)/3600 |
DISK_IO_READ_RATE | Disk Read Operations/Sec | Not applicable |
DISK_IO_WRITE_RATE | Disk Write Operations/Sec | Not applicable |
DISK_IO_RATE | Derived | DISK_READ_OPERATIONS_PER_SEC + DISK_WRITE_OPERATIONS_PER_SEC |
NET_OUT_BYTE_RATE | Network Out | NETWORK_OUT/3600 |
NET_IN_BYTE_RATE | Network In | NETWORK_IN/3600 |
NET_BIT_RATE | Derived | ((NETWORK_IN + NETWORK_OUT)*8)/3600 |
NET_BYTE_RATE1 | Derived | (NETWORK_IN + NETWORK_OUT)/3600 |
1 - Indicates metrics that are set at level 4. These metrics are imported only when the collection level of the ETL is set to ‘Extended’. For information about changing the collection level, see Microsoft-Azure-Azure-API-Extractor.
Configuration metrics for App Services
BMC Helix Continuous Optimizationmetric | Azure metric | Formula |
---|---|---|
APP_SERVICE_STATUS | Status | Not applicable |
OS_FAMILY | Kind | Not applicable |
REGION_ID | Location | Not applicable |
REGION_NAME | displayName | Not applicable |
LOCATION_SITE | Location | Not applicable |
SUBSCRIPTION_ID | SubscriptionID | Not applicable |
SUBSCRIPTION_NAME | SubscriptionName | Not applicable |
TOTAL_APP_DOMAINS | Total App Domains | Average |
TOTAL_UNLOADED_APP_DOMAINS | Total App Domains Unloaded | Average |
Performance metrics for App Services
BMC Helix Continuous Optimizationmetric | Azure metric | Formula |
---|---|---|
APP_CONNECTIONS | Connections | Average |
APP_CPU_TIME | CPU Time | Sum |
DATA_IN_BANDWIDTH | Data In | Sum |
DATA_OUT_BANDWIDTH | Data Out | Sum |
HTTP_RESPONSE_TIME | Response Time | Average |
HTTP_SERVER_ERRORS | Http Server Errors | Sum |
IO_READ_OPS_RATE | IO Read Operations Per Second | Sum |
IO_READ_RATE | IO Read Bytes Per Second | Sum |
IO_WRITE_OPS_RATE | IO Write Operations Per Second | Sum |
IO_WRITE_RATE | IO Write Bytes Per Second | Sum |
MEM_USED | Memory working set | Average |
REQUESTS | Requests | Sum |
High mark metrics
High Mark metric | Base metric to calculate the high-mark metric | Azure metric |
---|---|---|
CPU_USED_NUM_HM | CPU_NUM * CPU_UTIL | The calculation is based on base metrics (1M granularity*) |
DISK_TRANSFER_RATE_HM | DISK_TRANSFER_RATE | Disk Read Bytes, Disk Write Bytes (1M granularity*) |
NET_BIT_RATE_HM | NET_BIT_RATE | Network In, Network Out (1M granularity*) |
* 1M granularity indicates that the metric data is sampled every minute.
API calls for the Azure API ETL
The extractor makes the following Resource Management REST API calls on Azure cloud services in the Azure Resource Manager model.
Task | Resource Management API call | Used by |
---|---|---|
Authentication | POST https://login.windows.net/<tenant_id>/oauth2/token (Application ID, Authentication key) | Virtual Machines, App Services |
List subscriptions | Virtual Machines, App Service | |
List resources for a subscription | GET https://management.azure.com/subscriptions/<subscription_id>/resources?api-version=2015-01-01 | Virtual Machines, App Services |
Get details for resource | GET https://management.azure.com<resource_id>?$expand=instanceView&api-version=2015-05-01-preview | Virtual Machines, App Services |
Get metric definition | GET https://managemen.azure.com<resource_id>/providers/microsoft.insights/metricdefinitions?api-version=2016-03-01 | Virtual Machines, App Services |
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' | Virtual Machines, App Services |
Get metric definition for diagnostic metrics | Virtual Machine | |
Get metric values for diagnostic metrics | GET https://<storage_account_name>/<table-name>()?$filter=<metric_filter_string>&<sasToken_obtained_in above_call> | Virtual Machines |
Get Resource Groups for subscription | Virtual Machines | |
Get location for subscription | Virtual Machines | |
Get VM sizes for region | Virtual Machines | |
Get VM network interface details | Virtual Machines | |
Get VM power state | Virtual Machines | |
Get VM metric namespaces | Virtual Machines | |
Get diagnostic metric definition for VM metric namespace (for virtual machines using the Azure Monitoring Agent) | Virtual Machines | |
Get diagnostic metric values for VM (for virtual machines using the Azure Monitoring Agent) | Virtual Machines |
For more information, see the Azure Resource Manager.
API calls for the Azure Government cloud
The extractor makes the following REST API calls to fetch the required details from the Azure Government cloud:
Task | Resource Management API call |
---|---|
Authentication | POST https://login.windows.net/<tenant_id>/oauth2/token (Application ID, Authentication key) |
List subscriptions | |
List resources for a subscription | GET https://management.usgovcloudapi.net/subscriptions/<subscription_id>/resources?api-version=2015-01-01 |
Get details for computer VMs | GET https://management.usgovcloudapi.net<resource_id>?$expand=instanceView&api-version=2015-05-01-preview |
Get metric definition | GET 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 metric definition for diagnostic metrics | |
Get metric values for diagnostic metrics | GET https://<storage_account_name>/<table-name>()?$filter=<metric_filter_string>&<sasToken_obtained_in above_call> |