ApiKeyAuthConnectionProperties interface

Package:

@azure/arm-cognitiveservices

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

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as ApiKey Target:= {Endpoint}

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

Extends

ConnectionPropertiesV2

Properties

authType	Polymorphic discriminator, which specifies the different types this object can be
credentials	Api key object for 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.
error	Provides the error message if the connection fails
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
peRequirement	Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'.
peStatus	Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'.
sharedUserList
target	The connection URL to be used.
useWorkspaceManagedIdentity

Property Details

authType

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

authType: "ApiKey"

Property Value

"ApiKey"

credentials

Api key object for connection credential.

credentials?: ConnectionApiKey

Property Value

ConnectionApiKey

Inherited Property Details

category

Category of the connection

category?: string

Property Value

string

Inherited From ConnectionPropertiesV2.category

createdByWorkspaceArmId

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

createdByWorkspaceArmId?: string

Property Value

string

Inherited From ConnectionPropertiesV2.createdByWorkspaceArmId

error

Provides the error message if the connection fails

error?: string

Property Value

string

Inherited From ConnectionPropertiesV2.error

expiryTime

expiryTime?: Date

Property Value

Date

Inherited From ConnectionPropertiesV2.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 ConnectionPropertiesV2.group

isSharedToAll

isSharedToAll?: boolean

Property Value

boolean

Inherited From ConnectionPropertiesV2.isSharedToAll

metadata

Store user metadata for this connection

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

Property Value

{[propertyName: string]: string}

Inherited From ConnectionPropertiesV2.metadata

peRequirement

Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'.

peRequirement?: string

Property Value

string

Inherited From ConnectionPropertiesV2.peRequirement

peStatus

Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'.

peStatus?: string

Property Value

string

Inherited From ConnectionPropertiesV2.peStatus

sharedUserList

sharedUserList?: string[]

Property Value

string[]

Inherited From ConnectionPropertiesV2.sharedUserList

target

The connection URL to be used.

target?: string

Property Value

string

Inherited From ConnectionPropertiesV2.target

useWorkspaceManagedIdentity

useWorkspaceManagedIdentity?: boolean

Property Value

boolean

Inherited From ConnectionPropertiesV2.useWorkspaceManagedIdentity