indexers
Creates, updates, deletes, gets or lists an indexers resource.
Overview
| Name | indexers |
| Type | Resource |
| Id | azure.search_documents.indexers |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
create_indexer | insert | search_service_name | Creates a new indexer. | |
get_indexer | exec | indexer_name, search_service_name | Retrieves an indexer definition. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
indexer_name | string | The name of the indexer. Required. |
search_service_name | string | Search service name. (default: ) |
INSERT examples
- create_indexer
- Manifest
Creates a new indexer.
INSERT INTO azure.search_documents.indexers (
search_service_name
)
SELECT
'{{ search_service_name }}'
;
# Description fields are for documentation purposes
- name: indexers
props:
- name: search_service_name
value: "{{ search_service_name }}"
description: Required parameter for the indexers resource.
Lifecycle Methods
- get_indexer
Retrieves an indexer definition.
EXEC azure.search_documents.indexers.get_indexer
@indexer_name='{{ indexer_name }}' --required,
@search_service_name='{{ search_service_name }}' --required
;