ApiKeyAuthConnectionPropertiesArgs

data class ApiKeyAuthConnectionPropertiesArgs(val authType: Output<String>, val category: Output<Either<String, ConnectionCategory>>? = null, val credentials: Output<ConnectionApiKeyArgs>? = null, val error: Output<String>? = null, val expiryTime: Output<String>? = null, val isSharedToAll: Output<Boolean>? = null, val metadata: Output<Map<String, String>>? = null, val peRequirement: Output<Either<String, ManagedPERequirement>>? = null, val peStatus: Output<Either<String, ManagedPEStatus>>? = null, val sharedUserList: Output<List<String>>? = null, val target: Output<String>? = null, val useWorkspaceManagedIdentity: Output<Boolean>? = null) : ConvertibleToJava<ApiKeyAuthConnectionPropertiesArgs>

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

Constructors

Link copied to clipboard
constructor(authType: Output<String>, category: Output<Either<String, ConnectionCategory>>? = null, credentials: Output<ConnectionApiKeyArgs>? = null, error: Output<String>? = null, expiryTime: Output<String>? = null, isSharedToAll: Output<Boolean>? = null, metadata: Output<Map<String, String>>? = null, peRequirement: Output<Either<String, ManagedPERequirement>>? = null, peStatus: Output<Either<String, ManagedPEStatus>>? = null, sharedUserList: Output<List<String>>? = null, target: Output<String>? = null, useWorkspaceManagedIdentity: Output<Boolean>? = 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
val credentials: Output<ConnectionApiKeyArgs>? = null

Api key object for connection credential.

Link copied to clipboard
val error: Output<String>? = null
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 peRequirement: Output<Either<String, ManagedPERequirement>>? = null
Link copied to clipboard
val peStatus: Output<Either<String, ManagedPEStatus>>? = null
Link copied to clipboard
val sharedUserList: Output<List<String>>? = null
Link copied to clipboard
val target: Output<String>? = null
Link copied to clipboard

Functions

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