EntraAppAuthentication Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.2

Source:

EntraAppAuthentication.cs

Configuration for a customer-owned Microsoft Entra app registration used for federated credential-based on-behalf-of authentication.

public class EntraAppAuthentication : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.EntraAppAuthentication>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.EntraAppAuthentication>

type EntraAppAuthentication = class
    interface IJsonModel<EntraAppAuthentication>
    interface IPersistableModel<EntraAppAuthentication>

Public Class EntraAppAuthentication
Implements IJsonModel(Of EntraAppAuthentication), IPersistableModel(Of EntraAppAuthentication)

Inheritance

Object

EntraAppAuthentication

Implements

IJsonModel<EntraAppAuthentication> IPersistableModel<EntraAppAuthentication> IPersistableModel<T>

Constructors

Name	Description
EntraAppAuthentication(Guid, Guid)	Initializes a new instance of EntraAppAuthentication.

Properties

Name	Description
ApplicationId	The application (client) ID of the customer-owned Entra app registration.
FederatedCredentialId	The federated credential ID configured on the app registration, enabling the search service to authenticate as the app without a stored client secret.
TenantId	The tenant ID of the app registration. Required when the app registration is in a different tenant than the search service. If omitted, the search service's tenant is used.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<EntraAppAuthentication>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<EntraAppAuthentication>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<EntraAppAuthentication>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<EntraAppAuthentication>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<EntraAppAuthentication>.Write(ModelReaderWriterOptions)