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

OK.

Name	Datatype	Description
name	object	The name information for the metric.
currentValue	number (double)	Current value for this metric.
limit	number (double)	Maximum value for this metric.
nextResetTime	string	Next reset time for current quota.
quotaPeriod	string	The quota period used to summarize the usage values.
status	string	Cognitive Services account quota usage status.
unit	string	The unit of the metric.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, location	$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	Resource location.
subscriptionId	string	The ID of the target subscription.
$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).

SELECT examples

list

Get usages for the requested subscription

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