Share via

SearchField.IsKey Property

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchField.cs
Source:
SearchField.cs

Gets or sets whether the field is the key field. The default is null. A SearchIndex must have exactly one key field of type String.

public bool? IsKey { get; set; }
member this.IsKey : Nullable<bool> with get, set
Public Property IsKey As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Remarks

This field must be set according to constraints described in the summary, or the server may respond with an error. Instead, consider using the SimpleField, SearchableField, VectorSearchField and ComplexField classes to help you more easily create a SearchIndex.

Applies to