usages_by_instance_pools

Creates, updates, deletes, gets or lists a usages_by_instance_pools resource.

Overview

Name	usages_by_instance_pools
Type	Resource
Id	azure.sql.usages_by_instance_pools

Fields

The following fields are returned by SELECT queries:

list

Successfully retrieved the instance pool usages.

Name	Datatype	Description
id	string	Resource ID.
name	object	Resource name.
currentValue	integer (int32)	Usage current value.
limit	integer (int32)	Usage limit.
requestedLimit	integer (int32)	Usage requested limit.
type	string	Resource type.
unit	string	Usage unit.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, instancePoolName, subscriptionId	expandChildren	Gets all instance pool usage metrics

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancePoolName	string	The name of the instance pool to be retrieved.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
expandChildren	boolean	Optional request parameter to include managed instance usages within the instance pool.

SELECT examples

list

Gets all instance pool usage metrics

SELECT
id,
name,
currentValue,
limit,
requestedLimit,
type,
unit
FROM azure.sql.usages_by_instance_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND instancePoolName = '{{ instancePoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND expandChildren = '{{ expandChildren }}'
;