Share via


SearchAadAuthDataPlaneAuthOptions Class

Definition

Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.

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

Constructors

SearchAadAuthDataPlaneAuthOptions()

Initializes a new instance of SearchAadAuthDataPlaneAuthOptions.

Properties

AadAuthFailureMode

Describes what response the data plane API of a search service would send for requests that failed authentication.

ApiKeyOnly

Indicates that only the API key can be used for authentication.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Explicit Interface Implementations

IJsonModel<SearchAadAuthDataPlaneAuthOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SearchAadAuthDataPlaneAuthOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SearchAadAuthDataPlaneAuthOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SearchAadAuthDataPlaneAuthOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SearchAadAuthDataPlaneAuthOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to