Usages - List By Subscription

Gets a list of all Search quota usages in the given subscription.

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

URI Parameters

Name In Required Type Description
location
path True

string

The unique location name for a Microsoft Azure geographic region.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API, command line tools, or the portal.

api-version
query True

string

The API version to use for each request.

Request Header

Name Required Type Description
x-ms-client-request-id

string

uuid

A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Responses

Name Type Description
200 OK

QuotaUsagesListResult

The operation succeeded. The response contains the list of all Search quota usages for the given subscription.

Other Status Codes

CloudError

An unexpected error occurred during the operation.

Security

azure_auth

Microsoft Entra ID OAuth2 authorization flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

GetQuotaUsagesList

Sample request

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

Sample response

{
  "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
}

Definitions

Name Description
CloudError

Contains information about an API error.

CloudErrorBody

Describes a particular API error with an error code and a message.

Name

The name of the SKU supported by Azure AI Search.

QuotaUsageResult

Describes the quota usage for a particular SKU.

QuotaUsagesListResult

Response containing the quota usage information for all the supported SKUs of Azure AI Search.

CloudError

Contains information about an API error.

Name Type Description
error

CloudErrorBody

Describes a particular API error with an error code and a message.

CloudErrorBody

Describes a particular API error with an error code and a message.

Name Type Description
code

string

An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

details

CloudErrorBody[]

Contains nested errors that are related to this error.

message

string

A message that describes the error in detail and provides debugging information.

target

string

The target of the particular error (for example, the name of the property in error).

Name

The name of the SKU supported by Azure AI Search.

Name Type Description
localizedValue

string

The localized string value for the SKU name.

value

string

The SKU name supported by Azure AI Search.

QuotaUsageResult

Describes the quota usage for a particular SKU.

Name Type Description
currentValue

integer

The currently used up value for the particular search SKU.

id

string

The resource ID of the quota usage SKU endpoint for Microsoft.Search provider.

limit

integer

The quota limit for the particular search SKU.

name

Name

The name of the SKU supported by Azure AI Search.

unit

string

The unit of measurement for the search SKU.

QuotaUsagesListResult

Response containing the quota usage information for all the supported SKUs of Azure AI Search.

Name Type Description
nextLink

string

Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size.

value

QuotaUsageResult[]

The quota usages for the SKUs supported by Azure AI Search.