Skip to main content

accounts_usages

Creates, updates, deletes, gets or lists an accounts_usages resource.

Overview

Nameaccounts_usages
TypeResource
Idazure.cognitive_services.accounts_usages

Fields

The following fields are returned by SELECT queries:

The usages for Cognitive Services account were retrieved successfully.

NameDatatypeDescription
nameobjectThe name information for the metric.
currentValuenumber (double)Current value for this metric.
limitnumber (double)Maximum value for this metric.
nextResetTimestringNext reset time for current quota.
quotaPeriodstringThe quota period used to summarize the usage values.
statusstringCognitive Services account quota usage status.
unitstringThe unit of the metric.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectresourceGroupName, accountName, subscriptionId$filterGet usages for the requested Cognitive Services account

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.

NameDatatypeDescription
accountNamestringThe name of Cognitive Services account.
resourceGroupNamestringThe name of the resource group. The name is case insensitive.
subscriptionIdstringThe ID of the target subscription.
$filterstringAn 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

Get usages for the requested Cognitive Services account

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