SearchServiceClient (preview:2016-09-01)

2025/12/05 • 20 new methods

DataSources_CreateOrUpdate (new)
Description :  Creates a new Azure Search datasource or updates a datasource if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to create or update. ,
Required: True ,
}
string ,
dataSource:
{
Description: The definition of the datasource to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
DataSources_Delete (new)
Description :  Deletes an Azure Search datasource.
Reference :  Link ¶

⚼ Request

DELETE:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to delete. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
DataSources_Get (new)
Description :  Retrieves a datasource definition from Azure Search.
Reference :  Link ¶

⚼ Request

GET:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to retrieve. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
DataSources_List (new)
Description :  Lists all datasources available for an Azure Search service.
Reference :  Link ¶

⚼ Request

GET:  /datasources
{
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The datasources in the Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
,
]
,
}
DataSources_Create (new)
Description :  Creates a new Azure Search datasource.
Reference :  Link ¶

⚼ Request

POST:  /datasources
{
dataSource:
{
Description: The definition of the datasource to create. ,
Required: True ,
}
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. ,
Required: True ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for DocumentDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the DataSource. ,
Required: False ,
}
string ,
}
Indexers_Reset (new)
Description :  Resets the change tracking state associated with an Azure Search indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.reset
{
indexerName:
{
Description: The name of the indexer to reset. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
Indexers_Run (new)
Description :  Runs an Azure Search indexer on-demand.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.run
{
indexerName:
{
Description: The name of the indexer to run. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
Indexers_CreateOrUpdate (new)
Description :  Creates a new Azure Search indexer or updates an indexer if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to create or update. ,
Required: True ,
}
string ,
indexer:
{
Description: The definition of the indexer to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
Indexers_Delete (new)
Description :  Deletes an Azure Search indexer.
Reference :  Link ¶

⚼ Request

DELETE:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to delete. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (204)

{}
Indexers_Get (new)
Description :  Retrieves an indexer definition from Azure Search.
Reference :  Link ¶

⚼ Request

GET:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to retrieve. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
Indexers_List (new)
Description :  Lists all indexers available for an Azure Search service.
Reference :  Link ¶

⚼ Request

GET:  /indexers
{
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The indexers in the Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
,
]
,
}
Indexers_Create (new)
Description :  Creates a new Azure Search indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers
{
indexer:
{
Description: The definition of the indexer to create. ,
Required: True ,
}
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
base64EncodeKeys:
{
Description: Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false. ,
Required: False ,
}
boolean ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the Indexer. ,
Required: False ,
}
string ,
}
Indexers_GetStatus (new)
Description :  Returns the current status and execution history of an indexer.
Reference :  Link ¶

⚼ Request

GET:  /indexers('{indexerName}')/search.status
{
indexerName:
{
Description: The name of the indexer for which to retrieve status. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Overall indexer status. ,
Enum:
{
unknown: No description available. ,
error: No description available. ,
running: No description available. ,
}
,
Required: False ,
}
enum ,
lastResult:
{
Description: The result of the most recent or an in-progress indexer execution. ,
Required: False ,
}
{
status:
{
Description: The outcome of this indexer execution. ,
Enum:
{
transientFailure: No description available. ,
success: No description available. ,
inProgress: No description available. ,
reset: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message indicating the top-level error, if any. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of this indexer execution. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of this indexer execution, if the execution has already completed. ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The item-level indexing errors ,
Required: False ,
}
[
{
key:
{
Description: The key of the item for which indexing failed. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The message describing the error that occurred while attempting to index the item. ,
Required: False ,
}
string ,
}
,
]
,
itemsProcessed:
{
Description: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. ,
Format: int32 ,
Required: False ,
}
integer ,
itemsFailed:
{
Description: The number of items that failed to be indexed during this indexer execution. ,
Format: int32 ,
Required: False ,
}
integer ,
initialTrackingState:
{
Description: Change tracking state with which an indexer execution started. ,
Required: False ,
}
string ,
finalTrackingState:
{
Description: Change tracking state with which an indexer execution finished. ,
Required: False ,
}
string ,
}
,
executionHistory:
{
Description: History of the recent indexer executions, sorted in reverse chronological order. ,
Required: False ,
}
[
{
status:
{
Description: The outcome of this indexer execution. ,
Enum:
{
transientFailure: No description available. ,
success: No description available. ,
inProgress: No description available. ,
reset: No description available. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message indicating the top-level error, if any. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of this indexer execution. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of this indexer execution, if the execution has already completed. ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The item-level indexing errors ,
Required: False ,
}
[
{
key:
{
Description: The key of the item for which indexing failed. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The message describing the error that occurred while attempting to index the item. ,
Required: False ,
}
string ,
}
,
]
,
itemsProcessed:
{
Description: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. ,
Format: int32 ,
Required: False ,
}
integer ,
itemsFailed:
{
Description: The number of items that failed to be indexed during this indexer execution. ,
Format: int32 ,
Required: False ,
}
integer ,
initialTrackingState:
{
Description: Change tracking state with which an indexer execution started. ,
Required: False ,
}
string ,
finalTrackingState:
{
Description: Change tracking state with which an indexer execution finished. ,
Required: False ,
}
string ,
}
,
]
,
}
Indexes_Create (new)
Description :  Creates a new Azure Search index.
Reference :  Link ¶

⚼ Request

POST:  /indexes
{
index:
{
Description: The definition of the index to create. ,
Required: True ,
}
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
Indexes_List (new)
Description :  Lists all indexes available for an Azure Search service.
Reference :  Link ¶

⚼ Request

GET:  /indexes
{
$select:
{
Description: Selects which properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The indexes in the Search service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
]
,
}
Indexes_CreateOrUpdate (new)
Description :  Creates a new Azure Search index or updates an index if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /indexes('{indexName}')
{
indexName:
{
Description: The definition of the index to create or update. ,
Required: True ,
}
string ,
index:
{
Description: The definition of the index to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
allowIndexDowntime:
{
Description: Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. ,
Required: False ,
}
boolean ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
Indexes_Delete (new)
Description :  Deletes an Azure Search index and all the documents it contains.
Reference :  Link ¶

⚼ Request

DELETE:  /indexes('{indexName}')
{
indexName:
{
Description: The name of the index to delete. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
Indexes_Get (new)
Description :  Retrieves an index definition from Azure Search.
Reference :  Link ¶

⚼ Request

GET:  /indexes('{indexName}')
{
indexName:
{
Description: The name of the index to retrieve. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
analyzer:
{
Description: The name of the analyzer to use for the field at search time and indexing time. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This analyzer can be updated on an existing field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. Once the analyzer is chosen, it cannot be changed for the field. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
key:
{
Description: A value indicating whether the field is the key of the index. Valid only for string fields. Every index must have exactly one key field. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether the field can be used in filter expressions. Default is false. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether the field can be used in orderby expressions. Not valid for string collection fields. Default is false. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether it is possible to facet on this field. Not valid for geo-point fields. Default is false. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. Default is true. ,
Required: False ,
}
boolean ,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: No description available. ,
constant: No description available. ,
quadratic: No description available. ,
logarithmic: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: No description available. ,
average: No description available. ,
minimum: No description available. ,
maximum: No description available. ,
firstMatching: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: No description available. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
Indexes_GetStatistics (new)
Description :  Returns statistics for the given index, including a document count and storage usage.
Reference :  Link ¶

⚼ Request

GET:  /indexes('{indexName}')/search.stats
{
indexName:
{
Description: The name of the index for which to retrieve statistics. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
documentCount:
{
Description: The number of documents in the index. ,
Format: int64 ,
Required: False ,
}
integer ,
storageSize:
{
Description: The amount of storage in bytes consumed by the index. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Indexes_Analyze (new)
Description :  Shows how an analyzer breaks text into tokens.
Reference :  Link ¶

⚼ Request

POST:  /indexes('{indexName}')/search.analyze
{
indexName:
{
Description: The name of the index for which to test an analyzer. ,
Required: True ,
}
string ,
request:
{
Description: The text and analyzer or analysis components to test. ,
Required: True ,
}
{
text:
{
Description: The text to break into tokens. ,
Required: True ,
}
string ,
analyzer:
{
Description: The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
tokenizer:
{
Description: The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive. ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
}
,
tokenFilters:
{
Description: An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
}
,
]
,
charFilters:
{
Description: An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
}
,
]
,
}
,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tokens:
{
Description: The list of tokens returned by the analyzer specified in the request. ,
Required: False ,
}
[
{
token:
{
Description: The token returned by the analyzer. ,
Required: False ,
}
string ,
startOffset:
{
Description: The index of the first character of the token in the input text. ,
Format: int32 ,
Required: False ,
}
integer ,
endOffset:
{
Description: The index of the last character of the token in the input text. ,
Format: int32 ,
Required: False ,
}
integer ,
position:
{
Description: The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}