Azure AI Search

Azure AI Search provides secure information retrieval at scale over user-owned content in traditional and generative AI search applications.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following:      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure China regions      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Microsoft
URL	https://support.microsoft.com

Connector Metadata
Publisher	Microsoft
Website	https://learn.microsoft.com/en-us/azure/search/search-what-is-azure-search/
Categories	AI;Business Intelligence
Privacy policy	https://privacy.microsoft.com/en-us/privacystatement

Creating a connection

The connector supports the following authentication types:

Access Key	Provide connection string to access your Azure AI Search.	All regions	Not shareable
Client Certificate Auth	Provide Microsoft Entra ID credentials using PFX certificate and password	All regions	Shareable
Logic Apps Managed Identity	Create a connection using a LogicApps Managed Identity	LOGICAPPS only	Shareable
Microsoft Entra ID Integrated	Use Microsoft Entra ID to access	All regions	Not shareable
Service principal (Microsoft Entra ID application)	Use Microsoft Entra ID application to access your Azure AI Search.	All regions	Not shareable
Default [DEPRECATED]	This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.	All regions	Not shareable

Access Key

Auth ID: adminkey

Applicable: All regions

Provide connection string to access your Azure AI Search.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Azure AI Search Endpoint URL	string	Azure AI Search Endpoint to connect	True
Azure AI Search Admin Key	securestring	Admin Key to connect with Azure AI Search	True

Client Certificate Auth

Auth ID: certOauth

Applicable: All regions

