If you're creating, modifying, or deleting objects, you'll need an admin API key. Passing a valid API key on the request is considered proof that the request is from an authorized client. Upon service creation, an API key is the only authentication mechanism for data plane operations, but you can replace or supplement key authentication with Azure roles if you can't use hard-coded keys in your code.ĪPI keys are specified on client requests to a search service. Use API keys on connectionsĪPI keys are used for data plane (content) requests, such as creating or accessing an index or any other request that's represented in the Search REST APIs. If you lose track of what type of key is specified in your application, you can check the key values in the portal. Both keys are strings composed of 52 randomly generated alpha-numeric characters. Visually, there's no distinction between an admin key or query key. More can be created on demand by a search service administrator.ġ Having two allows you to roll over one key while using the second key for continued access to the service. One query key is generated with the service. Read-only access, scoped to the documents collection of a search index Two admin keys, referred to as primary and secondary keys in the portal, are generated when the service is created and can be individually regenerated on demand. There are two kinds of keys used for authenticating a request: Typeįull access (read-write) for all content operations A separate term, 'document key', refers to a unique string in your indexed content that's used to uniquely identify documents in a search index. An 'API key', which is described in this article, refers to a GUID used for authenticating a request. A quick note about how 'key' terminology is used in Cognitive Search.

Sobolsoft api key