ConnectionPropertiesApiKeyAuth Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: ConnectionPropertiesApiKeyAuth.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.

Connection properties for connections with API key authentication.

public class ConnectionPropertiesApiKeyAuth : Azure.AI.Projects.ConnectionProperties, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.ConnectionPropertiesApiKeyAuth>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.ConnectionPropertiesApiKeyAuth>

type ConnectionPropertiesApiKeyAuth = class
    inherit ConnectionProperties
    interface IJsonModel<ConnectionPropertiesApiKeyAuth>
    interface IPersistableModel<ConnectionPropertiesApiKeyAuth>

Public Class ConnectionPropertiesApiKeyAuth
Inherits ConnectionProperties
Implements IJsonModel(Of ConnectionPropertiesApiKeyAuth), IPersistableModel(Of ConnectionPropertiesApiKeyAuth)

Inheritance: Object

ConnectionProperties
ConnectionPropertiesApiKeyAuth

Implements: IJsonModel<ConnectionPropertiesApiKeyAuth> IPersistableModel<ConnectionPropertiesApiKeyAuth> IPersistableModel<T>

Properties

AuthType	Authentication type of the connection target. (Inherited from ConnectionProperties)
Category	Category of the connection. (Inherited from ConnectionProperties)
Credentials	Credentials will only be present for authType=ApiKey.
Target	The connection URL to be used for this service. (Inherited from ConnectionProperties)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

Share via