documents

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

Overview

Name	documents
Type	Resource
Id	azure.search_documents.documents

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
get_document	exec	key_name, index_name, search_service_name	x-ms-query-source-authorization, x-ms-enable-elevated-read, $select	Retrieves a document from the index.

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
index_name	string
key_name	string	The key of the document to retrieve. Required.
search_service_name	string	Search service name. (default: )
$select	array	List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. Default value is None.
x-ms-enable-elevated-read	boolean	A value that enables elevated read that bypass document level permission checks for the query operation. Default value is None.
x-ms-query-source-authorization	string	Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. Default value is None.

Lifecycle Methods

get_document

Retrieves a document from the index.

EXEC azure.search_documents.documents.get_document 
@key_name='{{ key_name }}' --required, 
@index_name='{{ index_name }}' --required, 
@search_service_name='{{ search_service_name }}' --required, 
@x-ms-query-source-authorization='{{ x-ms-query-source-authorization }}', 
@x-ms-enable-elevated-read={{ x-ms-enable-elevated-read }}, 
@$select='{{ $select }}'
;