Share via


SearchServiceQueryKey Class

Definition

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

public class SearchServiceQueryKey : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Search.Models.SearchServiceQueryKey>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Search.Models.SearchServiceQueryKey>
type SearchServiceQueryKey = class
    interface IJsonModel<SearchServiceQueryKey>
    interface IPersistableModel<SearchServiceQueryKey>
Public Class SearchServiceQueryKey
Implements IJsonModel(Of SearchServiceQueryKey), IPersistableModel(Of SearchServiceQueryKey)
Inheritance
SearchServiceQueryKey
Implements

Properties

Key

The value of the query API key.

Name

The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.

Explicit Interface Implementations

IJsonModel<SearchServiceQueryKey>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SearchServiceQueryKey>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SearchServiceQueryKey>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SearchServiceQueryKey>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SearchServiceQueryKey>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to