Microsoft.Search (preview:2025-02-01)

2025/02/14 • 1 updated methods

Offerings_List (updated)
Description :  Lists all of the features and SKUs offered by the Azure AI Search service in each region.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Offerings_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "skus": {
              "$properties": {
                "limits": [
                  {
                    "#name": "partitionStorageInGigabytes",
                    "Format": {
                      "new": "float",
                      "old": "int32"
                    },
                    "Type": {
                      "new": "number",
                      "old": "integer"
                    }
                  },
                  {
                    "#name": "partitionVectorStorageInGigabytes",
                    "Format": {
                      "new": "float",
                      "old": "int32"
                    },
                    "Type": {
                      "new": "number",
                      "old": "integer"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Search/offerings
{
api-version:
{
Description: The API version to use for each request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of regions with their respective features and SKUs offered. ,
Required: False ,
}
[
{
regionName:
{
Description: The name of the region. ,
Required: False ,
}
string ,
features:
{
Description: The list of features offered in this region. ,
Required: False ,
}
[
{
name:
{
Description: The name of the feature offered in this region. ,
Enum:
{
Grok: Supports Grok feature. ,
ImageVectorization: Supports Image Vectorization feature. ,
DocumentIntelligence: Supports Document Intelligence feature. ,
QueryRewrite: Supports Query Rewrite feature. ,
S3: Supports S3 feature. ,
StorageOptimized: Supports Storage Optimized feature. ,
SemanticSearch: Supports Semantic Search feature. ,
MegaStore: Supports Mega Store feature. ,
AvailabilityZones: Supports Availability Zones feature. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
skus:
{
Description: The list of SKUs offered in this region. ,
Required: False ,
}
[
{
sku:
{
Description: Defines the SKU of a search service, which determines billing rate and capacity limits. ,
Required: False ,
}
{
name:
{
Description: The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.' ,
Enum:
{
free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. ,
basic: Billable tier for a dedicated service having up to 3 replicas. ,
standard: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. ,
standard2: Similar to 'standard', but with more capacity per search unit. ,
standard3: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). ,
storage_optimized_l1: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. ,
storage_optimized_l2: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. ,
}
,
Required: False ,
}
enum ,
}
,
limits:
{
Description: The limits associated with this SKU offered in this region. ,
Required: False ,
}
{
indexes:
{
Description: The maximum number of indexes available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
indexers:
{
Description: The maximum number of indexers available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
partitionStorageInGigabytes:
{
Description: The maximum storage size in Gigabytes available for this SKU per partition. ,
Format: float ,
Required: False ,
}
number ,
partitionVectorStorageInGigabytes:
{
Description: The maximum vector storage size in Gigabytes available for this SKU per partition. ,
Format: float ,
Required: False ,
}
number ,
searchUnits:
{
Description: The maximum number of search units available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
replicas:
{
Description: The maximum number of replicas available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
partitions:
{
Description: The maximum number of partitions available for this SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of offerings, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Describes a particular API error with an error code and a message. ,
Required: False ,
}
{
code:
{
Description: An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. ,
Required: False ,
}
string ,
message:
{
Description: A message that describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: Contains nested errors that are related to this error. ,
Required: False ,
}
[
string ,
]
,
}
,
message:
{
Description: A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). ,
Required: False ,
}
string ,
}