Skip to main content

usage_by_subscription_skus

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

Overview

Nameusage_by_subscription_skus
TypeResource
Idazure.search.usage_by_subscription_skus

Fields

The following fields are returned by SELECT queries:

The operation succeeded. The response contains the quota usage of a search service sku for the given subscription.

NameDatatypeDescription
idstringThe resource ID of the quota usage SKU endpoint for Microsoft.Search provider.
nameobjectThe name of the SKU supported by Azure AI Search.
currentValueinteger (int32)The currently used up value for the particular search SKU.
limitinteger (int32)The quota limit for the particular search SKU.
unitstringThe unit of measurement for the search SKU.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlocation, subscriptionId, skuNamex-ms-client-request-idGets 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.

NameDatatypeDescription
locationstringThe unique location name for a Microsoft Azure geographic region.
skuNamestringThe unique SKU name that identifies a billable tier.
subscriptionIdstringThe 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-idstring (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

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

SELECT
id,
name,
currentValue,
limit,
unit
FROM azure.search.usage_by_subscription_skus
WHERE location = '{{ location }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND skuName = '{{ skuName }}' -- required
AND x-ms-client-request-id = '{{ x-ms-client-request-id }}'
;