synonym_maps

Creates, updates, deletes, gets or lists a synonym_maps resource.

Overview

Name	synonym_maps
Type	Resource
Id	azure.search_documents.synonym_maps

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_synonym_map	insert	search_service_name		Creates a new synonym map.
get_synonym_map	exec	synonym_map_name, search_service_name		Retrieves a synonym map 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
search_service_name	string	Search service name. (default: )
synonym_map_name	string	The name of the synonym map. Required.

INSERT examples

create_synonym_map

Creates a new synonym map.

INSERT INTO azure.search_documents.synonym_maps (
search_service_name
)
SELECT 
'{{ search_service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: synonym_maps
props:
  - name: search_service_name
    value: "{{ search_service_name }}"
    description: Required parameter for the synonym_maps resource.

Lifecycle Methods

get_synonym_map

Retrieves a synonym map definition.

EXEC azure.search_documents.synonym_maps.get_synonym_map 
@synonym_map_name='{{ synonym_map_name }}' --required, 
@search_service_name='{{ search_service_name }}' --required
;