Provide Microsoft Entra ID credentials using PFX certificate and password

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name	Type	Description	Required
Azure AI Search Endpoint URL	string	Provide Azure AI Search Namespace Endpoint (e.g: ai://testai.search.windows.net/)	True
Tenant	string		True
Client ID	string	The client ID of for the Microsoft Entra ID application
Client certificate secret	clientCertificate	The client certificate secret allowed by this application	True

Logic Apps Managed Identity

Auth ID: managedIdentityAuth

Applicable: LOGICAPPS only

Create a connection using a LogicApps Managed Identity

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name	Type	Description	Required
LogicApps Managed Identity	managedIdentity	Sign in with a Logic Apps Managed Identity	True
Azure AI Search Endpoint URL	string	Provide Azure AI Search Namespace Endpoint (e.g: ai://testai.search.windows.net/)	True

Microsoft Entra ID Integrated

Auth ID: oauth

Applicable: All regions

Use Microsoft Entra ID to access

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Azure AI Search Endpoint URL	string	Provide Azure AI Search Namespace Endpoint (e.g: ai://testai.search.windows.net/)	True

Service principal (Microsoft Entra ID application)

Auth ID: oauthSP

Applicable: All regions

Use Microsoft Entra ID application to access your Azure AI Search.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Azure AI Search Endpoint URL	string	Provide Azure AI Search Namespace Endpoint (e.g: ai://testai.search.windows.net/)	True
Tenant	string		True
Client ID	string		True
Client Secret	securestring		True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Azure AI Search Endpoint URL	string	Azure AI Search Endpoint to connect	True
Azure AI Search Admin Key	securestring	Admin Key to connect with Azure AI Search	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	200	60 seconds

Actions

Agentic Search (Preview)	Agentic Search.
Delete a document	Delete a single document.
Delete multiple documents	Delete the specified documents.
Get index statistics	This operation gets statistics for an index in the Azure AI Search.
Get search indexes	This operation gets all indexes schema with field details in the Azure AI Search.
Index a document	Index a single document.
Index multiple documents	Index the specified documents.
Merge a document	Merge a single document.
Search vectors	A single vector search with filter.
Search vectors with natural language	Search vectors with natural language.
Semantic Hybrid Search	Semantic hybrid search with filter.

Agentic Search (Preview)

Operation ID:

KnowledgeAgentRetrieval

Agentic Search.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.
Agent Name	agentName	True	string	The agent name.
Role	role		string	Role
Agent Message Content	content		string	Agent Message Content

Returns

Body

AgenticRetrievalOutput

Delete a document

Operation ID:

DeleteDocument

Delete a single document.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Delete multiple documents

Operation ID:

DeleteDocuments

Delete the specified documents.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Get index statistics

Operation ID:

GetIndexStatistics

This operation gets statistics for an index in the Azure AI Search.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Returns

response

object

Get search indexes

Operation ID:

GetIndexesSchema

This operation gets all indexes schema with field details in the Azure AI Search.

Parameters

Name	Key	Required	Type	Description
Only Indexes With Integrated Vectors	onlyIntegratedVectorIndexes		boolean	If true, only indexes with integrated vectors will be returned.

Returns

response

array of Object

Index a document

Operation ID:

IndexDocument

Index a single document.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Returns

response

object

Index multiple documents

Operation ID:

IndexDocuments

Index the specified documents.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Returns

response

object

Merge a document

Operation ID:

MergeDocument

Merge a single document.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.

Search vectors

Operation ID:

VectorSearch

A single vector search with filter.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.
Vector Fields And Values Search Vector Field Name	vectorFieldsName	True	string	The search vector field name.
vectorFieldsValue	vectorFieldsValue	True	array of float
Number Of Nearest Neighbors To Return	nearestNeighbors	True	integer	The number of nearest neighbors to return.
Search	searchQuery		string	Search query condition
Search Mode	searchMode		string	Search Mode
Filter condition	filterCondition		string	The filtering condition to apply before finding the nearest neighbors.

Returns

Name	Path	Type	Description
		array of string

Search vectors with natural language

Operation ID:

IntegratedVectorSearch

Search vectors with natural language.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.
Search Text	searchText		string	Search Text
Vectorized Search Fields	vectorizedSearchFields		array of string	Vectorized Search Fields
Select Fields	selectFields		array of string	Select Fields
Filter condition	filterCondition		string	Filter condition
SessionId	sessionId		string	SessionId
Nearest Neighbors	nearestNeighbors		integer	Nearest Neighbors
Top Searches	top		integer	Top Searches
Skip Searches	skipSearches		integer	Skip Searches

Returns

response

array of Object

Semantic Hybrid Search

Operation ID:

SemanticHybridSearch

Semantic hybrid search with filter.

Parameters

Name	Key	Required	Type	Description
Index Name	indexName	True	string	The index name.
Search Text	searchText		string	Search Text
Vectorized Search Fields	vectorizedSearchFields		array of string	Vectorized Search Fields
Semantic Configuration	semanticConfiguration		string	Semantic Configuration
Select Fields	selectFields		array of string	Select Fields
Filter condition	filterCondition		string	Filter condition
SessionId	sessionId		string	SessionId
Nearest Neighbors	nearestNeighbors		integer	Nearest Neighbors
Top Searches	top		integer	Top Searches
Skip Searches	skipSearches		integer	Skip Searches

Returns

response

array of Object

Definitions

Object

AgenticRetrievalOutput

Name	Path	Type	Description
response	response	array of AgenticRetrievalOutput_Response
activity	activity	array of AgenticRetrievalOutput_Activity
references	references	array of AgenticRetrievalOutput_References

AgenticRetrievalOutput_Response

Name	Path	Type	Description
Agent Message Response Role	role	string	Agent Message Response Role
content	content	array of AgenticRetrievalOutput_Response_Content

AgenticRetrievalOutput_Response_Content

Name	Path	Type	Description
Agent Message Response Type	type	string	Agent Message Response Type
Agent Message Response Text	text	array of object	Agent Message Response Text
items	text	object

AgenticRetrievalOutput_Activity

Name	Path	Type	Description
Agent Message Activity	type	string	Agent Message Activity
Agent Message Id	id	string	Agent Message Id
Agent Message Input Tokens	inputTokens	string	Agent Message Input Tokens
Agent Message Output Tokens	outputTokens	string	Agent Message Output Tokens
Agent Message Target Index	targetIndex	string	Agent Message Target Index
Agent Message Search Query	query.search	string	Agent Message Search Query
Agent Message Query Filter	query.filter	string	Agent Message Query Filter
Agent Message Query Time	queryTime	string	Agent Message Query Time
Agent Message Count	count	string	Agent Message Count

AgenticRetrievalOutput_References

Name	Path	Type	Description
Agent Message Reference Type	type	string	Agent Message Reference Type
Agent Message Reference Id	id	string	Agent Message Reference Id
Agent Message Reference Activity Source	activitySource	string	Agent Message Reference Activity Source
Agent Message Reference Document Key	docKey	string	Agent Message Reference Document Key
Agent Message Reference Source Data	sourceData	string	Agent Message Reference Source Data

object

This is the type 'object'.