CustomWebApiParameters Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies the properties for connecting to a user-defined vectorizer.
public class CustomWebApiParameters
type CustomWebApiParameters = class
Public Class CustomWebApiParameters
- Inheritance
-
CustomWebApiParameters
Constructors
CustomWebApiParameters() |
Initializes a new instance of CustomWebApiParameters. |
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. Please note SearchIndexerDataIdentity is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity. |
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. |
Applies to
Azure SDK for .NET