Share via


OpenApiAuthDetails Class

Definition

authentication details for OpenApiFunctionDefinition Please note OpenApiAuthDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include OpenApiAnonymousAuthDetails, OpenApiManagedAuthDetails and OpenApiProjectConnectionAuthDetails.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownOpenApiAuthDetails))]
public abstract class OpenApiAuthDetails : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.OpenApiAuthDetails>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.OpenApiAuthDetails>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownOpenApiAuthDetails))>]
type OpenApiAuthDetails = class
    interface IUtf8JsonSerializable
    interface IJsonModel<OpenApiAuthDetails>
    interface IPersistableModel<OpenApiAuthDetails>
Public MustInherit Class OpenApiAuthDetails
Implements IJsonModel(Of OpenApiAuthDetails), IPersistableModel(Of OpenApiAuthDetails), IUtf8JsonSerializable
Inheritance
OpenApiAuthDetails
Derived
Attributes
Implements

Constructors

Name Description
OpenApiAuthDetails()

Initializes a new instance of OpenApiAuthDetails.

OpenApiAuthDetails(OpenApiAuthType, IDictionary<String,BinaryData>)

Initializes a new instance of OpenApiAuthDetails.

Properties

Name Description
Type

The type of authentication, must be anonymous/project_connection/managed_identity.

Methods

Name Description
DeserializeOpenApiAuthDetails(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<OpenApiAuthDetails>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<OpenApiAuthDetails>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<OpenApiAuthDetails>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<OpenApiAuthDetails>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<OpenApiAuthDetails>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to