accounts_usages
Creates, updates, deletes, gets or lists an accounts_usages
resource.
Overview
Name | accounts_usages |
Type | Resource |
Id | azure.cognitive_services.accounts_usages |
Fields
The following fields are returned by SELECT
queries:
- list
The usages for Cognitive Services account were retrieved successfully.
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 | resourceGroupName , accountName , subscriptionId | $filter | Get 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.
Name | Datatype | Description |
---|---|---|
accountName | string | The name of Cognitive Services account. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
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 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 }}'
;