Usages - List By Subscription

Tjänst:: Search Management

API-version:: 2025-05-01

Hämta en lista över alla användningar av Azure AI Search-kvoter i prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
location	path	True	string minLength: 1	Namnet på Azure-regionen.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Ett klientgenererat GUID-värde som identifierar den här begäran. Om det anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Svar

Name	Typ	Description
200 OK	QuotaUsagesListResult	Begäran har slutförts.
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GetQuotaUsagesList

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

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/GetQuotaUsagesList.json
func ExampleUsagesClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUsagesClient().NewListBySubscriptionPager("westus", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsearch.UsagesClientListBySubscriptionResponse{
		// 	QuotaUsagesListResult: armsearch.QuotaUsagesListResult{
		// 		Value: []*armsearch.QuotaUsageResult{
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("F - Free"),
		// 					Value: to.Ptr("free"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/free"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("B - Basic"),
		// 					Value: to.Ptr("basic"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/basic"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("S - Standard"),
		// 					Value: to.Ptr("standard"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("S2 - Standard2"),
		// 					Value: to.Ptr("standard2"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard2"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("S3 - Standard3"),
		// 					Value: to.Ptr("standard3"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/standard3"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("L1 - Storage Optimized"),
		// 					Value: to.Ptr("storageOptimizedL1"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/storageOptimizedL1"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 			{
		// 				Name: &armsearch.QuotaUsageResultName{
		// 					LocalizedValue: to.Ptr("L2 - Storage Optimized"),
		// 					Value: to.Ptr("storageOptimizedL2"),
		// 				},
		// 				CurrentValue: to.Ptr[int32](8),
		// 				ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/storageOptimizedL2"),
		// 				Limit: to.Ptr[int32](16),
		// 				Unit: to.Ptr("Count"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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

Exempelsvar

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

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
QuotaUsageResult	Beskriver kvotanvändningen för en viss SKU.
QuotaUsageResultName	SKU-namninformationen, inklusive dess identifierare och lokaliserade visningsnamn.
QuotaUsagesListResult	Svar som innehåller information om kvotanvändning för alla SKU:er som stöds i Azure AI Search.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

QuotaUsageResult

Objekt

Beskriver kvotanvändningen för en viss SKU.

Name	Typ	Description
currentValue	integer (int32)	Det för närvarande förbrukade värdet för den specifika sök-SKU:n.
id	string	Resurs-ID för SKU-slutpunkten för kvotanvändning för Microsoft.Search-providern.
limit	integer (int32)	Kvotgränsen för den specifika sök-SKU:n.
name	QuotaUsageResultName	SKU-namninformationen för den aktuella söktjänsten.
unit	string	Måttenheten för sök-SKU:n.

QuotaUsageResultName

Objekt

SKU-namninformationen, inklusive dess identifierare och lokaliserade visningsnamn.

Name	Typ	Description
localizedValue	string	Det lokaliserade strängvärdet för SKU-namnet.
value	string	SKU-namnet som stöds av Azure AI Search.

QuotaUsagesListResult

Objekt

Svar som innehåller information om kvotanvändning för alla SKU:er som stöds i Azure AI Search.

Name	Typ	Description
nextLink	string	Begär URL som kan användas för att köra frågor mot nästa sida med kvotanvändningar. Returneras när det totala antalet begärda kvotanvändningar överskrider den maximala sidstorleken.
value	QuotaUsageResult[]	Kvotanvändningen för SKU:er som stöds av Azure AI Search.