OnYourDataApiKeyAuthenticationOptions Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: OnYourDataApiKeyAuthenticationOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The authentication options for Azure OpenAI On Your Data when using an API key.

public class OnYourDataApiKeyAuthenticationOptions : Azure.AI.OpenAI.OnYourDataAuthenticationOptions, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.OnYourDataApiKeyAuthenticationOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.OnYourDataApiKeyAuthenticationOptions>

type OnYourDataApiKeyAuthenticationOptions = class
    inherit OnYourDataAuthenticationOptions
    interface IJsonModel<OnYourDataApiKeyAuthenticationOptions>
    interface IPersistableModel<OnYourDataApiKeyAuthenticationOptions>

Public Class OnYourDataApiKeyAuthenticationOptions
Inherits OnYourDataAuthenticationOptions
Implements IJsonModel(Of OnYourDataApiKeyAuthenticationOptions), IPersistableModel(Of OnYourDataApiKeyAuthenticationOptions)

Inheritance: Object

OnYourDataAuthenticationOptions
OnYourDataApiKeyAuthenticationOptions

Implements: IJsonModel<OnYourDataApiKeyAuthenticationOptions> IPersistableModel<OnYourDataApiKeyAuthenticationOptions> IPersistableModel<T>

Constructors

OnYourDataApiKeyAuthenticationOptions(String)

Initializes a new instance of OnYourDataApiKeyAuthenticationOptions.

Properties

Key	The API key to use for authentication.

Explicit Interface Implementations

IJsonModel<OnYourDataApiKeyAuthenticationOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<OnYourDataApiKeyAuthenticationOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
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)
IPersistableModel<OnYourDataApiKeyAuthenticationOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<OnYourDataApiKeyAuthenticationOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<OnYourDataApiKeyAuthenticationOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
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)

Applies to