---
title: "Host Template: Cloud - Azure - SQL - Hyperscale"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-azure-opspack/cloud-azure-sql-hyperscale-host-template/index.html"
---## Overview

Azure SQL Database is a cloud database service from Microsoft. SQL Database provides web-facing database functionality as a utility service where you pay only for what you use. Cloud-based database solutions such as SQL Database provide many benefits such as rapid provisioning, cost-effective scalability, high availability, and reduced management overhead. This Host Template only applies to Azure SQL databases that are under the Hyperscale resource model.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| Azure - SQL - Hyperscale - Allocated Storage | The allocated data storage
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | B |
| Azure - SQL - Hyperscale - CPU Usage | The CPU usage of the database
[Default Timespan = 5mins, Default Check Interval = 5mins] | cpu_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - CPU Used | The CPU limit and number of CPUs used
[Default Timespan = 60mins, Default Check Interval = 60mins] | N/A | N/A |
| Azure - SQL - Hyperscale - Connections | The number of successful, failed and blocked connections
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | N/A |
| Azure - SQL - Hyperscale - Data IO Percent | The data IO percentage
[Default Timespan = 5mins, Default Check Interval = 5mins] | physical_data_read_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Deadlocks | The number of deadlocks
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | N/A |
| Azure - SQL - Hyperscale - Log IO Percent | The log IO percentage
[Default Timespan = 5mins, Default Check Interval = 5mins] | log_write_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Process CPU Usage | The CPU usage for the SQL Server process
[Default Timespan = 5mins, Default Check Interval = 5mins] | sqlserver_process_core_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Process Memory Usage | The memory usage for the SQL Server process
[Default Timespan = 5mins, Default Check Interval = 5mins] | sqlserver_process_memory_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Sessions Percent | The percentage of sessions
[Default Timespan = 5mins, Default Check Interval = 5mins] | sessions_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Tempdb Percent | The Tempdb log used percentage
[Default Timespan = 5mins, Default Check Interval = 5mins] | tempdb_log_used_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - Tempdb Used | The Tempdb data size and log size
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | B |
| Azure - SQL - Hyperscale - Workers Percent | The percentage of workers
[Default Timespan = 5mins, Default Check Interval = 5mins] | workers_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - SQL - Hyperscale - XTP Storage Percent | The percentage of XTP (in-memory OLTP) storage used
[Default Timespan = 5mins, Default Check Interval = 5mins] | xtp_storage_percent: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |


**Note**


The "Default Timespan" given for these Service Checks refers to the time period we use when retrieving metrics from Azure.




**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



### Dynamic Thresholds Support

Some Service Checks within this Host Template support [Dynamic Thresholds for Opsview Enterprise](https://docs.itrsgroup.com/docs/opsview/6.11.7/integrations/dynamic-thresholds/configuring-dynamic-thresholds/index.html#configure-service-checks).

## Prerequisites for monitoring

### Provide Subscription Access

To use this Host Template you will need to provide access to the subscription you wish to monitor.
Navigate to the **Subscriptions** section and select your Subscription.

In the Subscription to be monitored, click **Access Control (IAM)**.

Then click the **Add** button, select the required role and select the application, once for each of the following roles:

- **Reader**

![Add Subscription to Application](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-add_subscription_1.png)

![Add Subscription to Application](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-add_subscription_2.png)

Repeat these steps for each subscription you wish to monitor.

## Usage Instructions

Please review the overall [Cloud - Azure Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-azure-opspack/cloud-azure-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Cloud - Azure - SQL - Hyperscale** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**AZURE_CREDENTIALS**](#azure_credentials)
- [**AZURE_RESOURCE_DETAILS**](#azure_resource_details)
- [**AZURE_SQL_DATABASE_DETAILS**](#azure_sql_database_details)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-output-cloud-azure-sql-hyperscale.png)

## Additional Information

**Note:**

Unlike in other Azure Host Templates, the **Resource Name** field (Arg2) of the [**AZURE_RESOURCE_DETAILS**](#azure_resource_details) variable should be set to the name of the **SQL server** while the **SQL Database Name** field (Arg1) of the [**AZURE_SQL_DATABASE_DETAILS**](#azure_sql_database_details) variable should be set to the name of the **SQL Database** (See 'Add and configure variables' for further details).

![Host Variable Details](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-variable-AZURE_RESOURCE_DETAILS-cloud-azure-sql.png)

Here the **SQL Server** name is shown in **blue** while the **SQL Database** name is shown in **red**.

## Available Variables

### AZURE_CREDENTIALS

The Value is not used and therefore can be set to anything. Override the arguments with your Azure Credentials.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Credentials | The credentials for your Azure Subscription |
| `--subscription-id` | Arg1 | Subscription ID | The Subscription ID of your Azure Subscription |
| `--client-id` | Arg2 | Client ID | The Client ID of your Azure Subscription |
| `--secret-key` | Arg3 | Secret Key | The Secret Key of your Azure Subscription |
| `--tenant-id` | Arg4 | Tenant ID | The Tenant ID of your Azure Subscription |

### AZURE_RESOURCE_DETAILS

The Value is not used and therefore can be set to anything. Override the arguments with your Azure Resource Details.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Resource Details | The details of your Azure Resource |
| `--resource-group` | Arg1 | Resource Group | Name of the Azure resource group of your resource |
| `--resource-name` | Arg2 | Resource Name | Name of the Azure resource to be monitored |

### AZURE_SQL_DATABASE_DETAILS

The Value is not used and therefore can be set to anything. Override the arguments with your SQL Database Details.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | SQL Database Details | The details of your Azure SQL Database |
| `--sql-db-name` | Arg1 | SQL Database Name | The name of your Azure SQL Database |

## Plugin help

Plugin: `check_azure`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| Azure - SQL - Hyperscale - Allocated Storage | `SQL.Hyper.Allocated.Storage` |
| Azure - SQL - Hyperscale - CPU Usage | `SQL.Hyper.CPU.Percent` |
| Azure - SQL - Hyperscale - CPU Used | `SQL.Hyper.CPU.Used` |
| Azure - SQL - Hyperscale - Connections | `SQL.Hyper.Connections` |
| Azure - SQL - Hyperscale - Data IO Percent | `SQL.Hyper.Data.IO.Percent` |
| Azure - SQL - Hyperscale - Deadlocks | `SQL.Hyper.Deadlocks` |
| Azure - SQL - Hyperscale - Log IO Percent | `SQL.Hyper.Log.IO.Percent` |
| Azure - SQL - Hyperscale - Process CPU Usage | `SQL.Hyper.Process.CPU.Usage` |
| Azure - SQL - Hyperscale - Process Memory Usage | `SQL.Hyper.Process.Memory.Usage` |
| Azure - SQL - Hyperscale - Sessions Percent | `SQL.Hyper.Sessions.Percent` |
| Azure - SQL - Hyperscale - Tempdb Percent | `SQL.Hyper.Tempdb.Percent` |
| Azure - SQL - Hyperscale - Tempdb Used | `SQL.Hyper.Tempdb.Used` |
| Azure - SQL - Hyperscale - Workers Percent | `SQL.Hyper.Workers.Percent` |
| Azure - SQL - Hyperscale - XTP Storage Percent | `SQL.Hyper.XTP.Storage.Percent` |


