ConnectionPropertiesV2 interface

Package:

@azure/arm-cognitiveservices

Connection property base schema.

Properties

authType	Polymorphic discriminator, which specifies the different types this object can be
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: "None" | "PAT" | "ManagedIdentity" | "UsernamePassword" | "SAS" | "AccountKey" | "ServicePrincipal" | "AccessKey" | "ApiKey" | "CustomKeys" | "OAuth2" | "AAD"

Property Value

"None" | "PAT" | "ManagedIdentity" | "UsernamePassword" | "SAS" | "AccountKey" | "ServicePrincipal" | "AccessKey" | "ApiKey" | "CustomKeys" | "OAuth2" | "AAD"

category

Category of the connection

category?: string

Property Value

string

createdByWorkspaceArmId

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

createdByWorkspaceArmId?: string

Property Value

string

error

Provides the error message if the connection fails

error?: string

Property Value

string

expiryTime

expiryTime?: Date

Property Value

Date

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

isSharedToAll

isSharedToAll?: boolean

Property Value

boolean

metadata

Store user metadata for this connection

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

Property Value

{[propertyName: string]: string}

peRequirement

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

peRequirement?: string

Property Value

string

peStatus

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

peStatus?: string

Property Value

string

sharedUserList

sharedUserList?: string[]

Property Value

string[]

target

The connection URL to be used.

target?: string

Property Value

string

useWorkspaceManagedIdentity

useWorkspaceManagedIdentity?: boolean

Property Value

boolean