usages

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

Overview

Name	usages
Type	Resource
Id	azure.search.usages

Fields

The following fields are returned by SELECT queries:

list_by_subscription

Name	Datatype	Description
id	string	The resource ID of the quota usage SKU endpoint for Microsoft.Search provider.
name	object	The SKU name information of the current search service.
currentValue	integer	The currently used up value for the particular search SKU.
limit	integer	The quota limit for the particular search SKU.
unit	string	The unit of measurement for the search SKU.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_subscription	select	location, subscription_id		Get a list of all Azure AI Search quota usages across the subscription.
usage_by_subscription_sku	exec	location, sku_name, subscription_id		Gets the quota usage for a search SKU in the given 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 name of the Azure region. Required.
sku_name	string	The unique SKU name that identifies a billable tier. Required.
subscription_id	string

SELECT examples

list_by_subscription

Get a list of all Azure AI Search quota usages across the subscription.

SELECT
id,
name,
currentValue,
limit,
unit
FROM azure.search.usages
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

usage_by_subscription_sku

Gets the quota usage for a search SKU in the given subscription.

EXEC azure.search.usages.usage_by_subscription_sku 
@location='{{ location }}' --required, 
@sku_name='{{ sku_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;