Usages - List By Subscription

Služba:: Search Management

Verze rozhraní API:: 2026-11-01

Získejte seznam všech kvót Azure AI Vyhledávač v rámci předplatného.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages?api-version=2026-11-01

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
location	path	True	string minLength: 1	Název oblasti Azure.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Odpovědi

Název	Typ	Description
200 OK	QuotaUsagesListResult	Požadavek byl úspěšný.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 služby Azure Active Directory.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název	Description
user_impersonation	vydávat se za svůj uživatelský účet

Příklady

GetQuotaUsagesList

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Search/locations/westus/usages?api-version=2026-11-01

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get a list of all Azure AI Search quota usages across the subscription.
 *
 * @summary get a list of all Azure AI Search quota usages across the subscription.
 * x-ms-original-file: 2026-11-01/GetQuotaUsagesList.json
 */
async function getQuotaUsagesList() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.usages.listBySubscription("westus")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "nextLink": null,
  "value": [
    {
      "name": {
        "localizedValue": "F - Free",
        "value": "free"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/free",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "B - Basic",
        "value": "basic"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/basic",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "S - Standard",
        "value": "standard"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "S2 - Standard2",
        "value": "standard2"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard2",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "S3 - Standard3",
        "value": "standard3"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard3",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "L1 - Storage Optimized",
        "value": "storageOptimizedL1"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/storageOptimizedL1",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "L2 - Storage Optimized",
        "value": "storageOptimizedL2"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/storageOptimizedL2",
      "limit": 16,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "SL - Serverless",
        "value": "serverless"
      },
      "currentValue": 8,
      "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/serverless",
      "limit": 16,
      "unit": "Count"
    }
  ]
}

Definice

Název	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
QuotaUsageResult	Popisuje využití kvóty pro konkrétní skladovou položku.
QuotaUsageResultName	Informace o názvu SKU, včetně jeho identifikátoru a lokalizovaného zobrazovaného jména.
QuotaUsagesListResult	Odpověď obsahující informace o využití kvóty pro všechny podporované skladové položky služby Azure AI Vyhledávač

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Název	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Název	Typ	Description
code	string	Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které souvisejí s touto chybou.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název chybné vlastnosti).

QuotaUsageResult

Objekt

Popisuje využití kvóty pro konkrétní skladovou položku.

Název	Typ	Description
currentValue	integer (int32)	Aktuálně použitá hodnota pro konkrétní skladovou položku vyhledávání.
id	string	ID zdroje endpointu SKU pro využití kvóty pro Microsoft. Poskytovatel vyhledávání.
limit	integer (int32)	Limit kvóty pro konkrétní skladovou položku vyhledávání.
name	QuotaUsageResultName	Informace o názvu SKU aktuální vyhledávací služby.
unit	string	Měrná jednotka pro skladovou položku vyhledávání.

QuotaUsageResultName

Objekt

Informace o názvu SKU, včetně jeho identifikátoru a lokalizovaného zobrazovaného jména.

Název	Typ	Description
localizedValue	string	Lokalizovaná řetězcová hodnota pro název skladové položky.
value	string	Název SKU podporuje Azure AI Vyhledávač.

QuotaUsagesListResult

Objekt

Odpověď obsahující informace o využití kvóty pro všechny podporované skladové položky služby Azure AI Vyhledávač

Název	Typ	Description
nextLink	string	Adresa URL požadavku, která se dá použít k dotazování na další stránku využití kvót. Vrátí se, když celkový počet požadovaných využití kvóty překročí maximální velikost stránky.
value	QuotaUsageResult[]	Využití kvót pro skladové položky podporované službou Azure AI Vyhledávač