SearchCredentials Class

Definition

Credentials used to authenticate to a search service. https://docs.microsoft.com/rest/api/searchservice/

public class SearchCredentials : Microsoft.Rest.ServiceClientCredentials
type SearchCredentials = class
    inherit ServiceClientCredentials
Public Class SearchCredentials
Inherits ServiceClientCredentials
Inheritance
System.Object
SearchCredentials

Remarks

See https://docs.microsoft.com/azure/search/search-security-api-keys for more information about API keys in Azure Cognitive Search.

Constructors

SearchCredentials(String)

Initializes a new instance of the SearchCredentials class with a query key or an admin key. Use a query key if your application does not require write access to the Search Service or index.

Properties

ApiKey

api-key used to authenticate to a search service. Can be either a query key for querying only, or an admin key that enables index and document management as well.

Methods

InitializeServiceClient<T>(ServiceClient<T>) (Inherited from ServiceClientCredentials)
ProcessHttpRequestAsync(HttpRequestMessage, CancellationToken)

Adds the credentials to the given HTTP request.

Applies to