Usages - List By Subscription

Service:: Search Management

API-versie:: 2026-11-01

Bekijk een lijst van alle Azure AI Zoeken quota-gebruik binnen het abonnement.

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

URI-parameters

Naam	In	Vereist	Type	Description
location	path	True	string minLength: 1	De naam van de Azure-regio.
subscriptionId	path	True	string (uuid)	De ID van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Naam	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Naam	Type	Description
200 OK	QuotaUsagesListResult	De aanvraag is voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Naam	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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"
    }
  ]
}

Definities

Naam	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
QuotaUsageResult	Beschrijft het quotumgebruik voor een bepaalde SKU.
QuotaUsageResultName	De SKU-naaminformatie, inclusief de identificatie en de gelokaliseerde weergavenaam.
QuotaUsagesListResult	Antwoord met de quotumgebruiksgegevens voor alle ondersteunde SKU's van Azure AI Zoeken.

CloudError

Object

Bevat informatie over een API-fout.

Naam	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Naam	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

QuotaUsageResult

Object

Beschrijft het quotumgebruik voor een bepaalde SKU.

Naam	Type	Description
currentValue	integer (int32)	De momenteel gebruikte waarde voor de specifieke zoek-SKU.
id	string	De resource ID van het quotagebruik SKU-eindpunt voor Microsoft. Zoek naar provider.
limit	integer (int32)	De quotumlimiet voor de specifieke zoek-SKU.
name	QuotaUsageResultName	De SKU-naaminformatie van de huidige zoekdienst.
unit	string	De maateenheid voor de zoek-SKU.

QuotaUsageResultName

Object

De SKU-naaminformatie, inclusief de identificatie en de gelokaliseerde weergavenaam.

Naam	Type	Description
localizedValue	string	De gelokaliseerde tekenreekswaarde voor de SKU-naam.
value	string	De SKU-naam wordt ondersteund door Azure AI Zoeken.

QuotaUsagesListResult

Object

Antwoord met de quotumgebruiksgegevens voor alle ondersteunde SKU's van Azure AI Zoeken.

Naam	Type	Description
nextLink	string	Aanvraag-URL die kan worden gebruikt om een query uit te voeren op de volgende pagina met quotumgebruiken. Geretourneerd wanneer het totale aantal aangevraagde quotumgebruiken de maximale paginagrootte overschrijdt.
value	QuotaUsageResult[]	Het quotumgebruik voor de SKU's die worden ondersteund door Azure AI Zoeken.