Usages - List By Subscription

Usługa:: Search Management

Wersja interfejsu API:: 2025-05-01

Pobierz listę wszystkich użycia przydziałów usługi Azure AI Search w ramach subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
location	path	True	string minLength: 1	Nazwa regionu świadczenia usługi Azure.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QuotaUsagesListResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
CloudError	Zawiera informacje o błędzie interfejsu API.
CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
QuotaUsageResult	Opisuje użycie limitu przydziału dla określonej jednostki SKU.
QuotaUsageResultName	Informacje o nazwie SKU, w tym jej identyfikator i lokalizowana nazwa wyświetlana.
QuotaUsagesListResult	Odpowiedź zawierająca informacje o użyciu limitu przydziału dla wszystkich obsługiwanych jednostek SKU usługi Azure AI Search.

CloudError

Objekt

Zawiera informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	CloudErrorBody	Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.
message	string	Krótki opis błędu, który wskazuje, co poszło nie tak (aby uzyskać szczegółowe informacje/debugowanie, zapoznaj się z właściwością "error.message").

CloudErrorBody

Objekt

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.
details	CloudErrorBody[]	Zawiera zagnieżdżone błędy związane z tym błędem.
message	string	Komunikat opisujący szczegółowo błąd i zawierający informacje o debugowaniu.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

QuotaUsageResult

Objekt

Opisuje użycie limitu przydziału dla określonej jednostki SKU.

Nazwa	Typ	Opis
currentValue	integer (int32)	Obecnie używana wartość dla konkretnej jednostki SKU wyszukiwania.
id	string	Identyfikator zasobu punktu końcowego jednostki SKU użycia limitu przydziału dla dostawcy Microsoft.Search.
limit	integer (int32)	Limit przydziału dla konkretnej jednostki SKU wyszukiwania.
name	QuotaUsageResultName	Informacje o nazwie SKU obecnej usługi wyszukiwania.
unit	string	Jednostka miary dla jednostki SKU wyszukiwania.

QuotaUsageResultName

Objekt

Informacje o nazwie SKU, w tym jej identyfikator i lokalizowana nazwa wyświetlana.

Nazwa	Typ	Opis
localizedValue	string	Zlokalizowana wartość ciągu dla nazwy jednostki SKU.
value	string	Nazwa jednostki SKU obsługiwana przez usługę Azure AI Search.

QuotaUsagesListResult

Objekt

Odpowiedź zawierająca informacje o użyciu limitu przydziału dla wszystkich obsługiwanych jednostek SKU usługi Azure AI Search.

Nazwa	Typ	Opis
nextLink	string	Adres URL żądania, który może służyć do wykonywania zapytań dotyczących następnej strony użycia limitu przydziału. Zwracane, gdy łączna liczba żądanych użycia limitu przydziału przekracza maksymalny rozmiar strony.
value	QuotaUsageResult[]	Użycie przydziału jednostek SKU obsługiwanych przez usługę Azure AI Search.