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

The operation succeeded. The response contains the list of all search service quota usages for the given subscription.

Name	Datatype	Description
id	string	The resource ID of the quota usage SKU endpoint for Microsoft.Search provider.
name	object	The name of the SKU supported by Azure AI Search.
currentValue	integer (int32)	The currently used up value for the particular search SKU.
limit	integer (int32)	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, subscriptionId	x-ms-client-request-id	Get a list of all Azure AI Search quota usages across the 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 unique location name for a Microsoft Azure geographic region.
subscriptionId	string	The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.
x-ms-client-request-id	string (uuid)	A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

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 subscriptionId = '{{ subscriptionId }}' -- required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
;