ApiKeyAuthConnectionPropertiesResponse

data class ApiKeyAuthConnectionPropertiesResponse(val authType: String, val category: String? = null, val createdByWorkspaceArmId: String, val credentials: ConnectionApiKeyResponse? = null, val error: String? = null, val expiryTime: String? = null, val group: String, val isSharedToAll: Boolean? = null, val metadata: Map<String, String>? = null, val peRequirement: String? = null, val peStatus: String? = null, val sharedUserList: List<String>? = null, val target: String? = null, val useWorkspaceManagedIdentity: Boolean? = null)

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: String, category: String? = null, createdByWorkspaceArmId: String, credentials: ConnectionApiKeyResponse? = null, error: String? = null, expiryTime: String? = null, group: String, isSharedToAll: Boolean? = null, metadata: Map<String, String>? = null, peRequirement: String? = null, peStatus: String? = null, sharedUserList: List<String>? = null, target: String? = null, useWorkspaceManagedIdentity: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
val category: String? = null

Category of the connection

Link copied to clipboard

Api key object for connection credential.

Link copied to clipboard
val error: String? = null
Link copied to clipboard
val expiryTime: String? = null
Link copied to clipboard

Group based on connection category

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

Store user metadata for this connection

Link copied to clipboard
val peRequirement: String? = null
Link copied to clipboard
val peStatus: String? = null
Link copied to clipboard
val sharedUserList: List<String>? = null
Link copied to clipboard
val target: String? = null
Link copied to clipboard