retrieves
Creates, updates, deletes, gets or lists a retrieves resource.
Overview​
| Name | retrieves |
| Type | Resource |
| Id | azure.search_documents.retrieves |
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 |
|---|---|---|---|---|
retrieve | exec | knowledge_base_name, search_service_name | x-ms-query-source-authorization | KnowledgeBase retrieves relevant data from backing stores. |
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 |
|---|---|---|
knowledge_base_name | string | |
search_service_name | string | Search service name. (default: ) |
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​
- retrieve
KnowledgeBase retrieves relevant data from backing stores.
EXEC azure.search_documents.retrieves.retrieve
@knowledge_base_name='{{ knowledge_base_name }}' --required,
@search_service_name='{{ search_service_name }}' --required,
@x-ms-query-source-authorization='{{ x-ms-query-source-authorization }}'
;