Usages - List By Subscription

Dienst:: Search Management

API-Version:: 2023-11-01

Ruft eine Liste aller Suchkontingentnutzungen im angegebenen Abonnement ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Der eindeutige Standortname für eine geografische Microsoft Azure-Region.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API, den Befehlszeilentools oder dem Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Antworten

Name	Typ	Beschreibung
200 OK	QuotaUsagesListResult	Der Vorgang war erfolgreich. Die Antwort enthält die Liste aller Suchkontingentverwendungen für das angegebene Abonnement.
Other Status Codes	CloudError	Unerwarteter Fehler während des Vorgangs.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsfluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetQuotaUsagesList

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/locations/westus/usages?api-version=2023-11-01

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
Name	Der Name der SKU, die von Azure AI Search unterstützt wird.
QuotaUsageResult	Beschreibt die Kontingentverwendung für eine bestimmte SKU.
QuotaUsagesListResult	Antwort, die die Informationen zur Kontingentnutzung für alle unterstützten SKUs von Azure AI Search enthält.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

Name

Objekt

Der Name der SKU, die von Azure AI Search unterstützt wird.

Name	Typ	Beschreibung
localizedValue	string	Der lokalisierte Zeichenfolgenwert für den SKU-Namen.
value	string	Der von Azure AI Search unterstützte SKU-Name.

QuotaUsageResult

Objekt

Beschreibt die Kontingentverwendung für eine bestimmte SKU.

Name	Typ	Beschreibung
currentValue	integer (int32)	Der aktuell verwendete Wert für die bestimmte Such-SKU.
id	string	Die Ressourcen-ID des SKU-Endpunkts für die Kontingentverwendung für den Microsoft.Search-Anbieter.
limit	integer (int32)	Das Kontingentlimit für die bestimmte Such-SKU.
name	Name	Der Name der SKU, die von Azure AI Search unterstützt wird.
unit	string	Die Maßeinheit für die Such-SKU.

QuotaUsagesListResult

Objekt

Antwort, die die Informationen zur Kontingentnutzung für alle unterstützten SKUs von Azure AI Search enthält.

Name	Typ	Beschreibung
nextLink	string	Anforderungs-URL, die zum Abfragen der nächsten Seite mit Kontingentverwendungen verwendet werden kann. Wird zurückgegeben, wenn die Gesamtzahl der angeforderten Kontingentverwendungen die maximale Seitengröße überschreitet.
value	QuotaUsageResult[]	Die Kontingentverwendungen für die skUs, die von Azure AI Search unterstützt werden.