ApiKeyAuthWorkspaceConnectionProperties Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401

Assembly:: Az.MachineLearningServices.private.dll

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ApiKeyAuthWorkspaceConnectionPropertiesTypeConverter))]
public class ApiKeyAuthWorkspaceConnectionProperties : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IApiKeyAuthWorkspaceConnectionProperties, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.ApiKeyAuthWorkspaceConnectionPropertiesTypeConverter))>]
type ApiKeyAuthWorkspaceConnectionProperties = class
    interface IApiKeyAuthWorkspaceConnectionProperties
    interface IJsonSerializable
    interface IWorkspaceConnectionPropertiesV2
    interface IValidates

Public Class ApiKeyAuthWorkspaceConnectionProperties
Implements IApiKeyAuthWorkspaceConnectionProperties, IValidates

Inheritance: Object
ApiKeyAuthWorkspaceConnectionProperties

Attributes: TypeConverterAttribute

Implements: IApiKeyAuthWorkspaceConnectionProperties IWorkspaceConnectionPropertiesV2 IJsonSerializable IValidates

Constructors

ApiKeyAuthWorkspaceConnectionProperties()

Creates an new ApiKeyAuthWorkspaceConnectionProperties instance.

Properties

AuthType	Authentication type of the connection target
Category	Category of the connection
CreatedByWorkspaceArmId
CredentialsKey
ExpiryTime
Group	Group based on connection category
IsSharedToAll
Metadata	Store user metadata for this connection
SharedUserList
Target
Value	Value details of the workspace connection.
ValueFormat	format for the workspace connection value

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of ApiKeyAuthWorkspaceConnectionProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of ApiKeyAuthWorkspaceConnectionProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IApiKeyAuthWorkspaceConnectionProperties.
FromJsonString(String)	Creates a new instance of ApiKeyAuthWorkspaceConnectionProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of ApiKeyAuthWorkspaceConnectionProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via