Share via

WebApiParameters interface

  • Reference
Package:
@azure/search-documents

Specifies the properties for connecting to a user-defined vectorizer.

Properties

authIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.
authResourceId

Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.
httpHeaders

The headers required to make the HTTP request.
httpMethod

The method for the HTTP request.
timeout

The desired timeout for the request. Default is 30 seconds.
uri

The URI of the Web API providing the vectorizer.

Property Details

authIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.

authIdentity?: SearchIndexerDataIdentity

Property Value

SearchIndexerDataIdentity

authResourceId

Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

authResourceId?: string

Property Value

string

httpHeaders

The headers required to make the HTTP request.

httpHeaders?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

httpMethod

The method for the HTTP request.

httpMethod?: string

Property Value

string

timeout

The desired timeout for the request. Default is 30 seconds.

timeout?: string

Property Value

string

uri

The URI of the Web API providing the vectorizer.

uri?: string

Property Value

string