Package version:

Interface WebApiParameters

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

interface WebApiParameters {
    authIdentity?: SearchIndexerDataIdentity;
    authResourceId?: string;
    httpHeaders?: {
        [propertyName: string]: string;
    };
    httpMethod?: string;
    timeout?: string;
    uri?: string;
}

Properties

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?: string

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?: {
    [propertyName: string]: string;
}

The headers required to make the HTTP request.

httpMethod?: string

The method for the HTTP request.

timeout?: string

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

uri?: string

The URI of the Web API providing the vectorizer.