ApiKeyAuthWorkspaceConnectionProperties interface

Package:

@azure/arm-machinelearning

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

Extends

WorkspaceConnectionPropertiesV2

Properties

authType	Polymorphic discriminator, which specifies the different types this object can be
credentials	Api key object for workspace connection credential.

Inherited Properties

category	Category of the connection
createdByWorkspaceArmId	NOTE: This property will not be serialized. It can only be populated by the server.
expiryTime
group	Group based on connection category NOTE: This property will not be serialized. It can only be populated by the server.
isSharedToAll
metadata	Store user metadata for this connection
sharedUserList
target
value	Value details of the workspace connection.
valueFormat	format for the workspace connection value

Property Details

authType

Polymorphic discriminator, which specifies the different types this object can be

authType: "ApiKey"

Property Value

"ApiKey"

credentials

Api key object for workspace connection credential.

credentials?: WorkspaceConnectionApiKey

Property Value

WorkspaceConnectionApiKey

Inherited Property Details

category

Category of the connection

category?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.category

createdByWorkspaceArmId

NOTE: This property will not be serialized. It can only be populated by the server.

createdByWorkspaceArmId?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.createdByWorkspaceArmId

expiryTime

expiryTime?: Date

Property Value

Date

Inherited From WorkspaceConnectionPropertiesV2.expiryTime

group

Group based on connection category NOTE: This property will not be serialized. It can only be populated by the server.

group?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.group

isSharedToAll

isSharedToAll?: boolean

Property Value

boolean

Inherited From WorkspaceConnectionPropertiesV2.isSharedToAll

metadata

Store user metadata for this connection

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From WorkspaceConnectionPropertiesV2.metadata

sharedUserList

sharedUserList?: string[]

Property Value

string[]

Inherited From WorkspaceConnectionPropertiesV2.sharedUserList

target

target?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.target

value

Value details of the workspace connection.

value?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.value

valueFormat

format for the workspace connection value

valueFormat?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.valueFormat