Usages - List By Subscription

サービス:: Search Management

API バージョン:: 2025-05-01

サブスクリプション全体のすべての Azure AI Search クォータ使用量の一覧を取得します。

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

URI パラメーター

名前	/	必須	型	説明
location	path	True	string minLength: 1	Azure リージョンの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	この要求を識別するクライアントによって生成される GUID 値。指定した場合、これは要求を追跡する方法として応答情報に含まれます。

応答

名前	型	説明
200 OK	QuotaUsagesListResult	要求は成功しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

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

応答のサンプル

状態コード:: 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"
    }
  ]
}

定義

名前	説明
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
QuotaUsageResult	特定の SKU のクォータ使用量について説明します。
QuotaUsageResultName	SKU名情報、識別子およびローカライズされた表示名が含まれます。
QuotaUsagesListResult	Azure AI Search でサポートされているすべての SKU のクォータ使用量情報を含む応答。

CloudError

Object

API エラーに関する情報が含まれています。

名前	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

エラーコードとメッセージを含む特定の API エラーについて説明します。

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

QuotaUsageResult

Object

特定の SKU のクォータ使用量について説明します。

名前	型	説明
currentValue	integer (int32)	特定の検索 SKU で現在使用されている値。
id	string	Microsoft.Search プロバイダーのクォータ使用量 SKU エンドポイントのリソース ID。
limit	integer (int32)	特定の検索 SKU のクォータ制限。
name	QuotaUsageResultName	現在の検索サービスのSKU名情報。
unit	string	検索 SKU の測定単位。

QuotaUsageResultName

Object

SKU名情報、識別子およびローカライズされた表示名が含まれます。

名前	型	説明
localizedValue	string	SKU 名のローカライズされた文字列値。
value	string	Azure AI Search でサポートされている SKU 名。

QuotaUsagesListResult

Object

Azure AI Search でサポートされているすべての SKU のクォータ使用量情報を含む応答。

名前	型	説明
nextLink	string	クォータ使用量の次のページのクエリに使用できる要求 URL。要求されたクォータ使用量の合計数が最大ページサイズを超えた場合に返されます。
value	QuotaUsageResult[]	Azure AI Search でサポートされている SKU のクォータ使用量。