OnYourDataKeyAndKeyIdAuthenticationOptions Class

Definition

The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.

public class OnYourDataKeyAndKeyIdAuthenticationOptions : Azure.AI.OpenAI.OnYourDataAuthenticationOptions, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.OnYourDataKeyAndKeyIdAuthenticationOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.OnYourDataKeyAndKeyIdAuthenticationOptions>
type OnYourDataKeyAndKeyIdAuthenticationOptions = class
    inherit OnYourDataAuthenticationOptions
    interface IJsonModel<OnYourDataKeyAndKeyIdAuthenticationOptions>
    interface IPersistableModel<OnYourDataKeyAndKeyIdAuthenticationOptions>
Public Class OnYourDataKeyAndKeyIdAuthenticationOptions
Inherits OnYourDataAuthenticationOptions
Implements IJsonModel(Of OnYourDataKeyAndKeyIdAuthenticationOptions), IPersistableModel(Of OnYourDataKeyAndKeyIdAuthenticationOptions)
Inheritance
OnYourDataKeyAndKeyIdAuthenticationOptions
Implements

Constructors

OnYourDataKeyAndKeyIdAuthenticationOptions(String, String)

Initializes a new instance of OnYourDataKeyAndKeyIdAuthenticationOptions.

Properties

Key

The key to use for authentication.

KeyId

The key ID to use for authentication.

Explicit Interface Implementations

IJsonModel<OnYourDataAuthenticationOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from OnYourDataAuthenticationOptions)
IJsonModel<OnYourDataAuthenticationOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from OnYourDataAuthenticationOptions)
IJsonModel<OnYourDataKeyAndKeyIdAuthenticationOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<OnYourDataKeyAndKeyIdAuthenticationOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<OnYourDataAuthenticationOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from OnYourDataAuthenticationOptions)
IPersistableModel<OnYourDataAuthenticationOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from OnYourDataAuthenticationOptions)
IPersistableModel<OnYourDataAuthenticationOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from OnYourDataAuthenticationOptions)
IPersistableModel<OnYourDataKeyAndKeyIdAuthenticationOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<OnYourDataKeyAndKeyIdAuthenticationOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<OnYourDataKeyAndKeyIdAuthenticationOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to