Class DataSourceAuthentication

The DataSourceAuthentication. Please note this is the abstract base class. The derived classes available for instantiation are:

Inheritance

System.Object

DataSourceAuthentication

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

[OpenAI.CodeGenType("AzureChatDataSourceAuthenticationOptions")]
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Chat.InternalUnknownAzureChatDataSourceAuthenticationOptions))]
public abstract class DataSourceAuthentication : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.DataSourceAuthentication>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.DataSourceAuthentication>

Methods

FromAccessToken(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromAccessToken (string accessToken);

Parameters

System.String accessToken

Returns

DataSourceAuthentication

FromApiKey(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromApiKey (string apiKey);

Parameters

System.String apiKey

Returns

DataSourceAuthentication

FromConnectionString(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromConnectionString (string connectionString);

Parameters

System.String connectionString

Returns

DataSourceAuthentication

FromEncodedApiKey(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromEncodedApiKey (string encodedApiKey);

Parameters

System.String encodedApiKey

Returns

DataSourceAuthentication

FromKeyAndKeyId(String, String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromKeyAndKeyId (string key, string keyId);

Parameters

System.String key

System.String keyId

Returns

DataSourceAuthentication

FromSystemManagedIdentity()

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromSystemManagedIdentity ();

Returns

DataSourceAuthentication

FromUserManagedIdentity(ResourceIdentifier)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromUserManagedIdentity (Azure.Core.ResourceIdentifier identityResource);

Parameters

Azure.Core.ResourceIdentifier identityResource

Returns

DataSourceAuthentication

FromUsernameAndPassword(String, String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceAuthentication FromUsernameAndPassword (string username, string password);

Parameters

System.String username

System.String password

Returns

DataSourceAuthentication

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.DataSourceAuthentication JsonModelCreateCore (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The JSON reader.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

DataSourceAuthentication

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.DataSourceAuthentication PersistableModelCreateCore (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The data to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

DataSourceAuthentication

PersistableModelWriteCore(ModelReaderWriterOptions)

Declaration

protected virtual BinaryData PersistableModelWriteCore (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.BinaryData

Operators

Explicit(ClientResult to DataSourceAuthentication)

Declaration

public static explicit operator Azure.AI.OpenAI.Chat.DataSourceAuthentication (System.ClientModel.ClientResult result);

Parameters

System.ClientModel.ClientResult result The System.ClientModel.ClientResult to deserialize the DataSourceAuthentication from.

Returns

DataSourceAuthentication

Implicit(DataSourceAuthentication to BinaryContent)

Declaration

public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.DataSourceAuthentication dataSourceAuthentication);

Parameters

DataSourceAuthentication dataSourceAuthentication The DataSourceAuthentication to serialize into System.ClientModel.BinaryContent.

Returns

System.ClientModel.BinaryContent

Explicit Interface Implementations

IJsonModel<DataSourceAuthentication>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

Declaration

Azure.AI.OpenAI.Chat.DataSourceAuthentication IJsonModel<DataSourceAuthentication>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

DataSourceAuthentication A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<DataSourceAuthentication>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<DataSourceAuthentication>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataSourceAuthentication>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.AI.OpenAI.Chat.DataSourceAuthentication IPersistableModel<DataSourceAuthentication>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

DataSourceAuthentication A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataSourceAuthentication>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration

string IPersistableModel<DataSourceAuthentication>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the serivce.

IPersistableModel<DataSourceAuthentication>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<DataSourceAuthentication>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.