usages

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

Overview

Name	usages
Type	Resource
Id	azure.cognitive_services.usages

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	object	The name information for the metric.
currentValue	number	Current value for this metric.
limit	number	Maximum value for this metric.
nextResetTime	string	Next reset time for current quota.
quotaPeriod	string	The quota period used to summarize the usage values.
scopeId	string	The scope identifier of the quota usage.
scopeType	string	The scope type of the quota usage. Known values are: "Regional", "Global", "DataZone", and "Classic". (Regional, Global, DataZone, Classic)
status	string	Cognitive Services account quota usage status. Known values are: "Included", "Blocked", "InOverage", and "Unknown". (Included, Blocked, InOverage, Unknown)
unit	string	The unit of the metric. Known values are: "Count", "Bytes", "Seconds", "Percent", "CountPerSecond", "BytesPerSecond", and "Milliseconds". (Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond, Milliseconds)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	location, subscription_id	$filter	Get usages for the requested subscription.

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
location	string	The location name. Required.
subscription_id	string
$filter	string	An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). Default value is None.

SELECT examples

list

Get usages for the requested subscription.

SELECT
name,
currentValue,
limit,
nextResetTime,
quotaPeriod,
scopeId,
scopeType,
status,
unit
FROM azure.cognitive_services.usages
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;