ApiKeyAuthWorkspaceConnectionPropertiesArgs

data class ApiKeyAuthWorkspaceConnectionPropertiesArgs(val authType: Output<String>, val category: Output<Either<String, ConnectionCategory>>? = null, val credentials: Output<WorkspaceConnectionApiKeyArgs>? = null, val expiryTime: Output<String>? = null, val isSharedToAll: Output<Boolean>? = null, val metadata: Output<Map<String, String>>? = null, val sharedUserList: Output<List<String>>? = null, val target: Output<String>? = null, val value: Output<String>? = null, val valueFormat: Output<Either<String, ValueFormat>>? = null) : ConvertibleToJava<ApiKeyAuthWorkspaceConnectionPropertiesArgs>

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

Constructors

constructor(authType: Output<String>, category: Output<Either<String, ConnectionCategory>>? = null, credentials: Output<WorkspaceConnectionApiKeyArgs>? = null, expiryTime: Output<String>? = null, isSharedToAll: Output<Boolean>? = null, metadata: Output<Map<String, String>>? = null, sharedUserList: Output<List<String>>? = null, target: Output<String>? = null, value: Output<String>? = null, valueFormat: Output<Either<String, ValueFormat>>? = null)

Properties

Link copied to clipboard
val authType: Output<String>

Authentication type of the connection target Expected value is 'ApiKey'.

Link copied to clipboard
val category: Output<Either<String, ConnectionCategory>>? = null

Category of the connection

Link copied to clipboard

Api key object for workspace connection credential.

Link copied to clipboard
val expiryTime: Output<String>? = null
Link copied to clipboard
val isSharedToAll: Output<Boolean>? = null
Link copied to clipboard
val metadata: Output<Map<String, String>>? = null

Store user metadata for this connection

Link copied to clipboard
val sharedUserList: Output<List<String>>? = null
Link copied to clipboard
val target: Output<String>? = null
Link copied to clipboard
val value: Output<String>? = null

Value details of the workspace connection.

Link copied to clipboard
val valueFormat: Output<Either<String, ValueFormat>>? = null

format for the workspace connection value

Functions

Link copied to clipboard
open override fun toJava(): ApiKeyAuthWorkspaceConnectionPropertiesArgs