---
title: "Azure"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html"
---
## Overview

The Azure plugin is a Collection Agent plugin that is used to monitor Azure resources. This plugin collects Azure Monitor metrics using a combination of API calls using the Azure Java SDK and REST API, then it displays data as dataview in Geneos.

In addition, the Azure plugin allows you to:

- Combine metrics from Azure with on-premise, multi-cloud, and hybrid environments for end-to-end visibility.
- Monitor real-time alerts using  rule and alert capabilities.
- Minimise cost by using a single enterprise tool for monitoring.
- Monitor Azure cost and usage trends in your subscription.

To view the versions of Geneos components that are included in the Azure virtual machine image, see [Packaged binaries](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#packaged-binaries).

### Azure plugin collectors

You can use the Azure plugin to monitor different services by using the following collectors in the Collection Agent YAML file:

- `AzureMonitorCollector` — for the list of Azure Monitor services that this plugin can monitor, see [Monitored Azure services](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#monitored-azure-services).
- `AzureEventHubCollector` — for publishing metrics and platform logs from the Azure Event Hub service. See [Azure Event Hub](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-event-hub/index.html) for more information.
- `AzureCostCollector` - for publishing actual cost and usage metrics from the Azure Cost Management service. See [Azure Cost](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-cost/index.html) for more information.

### Deployment recommendations

There are multiple approaches in optimising the Azure plugin to monitor a specific estate. You can deploy the Azure plugin with any of these options:

- [Deploy Azure through the Azure Marketplace](#deploy-azure-through-the-azure-marketplace)
- [Configure the Azure Monitor collector](#configure-the-azure-monitor-collector)
- [Configure the Azure Event Hub collector](#configure-the-azure-event-hub-collector)
- [Configure the Azure Cost collector](#configure-the-azure-cost-collector)

In cases where you are nearing the Azure API limits, which is 12000 per hour, you should apply filtering to only monitor the selected services, or deploy other options to run the Azure plugin.


**Caution**


Since the Azure plugin works by calling into the Azure API, you should be aware of the API usage limits. If the API limits are frequently reached, you may want to limit or monitor the metrics collected, see [Azure Monitor API count monitoring](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#azure-api-count-monitoring). Alternatively, you can also increase the collection interval time. For more information about API limits, see [Request limits in Azure](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).



#### Deploy Azure through the Azure Marketplace

Use the [Deploy Azure Monitor through the Azure Marketplace](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#deploy-azure-through-the-azure-marketplace-1) deployment option for the following reasons:

- An easier way for you to deploy the Azure plugin through the Azure Marketplace with built-in dynamic entity mapping to minimise Gateway configuration.
- This deployment supports different scenarios to set up the plugin with minimal configuration.

#### Configure the Azure Monitor collector

Use the [Configure the Azure Monitor collector](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#configure-the-azure-monitor-collector-1) deployment option in the following cases:

- When you require a native deployment option where you configure the Gateway and Netprobe in Geneos on your local machine.

#### Configure the Azure Event Hub collector

 Azure plugin supports the ability to consume real-time metrics and platform logs from the Azure Event Hub service. This is an alternative to polling Azure Monitor API, enabling Geneos to monitor your Azure cloud environment at scale and in real-time.
 
 Use the [Azure Event Hub](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-event-hub/index.html) deployment option in the following cases:
 
 * If you have Azure diagnostics set up to publish metrics and platform logs to an Event Hub, you may want to use the Azure Event Hub collector for gathering metrics and platform logs. This provides a higher throughput of metrics and platform logs which is one way to avoid issues caused by Azure API limitations.
 * Your Azure Monitor API usage is near the [hourly API limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling) as your Azure estate grows larger. The best approach to preventing this is identifying the priority of services and resources that you want to monitor, and then slowly migrating them to Event Hub streaming to use the Azure Event Hub collector.

#### Configure the Azure Cost collector

Use the [Azure Cost](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-cost/index.html) deployment option in the following cases:

- When you need to monitor Azure spending and cost trends for your subscription.
- When you want to track usage quantities for Azure resources over time.
- When you need to monitor Azure budget and threshold notifications.
- When you need to group costs by different dimensions (for example, `ResourceGroup`, `ServiceName`, `Location`) or by custom tags.
- When you want to filter cost data by specific dimensions or tags to focus on particular resources or services.

The collector supports daily or monthly granularity and allows you to define a custom monthly start day for cost tracking that aligns with your billing period.

## Prerequisites

### Geneos environment

 The latest version of the Azure Collection Agent plugin requires the following versions of Geneos components:
 
 * Gateway and Netprobe 5.10.x or higher. The same version must be used for the  schema.
 * Collection Agent 2.x. To run , see  [setup](https://docs.itrsgroup.com/docs/geneos/current/collection/collection-agent/collection-agent-setup/index.html).
 
 The Azure binaries are packaged with Netprobe, and are stored in the `collection_agent` folder. Alternatively, you can download separate binaries for the Azure plugin from [ITRS Downloads](https://resources.itrsgroup.com/downloads).


 
**Caution**


Collection Agent and its plugins is no longer packaged with the Netprobe in Geneos 5.14.7 and the subsequent 5.x versions. If you want to run Collection Agent via Netprobe, please upgrade to the current version of Geneos.



### Set up the Azure environment for data collection

Configure your Azure environment to enable the `AzureMonitorCollector`, `AzureEventHubCollector`, and `AzureCostCollector` to collect data from Azure resources.

#### Register an application

Register the Azure Monitor Collection Agent plugin as an application in Azure to establish a trust relationship with the Microsoft identity platform.

1. Sign in to the **Microsoft Entra admin center**. Ensure that your account is at least an Application Developer in order to register a new application.
2. Go to **Entra ID** > **App registrations** > **New registration**.
    ![azure-app-registration](https://docscdn.itrsgroup.com/geneos-azure-monitor/images/azure-app-registration.png)
3. Enter a name for the application, for example `Azure-Collection-Agent-Plugin`.
4. In the **Supported account types** section, select which accounts can access the application. You can choose to allow single tenant or multitenant access. By default, the single tenant option is selected.
5. Click **Register**.

Refer to the [Azure documentation](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for further information on app registration and supported account types.

#### Assign a role to the application

The registered app must be assigned an appropriate role that can access Azure monitoring data. Data collection is limited to the resources permitted by the assigned role.

1. Use the search bar in the Azure portal to navigate to the app you registered.
2. Open the **Access control (IAM)** menu.
3. Click the **Role assignments** tab.
4. Click **Add** > **Add role assignment**.
5. Assign a role that can access Azure monitoring data. You can select from the built-in roles provided by Azure, such as:

    - **Monitoring Contributor** and **Monitoring Reader** if you want to use the `AzureMonitorCollector`
    - **Azure Event Hubs Data Sender** and **Azure Event Hubs Data Receiver** if you want to use the `AzureEventHubCollector`
    - **Cost Management Reader** if you want to use the `AzureCostCollector`

    Refer to the [Azure built-in roles documentation](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles) for a complete list of built-in roles related to monitoring and data access.

6. Select who needs access to the role on the **Members** tab.
7. Review the role assignment settings in the **Review + assign** tab. Click **Review + assign** to finalize the role assignment.


**Note**



- Depending on the role selected and your license type, you may need to configure additional settings. Refer to the [Azure role assignment documentation](https://learn.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal) for more information.
- You can also create a custom role to fit your specific requirements. Refer to the [Azure custom role documentation](https://learn.microsoft.com/en-us/azure/role-based-access-control/custom-roles) for the complete steps on how to create custom roles. 


#### Gather credentials

Retrieve the following credentials from the Azure portal:

- clientID - from the **Overview** section of the registered app
- clientSecret - from the **Certificates and secrets** section of the registered app
- tenantID - from the **Overview** section of the registered app
- subscriptionID - from the **Subscriptions** section in the Azure portal

You must specify these credentials as environment variables. These will then be used by the [`AzureMonitorCollector` configuration](#set-up-your-collection-agent-plugin) to access and collect monitoring data from Azure.

## Deploy Azure through the Azure Marketplace

 You can deploy the ITRS's pre-configured virtual machine through the Azure Marketplace that has a running Netprobe with the Azure plugin on port `7036`, and optionally, you can run the Gateway on port `7039` that connects to the probe.

The pre-configured virtual machine image created by ITRS contains configuration files and scripts, see [Packaged configuration files](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#packaged-configuration-files).


**Note**

  The default behaviour of deploying the virtual machine through the Azure Marketplace does not require any certificates to enable encrypted communication. If you want to switch to secure encrypted communication, see [Run Gateway with secure encrypted communication](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#run-gateway-with-secure-encrypted-communication). 


### Create a virtual machine in Azure Marketplace

Ensure that your Azure account has the necessary credentials in order to access the application. See the requirements for [Azure environment](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#azure-environment).

To create a virtual machine in the Azure Marketplace:

1. Open [Azure Portal](https://portal.azure.com/).
2. Click **Create a resource** under **Azure services**.
3. Search for **ITRS Geneos**, then click **Create**. This opens the **Create a virtual machine** page.
![image](../..//geneos-azure-monitor/images/azure-monitor-create-a-vm-2-1-0.png)
4. Provide the required information in all tabs under the **Create a virtual machine** screen. Some fields are mandatory and the value must not be empty.
    
**Note**

  You can configure the remaining required fields depending on your machine requirements. For example, you can freely adjust the size of your virtual machine accordingly and create your own resource group. We only require you to follow the settings below when configuring your virtual machine. 

    - In the **Basics** tab, ensure that the **Image** field is set to **ITRS Geneos Azure plugin - Gen2**.
    - In the **Advanced** tab, add the script below in the **Custom data** field. This will run the Gateway in demo mode. For other deployment scenarios, you can refer to the [Supported scenarios for deploying your virtual machine](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#supported-scenarios-for-deploying-your-virtual-machine).

    ```
    #cloud-config
    runcmd:
    - bash /geneos/set-azure-parameters.sh --clientID <"client-id"> --clientSecret <"client-secret"> --tenantID <"tenant-id"> --subsID <"subscription-id"> --gatewayArgs "-demo"
    ```

    In this example, the virtual machine will run the Collection Agent, Netprobe, and Gateway because the `--gatewayArgs "-demo"` was used in the parameters script. The Gateway will run in demo mode that does not require licencing and with minimal configuration needed.
5. Once the configuration for the virtual machine is completed, click **Review + create**.
    - If you select **SSH public key** on the **Basics** tab as the authentication type, Azure will ask you to download private key.
    - Azure will validate all the requirements that you submitted to create a virtual machine.
    - Click **Create**.
6. Wait until the deployment status is completed. Then, you can open your resource.

![image](https://docscdn.itrsgroup.com/geneos-azure-monitor/images/azure-monitor-vm-deployment-complete.png)

7. After the virtual machine is created, go to the resource and add the inbound port rules for port `7036`.
    - In the **Networking** > **Add inbound port rule** for `7036`, change the **Destination port ranges** to `7036`.
    - In **Protocol** > **TCP**, update the name.
    - In the **Networking** > **Add inbound port rule** for `7039`, change the **Destination port ranges** to `7039`.
    - In **Protocol** > **TCP**, update the name.
8. Add the inbound port rules for port `7039`.
    - In the **Networking** > **Add inbound port rule** for `7039`, change the **Destination port ranges** to `7039`.
    - In **Protocol** > **TCP**, update the name.
9. Navigate to **Overview**, copy the public IP address provided to connect via SSH client.
10. Open **Active Console Settings > Connections**.
    - In the **Connections** section, add the hostname or the public IP address of your virtual machine.
    - Click **OK**. This displays the monitored Azure metrics and the [Azure Monitor API count monitoring](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#azure-api-count-monitoring). See [Example dataview](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#example-dataview).


**Note**

  Once you successfully create your virtual machine, and connect Gateway from the Active Console, check if the monitored Azure resources display in the dataview. If not, then you should check the status of the Gateway and Netprobe in the virtual machine, see [Check the Gateway and Netprobe status](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#check-the-gateway-and-netprobe-status). 


### Supported scenarios for deploying your virtual machine

This section provides you a list of scenarios to deploy the Azure plugin through the Azure Marketplace. If you want to update your virtual machine, see [Update virtual machine using parameters](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#update-virtual-machine-using-parameters).

#### Run Gateway with secure encrypted communication

You can run a secured Netprobe in the virtual machine by retrieving these files from a key vault:


**Note**

  You can only run a secured Netprobe or Gateway after creating a virtual machine. Then, you must move the certificate files below to your virtual machine. 


- SSL certificate
- SSL certificate key
- SSL certificate chain

You should manually configure the inbound port in the following cases:

- When you enable a secured Gateway, add the port that you set in `gateway.setup.xml` of your virtual machine which is a secured port.
- When you add the `-port` in `--netprobeArgs`, add the inbound port that you set in `-port`.
- When you add the `-port` in `--gatewayArgs`, add the inbound port that you set in `-port`.

To configure the inbound port, navigate to your virtual machine in [Azure Portal](https://portal.azure.com/), then click **Settings > Networking**.

To view the parameters that you can use in the `--netprobeArgs` parameter, see [--netprobeArgs](#update-virtual-machine-using-parameters), and for `--gatewayArgs`, see [--gatewayArgs](#update-virtual-machine-using-parameters).

Run this script in your virtual machine:

```
bash /geneos/set-azure-parameters.sh --gatewayArgs "-licd-host <host> -licd-port <port> -ssl-certificate <file> -ssl-certificate-key <file> -ssl-certificate-chain <file>" --netprobeArgs "-secure -ssl-certificate <file> -ssl-certificate-key <file> -ssl-certificate-chain <file>"
```

#### Run Gateway connecting to an existing Licence Daemon

 In this mode, the virtual machine will run the Collection Agent, Netprobe, and Gateway. The Gateway must be connected to an existing LICD that requires normal licencing. Then, you can connect Active Console to the Gateway using the public IP address of your virtual machine on port `7039`.

Run this script in your virtual machine:

```
bash /geneos/set-azure-parameters.sh --clientID <"client-id"> --clientSecret <"client-secret"> --tenantID <"tenant-id"> --subsID <"subscription-id"> --gatewayArgs "-licd-host <hostname> -licd-port <port>"
```

The Gateway in the virtual machine will use its default values, a port on `7039`, and LICD localhost on `7041` if none are provided.


**Note**

  When the default values are not used, for example, if `--gatewayArgs "-licd-port 7040"` is run, you must create your own Gateway setup and configure the inbound port to allow connection through port `7040` in your Azure virtual machine. 


#### Run Self-announcing Netprobe connecting to an existing Gateway

 In this mode, the virtual machine will run the Collection Agent and Netprobe as a Self-announcing Netprobe. The SAN probes need to connect to your own Gateway.

You must add the mapping type named **Azure Metrics** to your Gateway to see the data in your Active Console. For guidance on how to add the mapping type, refer to the steps in [Configure Geneos to deploy Azure Monitor](#configure-geneos-to-deploy-azure).

Run this script in your virtual machine:

```
bash /geneos/set-azure-parameters.sh --clientID <"client-id"> --clientSecret <"client-secret"> --tenantID <"tenant-id"> --subsID <"subscription-id"> --san "gwHost=<host>;gwPort=<port>;gwSecure=<value>"
```

When `--san` is enabled, you should not use the `-setup` option in the `--netprobeArgs` parameter. If you use the `-setup` option, this will be ignored.

#### Run normal Netprobe connecting to an existing Gateway

 In this mode, the virtual machine will run the Collection Agent and Netprobe in normal mode. This requires you to configure the Gateway to connect to the Netprobe on port `7036`.

You must add the mapping type named **Azure Metrics** to your Gateway to see the data in the Active Console. For guidance on how to add the mapping type, refer to the steps in [Configure Geneos to deploy Azure Monitor](#configure-geneos-to-deploy-azure).

Run this script in your virtual machine:

```
bash /geneos/set-azure-parameters.sh --clientID <"client-id"> --clientSecret <"client-secret"> --tenantID <"tenant-id"> --subsID <"subscription-id">
```

### Update virtual machine using parameters

You can update your Azure Monitor plugin parameters in the **Dynamic Entities** > **Collectors** section of your Gateway Setup Editor. For more information, see [Collectors in Dynamic Entities](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#collectors).

You can also test or update your newly created virtual machine in the [Azure Portal](https://portal.azure.com/). To do this, you can use the supported arguments to the `set-azure-parameters.sh` script.

1. Open your virtual machine under **Recent resources**.
2. Click **Run command > RunShellScript**. This opens the **Run Command Script** screen.
3. Update the script in the **Linux Shell Script** field. Then, click **Run**.

Here is the list of parameters that you can use for the `set-azure-parameters.sh` configuration:

| Option | Description |
|--------|-------------|
| `-clientID` | Azure client ID to be used by the Netprobe.
Mandatory: Yes |
| `-clientSecret` | Azure client secret associated with the client ID.
Mandatory: Yes |
| `--subsID` | Subscription ID associated with an Azure subscription.
Mandatory: Yes |
| `--tenantID` | Tenant ID associated with the Azure Active Directory.
Mandatory: Yes |
| `--gatewayArgs` | Starts the Gateway installed in the virtual machine using the [command line options](https://docs.itrsgroup.com/docs/geneos/6.9.0/processing/gateway_installation_guide/index.html#command-line-options) provided. Example:- `--gatewayArgs "-licd-host localhost -licd-port 7041"`
- `--gatewayArgs "-demo"` (this runs the Gateway in demo mode) 
**Note**

Demo mode has the following limitations. For more information, see [Demo mode in Gateway licensing](https://docs.itrsgroup.com/docs/geneos/current/administration/gateway_licensing/index.html#demo-mode). Also, when switching between secure and insecure Gateway, you must delete the following files in the Gateway directory in your virtual machine: cache folder and `licences.cache`. 
 |
| `--netprobeArgs`| Starts the Netprobe installed in the virtual machine using the [command line options](https://docs.itrsgroup.com/docs/geneos/current/collection/netprobe/configuration/netprobe-command-line-options/index.html) provided. Example: `--netprobeArgs "-secure -ssl-certificate ./np.pem -ssl-certificate-chain ./rootCA.pem"` Options:- `-ssl-certificate` — specifies the file that contains the signed SSL server certificate (in PEM format).
- `-ssl-certificate-key` — specifies the file that contains a private SSL server key. If this is unspecified, the probe will look for the key in the SSL server certificate file.
- `-ssl-certificate-chain` — specifies the file that contains the trusted Certificate Authority certificate. If this is unspecified, the probe will look for the CA certificate in the SSL server certificate file.
- `-secure` — specifies that the probe will only accept secure connections. |
| `--loggerLevel` | Sets the logger level of the plugin.
Possible values: `trace`, `debug`, `info`, `warn`, `error`
Mandatory: No
Default value: `info` |
| `--enabledResources` | Comma-separated list of Azure resource types that will be monitored.
Sample usage: `--enabledResources Microsoft.Batch/batchAccounts,Microsoft.Compute/virtualMachines`
Mandatory: No
Default value: `All` |
| `--collectionInterval` | Interval (in milliseconds) between publications.
Mandatory: No
Default value: `300000` |
| `--delay` | Adds delay (in minutes) before retrieving the Azure metrics. This is useful to allow Azure time to complete generation of metric values before they are collected by the plugin.
Mandatory: No
Default value: `0` |
| `--san` | Runs the Netprobe as a Self-announcing Netprobe. The options are defined by adding key-value pairs separated semicolon.
Sample usage: `--san "gwHost=localhost;gwPort=7039;gwSecure=true"` Options:- `probeName` — name of the Self-announcing Netprobes. The default value is `<VM-hostname>_azure`.
- `healthPort` — Collection Agent port that the Netprobe communicates with for health checks. The default value is 9136.
- `reporterPort` — the port the Netprobe should listen on to communicate with the Collection Agent using the `TcpReporter`. The default value is `9137`.
- `mappingType` — mapping type used to generate Dynamic Entities for this Netprobe. The default value is Azure Metrics.
- `caParams` — Collection Agent parameters used to start the Collection Agent of this Netprobe. The default value is `azure-collection-agent-params`.
- `gwHost` — Gateway hostname where this Netprobe will connect to.
- `gwPort` — Gateway port where this Netprobe will connect to.
- `gwSecure` — whether the Gateway where this Netprobe will connect to is secured. The allowable values are either true or false. When no option is defined, the probe will run as a Self-announcing Netprobe using the current values defined. |
| `-h` \ `--help` | Shows the help text. |

- The client ID, client secret, subscription ID, and tenant ID must all be provided when updating credentials for the Azure plugin.
- To update your logger level, list of enabled resources, collection interval, or SAN options without updating the Azure credentials, you can run any of the following in the **Run command > RunShellScript**:

```
bash set-azure-parameters.sh --enabledResources <resources>
bash set-azure-parameters.sh --loggerLevel <logger-level>
bash set-azure-parameters.sh --collectionInterval <interval>
bash set-azure-parameters.sh --san
bash set-azure-parameters.sh --san <san-options>
bash set-azure-parameters.sh --enabledResources <resources> --loggerLevel <logger-level> --collectionInterval <interval> --san <san-options>
```

- Setting the `collection-interval` to a smaller value could cause the plugin to reach the throttling limit more frequently. For more information about throttling requests, see [Request limits in Azure](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling).
- If no parameter is provided, the shell script will exit.

### Packaged configuration files

The pre-configured virtual machine image created by  contains the following:

- Gateway, Netprobe, Collection Agent, and Azure plugin inside `/geneos` with the following configuration files:

  - `collection-agent.yml` is modified to call on variables set from shell script.
  - `gateway.setup.xml` is pre-configured to automatically connect the  to the  in the virtual machine.
  - `logback.xml` is modified to allow log rollover.
  - `san.xml` setup file for running the Netprobe in self-announce mode.
- Helper scripts:

  - `/geneos/get-diagnostics.sh`
  - `/geneos/set-azure-parameters.sh`
  - `/geneos/set-logger-info.sh`
  - `/geneos/add-enabled-resources.py`
  - `/geneos/update-collection-interval.py`
  - `/geneos/update-delay.py`
- Service files:

  - `/usr/bin/start-netprobe.sh`
  - `/usr/bin/start-gateway.sh`
  - `/lib/systemd/system/netprobe.service`
  - `/lib/systemd/system/gateway.service`

### Packaged binaries

The pre-configured virtual machine image created by ITRS contains the latest versions of the following Geneos components:

- Geneos Gateway
- Geneos Netprobe
- Collection Agent
- Azure plugin

### Troubleshooting

#### Check the Gateway and Netprobe status

You can run the following commands to check the state of the Gateway and Netprobe in your virtual machine.


**Note**

  Both the Gateway and Netprobe on the virtual machine are run as a `systemd` service. 


1. Open a terminal session in your virtual machine and connect to SSH.
2. Run this command to check if the Gateway and Netprobe are running in the virtual machine:

    ```
    # Check the status of Netprobe
    systemctl status netprobe

    # Check the status of Gateway
    systemctl status gateway
    ```

3. Run this command to restart the Gateway and Netprobe if they fail during the initialisation of the virtual machine:

    ```
    # Restart the Netprobe
    systemctl restart netprobe

    # Restart the Gateway
    systemctl restart gateway
    ```

#### Get the diagnostic files

For troubleshooting purposes, you can download a diagnostic file from the Azure virtual machine storage account with the following contents:

- Collection Agent
- Collection Agent logs
- Netprobe logs

To set up your Storage account:

1. Navigate to the [Azure Portal](https://portal.azure.com/)
2. Click **Storage Accounts** under the **Azure services**.
3. Search for your storage account. If you have not created a storage account, click **Create**.
4. Enter a name for your container, and set the **Public access level** to **Blob**. Then, click **Create**.
    ![azure-monitor-storage-account-container](../..//geneos-azure-monitor/images/azure-monitor-storage-account-container.png)
5. Once the container is created, click **Shared access tokens** under **Settings**, and then provide the following information:
    ![azure-monitor-storage-account-shared-access](../..//geneos-azure-monitor/images/azure-monitor-storage-account-shared-access.png)
    - Under **Signing method**, select the **Account key** button.
    - On the **Permissions** menu, select **Create**.
    - Set the **Start** and **Expiry** date and time.
    - Set the allowed IP addresses, if necessary.
    - Under **Allowed protocols**, select the **HTTPS only** button.
6. Click **Generate SAS token and URL**, then copy the **Blob SAS token**.
7. In your container, go to **Settings > Properties**, then copy the **URL** which is needed for the storage account container URL.
8. Navigate to the [Azure Portal](https://portal.azure.com/), and open your virtual machine.
    - Go to the **Operations > Run command > RunShellScript**. This opens the **Run Command Script** screen.
    - Enter the following in the **Linux Shell Script** field:

    ```
    bash /geneos/get-diagnostics.sh --url "<Azure storage account container URL>" --token "<Blob SAS token>"
    ```

9. Once successful, your diagnostics file will be stored in the **Storage container > Storage Explorer** with a filename `netprobe-logs-<timestamp>.tar.gz`.

### Access Azure cloud through a proxy host

Accessing Azure cloud through a proxy can be configured by adding the `https.*` properties in the JVM arguments. For example, you can access the cloud via a proxy host and port by adding the following properties:

```
-Dhttps.proxyHost=webcache.example.com -Dhttps.proxyPort=8080
```

For more information on adding JVM arguments, see [Managed Collection Agent](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#managed-collection-agent).

To learn more about the available properties to enable proxy access, see [Java Networking and Proxies](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html).

## Configure the Azure Monitor collector

The Azure Monitor collector supports Collection Agent publication into Geneos using dynamic managed entities. Setting up this collector in Geneos involves three primary steps:

1. [Set up your Collection Agent plugin](#set-up-your-collection-agent-plugin).
2. [Configure your mappings](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#configure-your-mappings).
3. Configure your other Dynamic Entities in the Gateway, see [Create Dynamic Entities in Collection Agent setup](https://docs.itrsgroup.com/docs/geneos/current/collection/collection-agent/collection-agent-setup/index.html#create-dynamic-entities) for a more detailed procedure.

### Set up your Collection Agent plugin

Use one of the following options listed below to configure the plugin.

- Setting up your collector in the Gateway Setup Editor by adding the following configuration in **Dynamic Entities** > **Collectors**. The available collectors for the Azure Monitor plugin are `AzureEventHubCollector`, `AzureMonitorCollector`, and `AzureCostCollector`. For more information on how to set up your collectors, see [Collectors in Dynamic Entities](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#collectors).
- Adding the following configuration in `collection-agent.yml` file on your local machine.

```yaml
collectors:
 
  - name: azure
    type: plugin
    className: AzureMonitorCollector
 
    # Interval (in millis) between publications (optional, defaults to five minutes)
    collectionInterval: 300000
 
    # The Azure client id that can be used for this application (required)
    clientId: ${env:CLIENT_ID}
 
    # The Azure secret associated with the client id (required)
    clientSecret: ${env:CLIENT_SECRET}
 
    # The Azure tenant id to be monitored (required)
    tenantId: ${env:TENANT_ID}
 
    # The Azure subscription id to be used for monitoring (required)
    subscriptionId: ${env:SUBSCRIPTION_ID}
    
    # Filter resources by resource group name according to the provided Java regex
    resourceGroupFilter: (UAT-group)|(PROD-group)

    # Specify a list of key or value pairs which correspond to Azure resource tags and values 
    tagFilter:
      Dev: (Name 1)|(Name 2)
      Owner: .*

    # Specify a list of tags which will be published as a datapoint property
    publishedTags:
      - Environment
      - Purpose
 
    # Lists the resource type(s) that will be monitored (optional, defaults to listing all available resource types)
    enabledResources:
      - Microsoft.Compute/disks
      - Microsoft.Network/azureFirewalls
```

| Setting | Description |
|-------|-------|
| `enabledResources` | To add more Azure resources to monitor, you can add them in `enabledResources` following this format: `<resource.provider>`/`<resource-type>`. This setting allows you to filter based on the resource type. Without this setting, the Azure plugin will pick up metrics for all available Azure services. See [Monitored Azure Services](#monitored-azure-services) |
| `publishedTags` | This is useful if you want to use a tag in the dynamic entities mapping configuration. If this is not set, no tags will be included in the metrics published. |
| `resourceGroupFilter` | If a resource does not have a tag that is listed in the configuration, then the property will not be included in the metrics published. |
| `tagFilter` | Allows you to monitor only certain resources with tags that match what is configured. A resource will be monitored only if all tags match the resource, for example, the tag is present and the tag value matches the regex provided. |

### Configure your mappings

Use one of the following options listed below to configure your dynamic mappings.

- Adding `templates/azure_config.xml` as an include file in your Gateway. This mapping template also includes sample FKM streams that can be used as a template which can then be customized to handle your intended Events, Logs, and Alarms.


**Caution**

 Beginning Geneos 7.3, this template file has been renamed from `azure_mapping.xml` to `azure_config.xml` to emphasize that it is intended for configuration purposes. Please be aware that this may introduce breaking changes if you are referencing the absolute or relative path of the template file in your setup. 


- Choosing a built-in mapping in **Dynamic Entities Health** > **Mapping**. For more information, see [Mapping and mapping group in Dynamic Entities](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#mapping-and-mapping-group).
- Setting up a custom mapping in **Dynamic Entities Health** > **Mapping**. For more information, see [Custom mappings](https://docs.itrsgroup.com/docs/geneos/collection/azure-monitor/6.7.0/user-guide/azure-monitor/index.html#custom-mappings).


**Note**

  To check if there are any errors in the mapping, you can set up the [Dynamic Entities Health](https://docs.itrsgroup.com/docs/geneos/current/collection/dynamic-entities-health/index.html), check [Azure Monitor API count monitoring](#azure-api-count-monitoring), or look at the [Collection Agent log file](https://docs.itrsgroup.com/docs/geneos/current/collection/collection-agent/collection-agent-setup/index.html#collection-agent-log-file). 


#### Custom mappings

Alternatively, the Azure plugin also allows you to create custom mappings so you can modify the display of information in the Geneos dataview.

The mappings can be configured differently by using available dimensions or properties. All metrics published by the Azure plugin have a `data_kind` of `azure_v1`.

To create custom mappings:

1. Navigate to your Azure mapping in **Dynamic entities > Mappings**.
2. In **Options**, selection **custom**.
3. In the **Geneos items > Label**, enter the following:

- `resource_group` as an entity
- `resource_provider` and `resource_type` as a sampler

![image](https://docscdn.itrsgroup.com/geneos-azure-monitor/images/azure-monitor-custom-mappings.png)

The following metrics dimension or properties can be used to map or filter resources in a custom mapping.

| Metric property | Description |
|-------|-------|
| `resource_provider` | Resource provider values for each service that can be found in [Monitored Azure Services](#monitored-azure-services).
The **builtIn** mapping uses this to group similar resource types in an entity. |
| `resource_type` |  Resource type values for each service that can be found in [Monitored Azure Services](#monitored-azure-services).
The **builtIn** mapping uses this to group similar resource types in an entity. |
| `resource_group` | Corresponds to the resource's resource group.
The **builtIn** mapping uses this as the dataview name. |
| `region` | Region where the resource is in. |
| `name` | Name of the resource. |

Further, the Azure tags for resources will be transferred to metrics which is useful if the Azure estate has its own way of organising resources by tags.

You can also use [Show Dynamic Mappings](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#show-dynamic-mappings) on the metrics to see the dimensions or properties that can be used for the mapping.

The Azure tags will become a property that can be seen in **Show Dynamic Mappings**. Additionally, there are several Azure plugin built-in properties:


**Note**

  Given the nature of the Azure tag having different variations of key-value pairs (depending on how you set this up), when a tag's key clashes with an existing property, the tag will not override the existing property. For example, if you create a tag `data_kind=test`, this will not override the built-in property `data_kind`. 


| Azure built-in property | Description |
|-------|-------|
| Azure Tag | Key-value pair that will be a label-value pair in the dynamic mapping.
For example, the Azure tag `Department=Engineering` becomes `Label : Department Value: Engineering.` |
| `aggregation_type` | Default aggregation type for a specific metric. |
| `region` | Location where the resource resides when deployed in Azure. |

### Example dataview

Once you set up the plugin and mappings successfully, the monitored Azure services including their metrics will display in a dataview in Geneos. In the example below, the Azure resources are sorted according to `resource_provider` as an entity, `resource_type` as a sampler, and `resource_group` as a dataview.

For detailed information about Azure services, see [Services Monitored > Azure Monitor Metrics](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported).

![image](https://docscdn.itrsgroup.com/geneos-azure-monitor/images/azure-monitor-example-dataview.png)

To define how items in the Geneos tree structure are generated from the labels of a datapoint, see [Geneos items in Dynamic Entities](https://docs.itrsgroup.com/docs/geneos/current/processing/configuration/dynamic_entities/index.html#geneos-items).

## Monitored Azure services

The Azure plugin fetches available metrics for Azure resources. The following limitations apply:

- Aggregations are performed using the smallest time grain supported by each metric.
- Only the default aggregation is used for each metric available.
- Some metrics may not be immediately available, which is the expected behaviour of Azure Monitor. Some metrics may be available for premium resources only, or some may be awaiting actions from the user or system to be done on the resource, for example, pulling a docker image from a container registry makes the `SuccessfulPullCount` and `TotalPullCount` metrics available.
- The Azure plugin will gather as many metrics as possible for each collection interval. Data already reported from previous collection intervals or timestamp will no longer be gathered.

For more information, refer to the individual Azure resource documentation listed under [Services Monitored > Azure Monitor Metrics](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported).


**Caution**

  Since the Azure plugin works by calling into the Azure API, you should be aware of the API usage limits. If the API limits are frequently reached, you may want to limit or monitor the metrics collected, see [Azure Monitor API count monitoring](#azure-api-count-monitoring). Alternatively, you can also increase the collection interval time. For more information about API limits, see [Request limits in Azure](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/request-limits-and-throttling). 


The table below lists the Azure Monitor services that this plugin can monitor.

| Azure service | Resource provider | Resource type |
|-------|-------|-------|
| API Management Service | `Microsoft.ApiManagement` | `service` |
| App Service Plans | `Microsoft.Web` | `servicefarms` |
| App Services | `Microsoft.Web` | `sites` |
| Application Gateways | `Microsoft.Network` | `applicationGateways` |
| Application Insights | `Microsoft.Insights` | `components` |
| Automation Accounts | `Microsoft.Automation` | `automationAccounts` |
| Azure Servers | `Microsoft.DBforPostgreSQL` | `servers` |
| Batch Accounts | `Microsoft.Batch` | `batchAccounts` |
| Cognitive Services | `Microsoft.CognitiveServices` | `accounts` |
| Container Groups | `Microsoft.ContainerInstance` | `containerGroups` |
| Container Registries | `Microsoft.ContainerRegistry` | `registries` |
| Cosmos DB accounts | `Microsoft.DocumentDB` | `databaseAccounts` |
| Data Factories | `Microsoft.Datafactory` | `factories` |
| Disks | `Microsoft.Compute` | `disks` |
| DNS Zones | `Microsoft.Network` | `dnszones` |
| Event Hub Namespace | `Microsoft.EventHub` | `namespaces` |
| Express Route Circuits | `Microsoft.Network` | `expressRouteCircuits` |
| Firewalls | `Microsoft.Network` | `azureFirewalls` |
| Front Doors | `Microsoft.Network` | `frontdoors` |
| Function Apps | `Microsoft.Web` | `sites` |
| Key Vaults | `Microsoft.KeyVault` | `vaults` |
| Load Balancers | `Microsoft.Network` | `loadBalancers` |
| Local/Virtual Network Gateway Connections | `Microsoft.Network` | `connections` |
| MariaDB Servers | `Microsoft.DBforMariaDB` | `servers` |
| MySQL Servers | `Microsoft.DBforMySQL` | `servers` |
| Network Interfaces | `Microsoft.Network` | `networkInterfaces` |
| Network Watchers/Connection Monitors | `Microsoft.Network` | `networkWatchers` |
| Search Services | `Microsoft.Search` | `searchServices` |
| Service Bus Namespace | `Microsoft.ServiceBus` | `namespaces` |
| SQL Server/Databases | `Microsoft.Sql` | `servers` |
| SQL Server/Elastic Pools | `Microsoft.Sql` | `servers` |
| Storage Accounts | `Microsoft.Storage` | `storageAccounts` |
| Storage Accounts/ObjectReplicationPolicies | `Microsoft.Storage` | `storageAccounts/objectreplicationpolicies` |
| Synapse Workspaces | `Microsoft.Synapse` | `workspaces` |
| Synapse Workspaces/sqlPools 
**Note**

 Only dedicated SQL pools are monitored. 
| `Microsoft.Synapse` | `workspaces` |
| Synapse Workspaces/bigDataPools | `Microsoft.Synapse` | `workspaces` |
| Traffic Manager Profiles | `Microsoft.Network` | `trafficmanagerprofiles`|
| Virtual Machine Scale Sets | `Microsoft.Compute` | `virtualMachineScaleSets` |
| Virtual Machine Scale Sets/Virtual Machines | `Microsoft.Compute` | `virtualMachineScaleSets` |
| Virtual Machines | `Microsoft.Compute` | `virtualMachines` |
| Virtual Network Gateways | `Microsoft.Network` | `virtualNetworkGateways`|
| Virtual Networks | `Microsoft.Network` | `virtualNetworks` |


**Note**

 The following minimum roles are required in the workspace to monitor the `Synapse Workspaces` service:

- Synapse Monitoring Operator
- Synapse User

These roles can be defined in the **Manage** > **Access control** section of Azure Synapse Studio. 


### Metrics

Each [Azure service](#monitored-azure-services) has its own set of metrics that can be displayed as data in Geneos and in ITRS Analytics. For detailed information about Azure services, see [Services Monitored > Azure Monitor Metrics](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported).

In addition to the default metrics provided by Azure, the following additional metrics are available:

| Azure service | Resource/object | Metric | Metric description |
|-----|-----|----|----|
| Data Factories | Pipeline Run | pipeline_run_duration | Duration of a completed pipeline run. If there are parallel pipeline runs for a pipeline entity, the duration of each pipeline run will be published. |
| Data Factories | Pipeline Run | Succeeded, Failed, Cancelled, Canceling, InProgress, Queued | State of the pipeline runs within the collection interval. |
| Data Factories | Activity Run | activity_run_duration | Duration of a completed activity run. If there are parallel activity runs for each activity entity, the duration of each run will be published. |
| Data Factories | Activity Run | Succeeded, Failed, Cancelled, Canceling, InProgress, Queued | State of the activity runs within the collection interval. |
| Synapse Workspaces | SQL Request | Running, Suspended, Completed, Failed, Canceled | State of SQL requests within the collection interval. |
| Synapse Workspaces | Spark Application | application_total_duration | The latest run duration of the Spark application. |
| Synapse Workspaces | Spark Application | Canceled, Failed, Queued, Running, Stopped, Stopped (session timed out), Submitting, Succeeded | State of Spark applications within the collection interval. |
| Synapse Workspaces | Pipeline Run | pipeline_run_duration | The latest run duration of the pipeline run.                                                                       |
| Synapse Workspaces | Pipeline Run | Succeeded, InProgress, Queued, Failed, Canceling, Cancelled | State of the pipeline runs within the collection interval. |
| Synapse Workspaces | Activity Run | activity_run_duration | The latest run duration of the activity run. |
| Synapse Workspaces | Activity Run | Succeeded, Failed, Queued, Cancelled, In Progress, Inactive, Timed out  | State of the activity runs within the collection interval. |
| Synapse Workspaces | Trigger Run | Failed, Inprogress, Succeeded | State of the trigger run within the collection interval. |

### Log events

Log events are also published, which show details about each resource or object.

| Azure service| Log event name | Log contents | Log description |
|----|----|----|----|
| Data Factories | Pipeline Run | Status, PipelineName, RunID, Duration, RunStart, RunEnd, RunGroupId | Pipeline run details |
| Data Factories | Activity Run | Status, ActivityName, PipelineName, Duration, ActivityRunStart, ActivityRunEnd, ActivityRunId, PipelineRunId | Activity run details |
| Synapse Workspaces | SQL Request | Status, Request ID, Submit Time, End Time, DurationInMs | SQL request details |
| Synapse Workspaces | Spark Application | Status, LivyID, Application, Name, Pool, Type, RunningDuration, QueuedDuration, TotalDuration, SubmitTime, EndTime, Submitter | Spark application details |
| Synapse Workspaces | Pipeline Run | Status, PipelineName, RunId, DurationInMs, RunStart, RunEnd, RunGroupId | Pipeline run details |
| Synapse Workspaces | Activity Run | Status, ActivityName, ActivityRunId, DurationInMs, ActivityRunStart, ActivityRunEnd, PipelineName, PipelineRunId | Activity run details |
| Synapse Workspaces | Trigger Run | Status, TriggerName, TriggerType, TriggerTime, RunId, Pipelines | Trigger run details |

### Dimensions

In addition to the attributes of metrics that Azure Monitor provides, this plugin also collects the following information for each resource.

| Dimension name | Azure services | Dimension description |
|-------|-------|-------|
| `resource_group` | all | Group where the resource belongs. |
| `resource_type` | all | Type of the resource. |
| `resource_provider` | all | Provider of the resource. |
| `name` | all except child resources | Name of the resource. |
| `activity_name` | Data Factory | Name of the [activity](#activity-runs) under the given `pipeline_name` of a data factory. |
| `pipeline_name` | Data Factory | Name of the [pipeline](#pipeline-runs) under the given data factory. |
| `connection_type` | Local Network Gateway/Connections | Type of the connection. |
| `connection_monitor` | Network watchers/Connection monitors | Name of the connection monitor. |
| `network_watcher` | Network watchers/Connection monitors | Name of the connection watcher. |
| `name` | Service Bus Namespace | Name of the Service Bus namespace. |
| `namespace` | Service Bus Queue | Name of the Service Bus namespace. |
| `queue` | Service Bus Queue | Name of the Service Bus queue. |
| `namespace` | Service Bus Topic | Name of the Service Bus namespace. |
| `topic` | Service Bus Topic | Name of the Service Bus Topic. |
| `database` | Sql servers/Databases | Name of the database. |
| `sql_server` | Sql servers/Databases | Name of the parent SQL server. |
| `elastic_pool` | Sql servers/Elastic pools | Name of the elastic pool. |
| `sql_server` | Sql servers/Elastic pools | Name of the parent SQL server. |
| `account` | Storage Account/account | Name of the storage account resource. |
| `blob` | Storage Account/blob | Name of the blob service parent storage account resource. |
| `file` | Storage Account/file | Name of the file service parent storage account resource. |
| `queue` | Storage Account/queue | Name of the queue service parent storage account resource. |
| `table` | Storage Account/table | Name of the table service parent storage account resource. |
| `objectreplicationpolicies` | Storage Account/objectreplicationpolicies | Source and destination storage account pair of the object replication policy. |
| `workspace` | Synapse Workspaces, Synapse Workspaces/sqlPools, Synapse Workspaces/bigDataPools | Name of the Synapse workspace. |
| `pipeline_name` | Synapse Workspaces | Name of the pipeline in Synapse workspace. |
| `activity_name` | Synapse Workspaces | Name of the activity in Synapse workspace. |
| `application` | Synapse Workspaces | Name of the spark application in Synapse workspace. |
| `trigger` | Synapse Workspaces | Name of the trigger in Synapse workspace. |
| `integration_runtime` | Synapse Workspaces | Name of the integration runtime in Synapse workspace. |
| `link_connection` | Synapse Workspaces | Name of the link connection in Synapse workspace. |
| `vm` | Virtual machine scale sets/Virtual machines | Name of the Virtual Machine. |
| `vmss` | Virtual machine scale sets/Virtual machines | Name of the parent Virtual Machine Scale Set. |
| `connection_type` | Virtual Network Gateway/Connections | Type of the connection. |
| `app` | Web/sites | Name of the app service. |
| `functionapp` | Web/sites | Name of the function app. |

### Additional attributes

In addition to the attributes of metrics that Azure Monitor provides, this plugin also collects the following information for each resource.

| Azure service | Attribute | Attribute description |
|-------|-------|-------|
| API Management Services | `sku_capacity` | Capacity of the SKU or the number of deployed units of the SKU. |
| API Management Services | `sku_name` | Name of the API Management Service SKU. |
| App Service Plans | `capacity` | Capacity of the App Service Plan. |
| App Service Plans | `max_instances` | Maximum number of instances that can be assigned to the App Service Plan. |
| App Service Plans | `number_of_web_apps` | Number of web apps assigned to the App Service Plan. |
| App Service Plans | `operating_system` | Operating system where the app is running on. |
| App Services | `default_hostname` | Default hostname of the app. |
| App Services | `state` | State of the app. |
| App Services | `app_service_plan` | Name of the app's App Service Plan. |
| Application Gateway | `operational_state` | Operational state of the application gateway. |
| Application Insights | `app_id` | Application Insights Unique ID of the application. |
| Application Insights | `app_type` | Type of application being monitored. |
| Application Insights | `provisioning_state` | State of the app whether it has been provisioned within its defined resource group. |
| Application Insights | `sampling_percentage` | Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. |
| Automation Account | `creation_time` | Account creation date. |
| Automation Account | `last_modified_time` | Account last modified date. |
| Batch Accounts | `account_endpoint` | Batch account endpoint. |
| Cognitive Services | `endpoint` | Endpoint of the created Azure Cognitive Services account. |
| Cognitive Services | `kind` | Resource kind. |
| Cognitive Services | `public_network_access` | States if public endpoint access is allowed. |
| Cognitive Services | `sku_name` | SKU Name of an Azure Cognitive Services account. |
| Cognitive Services | `sku_tier` | SKU Tier of an Azure Cognitive Services account. |
| Container Groups | `state` | State of the container group. |
| Container Groups | `os_type` | Base level OS type required by the containers in the group. |
| Container Groups | `ip_address` | IP address. |
| Container Registries | `login_server_url` | URL that can be used to log into the container registry. |
| Cosmos DB accounts | `document_endpoint` | Connection endpoint for the Cosmos DB database account. |
| Data Factory | `datafactory_version` | Version of the data factory. |
| Data Factory | `create_time` | Creation time of the data factory. |
| Data Factory | `[annotation_name]` | Annotations retrieved from Azure Data Factory pipeline runs, displayed as attribute keys with blank values. These annotations provide additional context and metadata about each pipeline run. |
| Data Factory | `[property_name]` | Additional properties retrieved from Azure Data Factory activity runs. These properties provide additional context and metadata about each activity run. |
| DB For MariaDB | `fqdn` | Fully Qualified Domain Name. |
| DB For MariaDB | `version` | MariaDB version. |
| DB For MySQL | `fqdn` | Fully Qualified Domain Name. |
| DB For MySQL | `version` | MySQL version. |
| DB For Postgresql | `fqdn` | Fully Qualified Domain Name. |
| DB For Postgresql | `version` | Postgresql version. |
| Disks | `size_in_gb` | Size of the disk in GB. |
| DNS Zones | `zone_type` | DNS Zone type. |
| DNS Zones | `record_sets_count` | Current number of record sets in the DNS zone. |
| DNS Zones | `record_sets_max_count` | Maximum number of record sets that can be created in the DNS. |
| Event Hub Namespaces | `service_bus_endpoint` | Service bus endpoint associated with the namespace. |
| Express Route Circuits | `circuit_provisioning_state` | `CircuitProvisioningState` state of the resource. |
| Firewalls | `provisioning_state` | Provisioning state of the Azure firewall resource. |
| Firewalls | `sku_name` | Name of the Azure Firewall SKU. |
| Firewalls | `sku_tier` | Tier of the Azure Firewall SKU. |
| Firewalls | `threat_intel_mode` | Operation mode for Threat Intelligence. |
| Frontdoors | `cName` | The host that each `frontendEndpoint` must `CNAME` to. |
| Function Apps | `default_hostname` | Default hostname of the app. |
| Function Apps | `state` | State of the function app. |
| Function Apps | `app_service_plan` | Name of the app's App Service. |
| Key Vaults | N/A |  |
| Load balancers | N/A |  |
| Local network Gateways/Connections | `network_gateway1` | Name of the virtual network gateway. |
| Local network Gateways/Connections | `network_gateway2` | Name of the local network gateway. |
| Network interfaces | `vm_id` | Resource ID of the virtual machine the network interface is associated with. |
| Network interfaces | `public_ip_*` | Public IP address the network interface is associated with. |
| Network Watchers | `connection_monitor_count` | Current number of connection monitors in the network watcher. |
| Network Watchers/Connection Monitors | `interval_in_secs` | Monitoring interval in seconds. |
| Network Watchers/Connection Monitors | `status` | Monitoring status of the connection monitor. |
| Search Services | `status` | Status of the search service. |
| Service Bus Namespace | `price_tier` | Price tier of the service bus. |
| Service Bus Queue | `status` | Status of the Queue under a given service. |
| Service Bus Topic | `status` | Status of the Topic under a given service bus. |
| SQL Server | `state` | State of the SQL Server. |
| SQL Server/Database | `elastic_pool` | Name of elastic pool associated with the SQL database. |
| SQL Server/Elastic Pools | `state` | State of the elastic pool. |
| Storage accounts | `primary_endpoint_blob` | Primary blob endpoint of the storage account. |
| Storage accounts | `primary_endpoint_file` | Primary file endpoint of the storage account. |
| Storage accounts | `primary_endpoint_queue` | Primary queue endpoint of the storage account. |
| Storage accounts | `primary_endpoint_table` | Primary table endpoint of the storage account. |
| Storage accounts | `primary_endpoint_dfs` | Primary dfs endpoint of the storage account. |
| Storage accounts | `primary_endpoint_web` | Primary web endpoint of the storage account. |
| Storage accounts/objectreplicationpolicies | `policyId` | Policy ID of the object replication policy. |
| Synapse Workspaces | `data_lake_filesystem` | File system name of Data Lake storage. |
| Synapse Workspaces | `data_lake_url` | Account url of Data Lake storage. |
| Synapse Workspaces | `*_endpoint` | Connectivity endpoints. |
| Synapse Workspaces/sqlPools | `creation_date` | Date the SQL pool was created. |
| Synapse Workspaces/sqlPools | `max_size` | Maximum size in bytes. |
| Synapse Workspaces/bigDataPools | `creation_date` | Date the Apache Spark pool was created. |
| Synapse Workspaces/bigDataPools | `node_count` | Number of nodes in the Apache Spark pool. |
| Synapse Workspaces/bigDataPools | `node_size` | Level of compute power that each node in the Apache Spark pool has. |
| Synapse Workspaces/integrationruntimes | `type` | Type of integration runtime. |
| Synapse Workspaces/linkconnections | `continuous_run_id` | Continuous run ID of the link connection. |
| Synapse Workspaces/linkconnections | `source_name` | Source reference linked service name. |
| Synapse Workspaces/linkconnections | `target_name` | Target reference linked service name. |
| Traffic Manager Profiles | N/A |  |
| Virtual Machine Scale Sets | `instances` | Number of virtual machine instances in the scale set. |
| Virtual Machine Scale Sets/Virtual Machines | `power_state` | Power state of the virtual machine instance. |
| Virtual Machine Scale Sets/Virtual Machines | `computer_name` | Computer name of the virtual machine instance. |
| Virtual Machine Scale Sets/Virtual Machines | `os_type` | Operating system of this virtual machine. |
| Virtual Machines | `os_type` | Operating system of this virtual machine. |
| Virtual Network Gateways | `gateway_type` | Virtual Network Gateway type. |
| Virtual Network Gateways | `sku_name` | SKU name of the Virtual network gateway. |
| Virtual Network Gateways | `sku_tier` | SKU tier of the Virtual network gateway. |
| Virtual Network Gateways/Connections | `network_gateway1` | Name of the first virtual network gateway. |
| Virtual Network Gateways/Connections | `network_gateway2` | Name of the second virtual network gateway. |
| Virtual Networks | `total_address_spaces` | Total number of address spaces of the virtual network. |
| Virtual Networks | `total_peerings` | Total number of peering of the virtual network. |
| Virtual Networks | `total_subnets` | Total number of subnets of the virtual network. |
| Virtual Networks | `ddos_protection_enabled` | True if DDoS protection is enabled for all protected resources in the virtual network. |
| Virtual Networks | `vm_protection_enabled` | True if VM protection is enabled for all the subnets in the virtual network. |

### Azure API count monitoring

 You can also monitor the self monitoring API stats and other metrics of the Azure plugin. This is useful to keep a count of the number of API requests and current monitored resources.

A **selfMonitoring** managed entity will be available in the Active Console under the **ITRS** managed entity when you configure correctly the Azure plugin. The **selfMonitoring** managed entity does not require any further configuration, or parameter to be set in the YAML file.

![image](https://docscdn.itrsgroup.com/geneos-azure-monitor/images/azure-monitor-self-monitoring-2-1-0.png)

This dataview is created based on these dimensions and their mappings:

- `resource_group`: Azure Monitor Collector
- `resource_type`: selfMonitoring
- `resource_provider`: ITRS

The **selfMonitoring** managed entity displays a dataview that has the following metrics:

| Field | Description |
|-------|-------|
| rowname | Plugin name indicated in the `collection-agent.yml`. This follows the format `<plugin name - ITRS>`. |
| subscription_id | Subscription ID indicated in the `collection-agent.yml`. |
| total_resource_groups | Total number of resource groups available on your Azure estate.
This resets every collection interval. |
| total_monitored_resource_groups | Total number of resource groups that match the `resourceGroupFilter` parameter in the `collection-agent.yml`. If `resourceGroupFilter` is not set, then the value should be equal to `total_resource_groups`.
This resets every collection interval. |
| total_monitored_resource_types | Total number of resource types that the plugin is currently monitoring. |
| total_enabled_resource_types | Total number of resource types listed on `enabledResources` parameter in the `collection-agent.yml`. |
| total_monitored_resources | Total number of resources [Monitored Azure services](#monitored-azure-services) that have metrics and are displayed on dataviews.
This resets every collection interval. |
| collection_interval | Collection interval indicated in the `collection-agent.yml`. |
| total_api_count_per_collection_interval | Total number of Azure API calls made by Azure Monitor per collection interval. |
| total_api_count_rate_per_hour | Total number of Azure API calls made by Azure Monitor per hour. |

