Share via


QueryKey interface

Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.

Properties

key

The value of the query API key. NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

key

The value of the query API key. NOTE: This property will not be serialized. It can only be populated by the server.

key?: string

Property Value

string

name

The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string