ApiKeyAuthWorkspaceConnectionProperties Class

Reference

Definition

Namespace:: Azure.ResourceManager.MachineLearning.Models

Assembly:: Azure.ResourceManager.MachineLearning.dll

Package:: Azure.ResourceManager.MachineLearning v1.2.1

Package:: Azure.ResourceManager.MachineLearning v1.2.0-beta.3

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

This connection type covers the generic ApiKey auth connection categories, for examples: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint}

Use Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields

public class ApiKeyAuthWorkspaceConnectionProperties : Azure.ResourceManager.MachineLearning.Models.MachineLearningWorkspaceConnectionProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.MachineLearning.Models.ApiKeyAuthWorkspaceConnectionProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.MachineLearning.Models.ApiKeyAuthWorkspaceConnectionProperties>

public class ApiKeyAuthWorkspaceConnectionProperties : Azure.ResourceManager.MachineLearning.Models.MachineLearningWorkspaceConnectionProperties

type ApiKeyAuthWorkspaceConnectionProperties = class
    inherit MachineLearningWorkspaceConnectionProperties
    interface IJsonModel<ApiKeyAuthWorkspaceConnectionProperties>
    interface IPersistableModel<ApiKeyAuthWorkspaceConnectionProperties>

type ApiKeyAuthWorkspaceConnectionProperties = class
    inherit MachineLearningWorkspaceConnectionProperties

Public Class ApiKeyAuthWorkspaceConnectionProperties
Inherits MachineLearningWorkspaceConnectionProperties
Implements IJsonModel(Of ApiKeyAuthWorkspaceConnectionProperties), IPersistableModel(Of ApiKeyAuthWorkspaceConnectionProperties)

Public Class ApiKeyAuthWorkspaceConnectionProperties
Inherits MachineLearningWorkspaceConnectionProperties

Inheritance: Object

MachineLearningWorkspaceConnectionProperties
ApiKeyAuthWorkspaceConnectionProperties

Implements: IJsonModel<ApiKeyAuthWorkspaceConnectionProperties> IPersistableModel<ApiKeyAuthWorkspaceConnectionProperties> IPersistableModel<T>

Constructors

ApiKeyAuthWorkspaceConnectionProperties()

Initializes a new instance of ApiKeyAuthWorkspaceConnectionProperties.

Properties

Category	Category of the connection. (Inherited from MachineLearningWorkspaceConnectionProperties)
CreatedByWorkspaceArmId	Gets the created by workspace arm id. (Inherited from MachineLearningWorkspaceConnectionProperties)
CredentialsKey	Gets or sets the credentials key.
ExpiryOn	Gets or sets the expiry on. (Inherited from MachineLearningWorkspaceConnectionProperties)
Group	Group based on connection category. (Inherited from MachineLearningWorkspaceConnectionProperties)
IsSharedToAll	Gets or sets the is shared to all. (Inherited from MachineLearningWorkspaceConnectionProperties)
Metadata	Store user metadata for this connection. (Inherited from MachineLearningWorkspaceConnectionProperties)
SharedUserList	Gets the shared user list. (Inherited from MachineLearningWorkspaceConnectionProperties)
Target	Gets or sets the target. (Inherited from MachineLearningWorkspaceConnectionProperties)

Explicit Interface Implementations

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

Applies to

Share via