Field.IsKey Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Search.Models
Assembly:
Microsoft.Azure.Search.Service.dll
Package:
Microsoft.Azure.Search.Service v10.1.0
Source:
Field.Customization.cs

Gets or sets a value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields.

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

Property Value

Nullable<Boolean>
Attributes
Newtonsoft.Json.JsonIgnoreAttribute

Applies to