usages

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

Overview

Name	usages
Type	Resource
Id	azure.sql.usages

Fields

The following fields are returned by SELECT queries:

list_by_instance_pool

Name	Datatype	Description
id	string	Resource ID.
name	object	Resource name.
currentValue	integer	Usage current value.
limit	integer	Usage limit.
requestedLimit	integer	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_by_instance_pool	select	resource_group_name, instance_pool_name, subscription_id	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
instance_pool_name	string	The name of the instance pool to be retrieved. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
expandChildren	boolean	Optional request parameter to include managed instance usages within the instance pool. Default value is None.

SELECT examples

list_by_instance_pool

Gets all instance pool usage metrics.

SELECT
id,
name,
currentValue,
limit,
requestedLimit,
type,
unit
FROM azure.sql.usages
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_pool_name = '{{ instance_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND expandChildren = '{{ expandChildren }}'
;