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	Authentication type of the connection target
credentials

Inherited Properties

category	Category of the connection
createdByWorkspaceArmId
error
expiryTime
group	Group based on connection category
isSharedToAll
metadata	Store user metadata for this connection
peRequirement
peStatus
sharedUserList
target
useWorkspaceManagedIdentity

Property Details

authType

Authentication type of the connection target

authType: "ApiKey"

Property Value

"ApiKey"

credentials

credentials?: WorkspaceConnectionApiKey

Property Value

WorkspaceConnectionApiKey

Inherited Property Details

category

Category of the connection

category?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.category

createdByWorkspaceArmId

createdByWorkspaceArmId?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.createdByWorkspaceArmId

error

error?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.error

expiryTime

expiryTime?: Date

Property Value

Date

Inherited From WorkspaceConnectionPropertiesV2.expiryTime

group

Group based on connection category

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?: Record<string, string>

Property Value

Record<string, string>

Inherited From WorkspaceConnectionPropertiesV2.metadata

peRequirement

peRequirement?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.peRequirement

peStatus

peStatus?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.peStatus

sharedUserList

sharedUserList?: string[]

Property Value

string[]

Inherited From WorkspaceConnectionPropertiesV2.sharedUserList

target

target?: string

Property Value

string

Inherited From WorkspaceConnectionPropertiesV2.target

useWorkspaceManagedIdentity

useWorkspaceManagedIdentity?: boolean

Property Value

boolean

Inherited From WorkspaceConnectionPropertiesV2.useWorkspaceManagedIdentity