Class SearchApiKeyCredential

Package version

This class is used to authenticate to Search using an API Key retrieved from the Azure portal.

Hierarchy

SearchApiKeyCredential

Implements

any

Index

Constructors

constructor

Methods

Constructors

constructor

new SearchApiKeyCredential(apiKey: string): SearchApiKeyCredential

- Defined in searchApiKeyCredential.ts:16
Creates a new SearchApiKeyCredential object.

Parameters
- apiKey: string
  
  The Search API key for authentication.
Returns SearchApiKeyCredential

Methods

signRequest

signRequest(webResource: WebResource): Promise<WebResource>

- Defined in searchApiKeyCredential.ts:46
Signs a request with the provided API Key.

Parameters
- webResource: WebResource
  
  The WebResource to be signed.
Returns Promise<WebResource>

The signed request object.

updateKey

updateKey(apiKey: string): void

- Defined in searchApiKeyCredential.ts:31
Updates the API Key used for authentication. Use this method to roll credentials.

Parameters
- apiKey: string
  
  The Search API key for authentication.
Returns void

Generated using TypeDoc