ApiKeyAuthConnectionProperties interface

Balíček:

@azure/arm-cognitiveservices

Tento typ připojení pokrývá obecné kategorie připojení ověřování ApiKey, například: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (jako diskriminátor typu) Credentials:= {ApiKey} as . ApiKey cíl:= {apiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (jako diskriminátor typu) Credentials:= {SubscriptionKey} as ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (jako diskriminátor typu) Credentials:= {Key} as ApiKey Target:= {endpoint}

Použití sady vlastností Metadata pro pole ApiType, ApiVersion, Kind a dalších polí metadat

Extends

ConnectionPropertiesV2

Vlastnosti

authType	Polymorfní diskriminátor, který určuje různé typy tohoto objektu
credentials	Objekt klíče rozhraní API pro přihlašovací údaje připojení.

Zděděné vlastnosti

category	Kategorie připojení
createdByWorkspaceArmId	POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
error
expiryTime
group	Skupina na základě kategorie připojení POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
isSharedToAll
metadata	Ukládat metadata uživatelů pro toto připojení
peRequirement
peStatus
sharedUserList
target
useWorkspaceManagedIdentity

Podrobnosti vlastnosti

authType

Polymorfní diskriminátor, který určuje různé typy tohoto objektu

authType: "ApiKey"

Hodnota vlastnosti

"ApiKey"

credentials

Objekt klíče rozhraní API pro přihlašovací údaje připojení.

credentials?: ConnectionApiKey

Hodnota vlastnosti

ConnectionApiKey

Podrobnosti zděděných vlastností

category

Kategorie připojení

category?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.category

createdByWorkspaceArmId

POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

createdByWorkspaceArmId?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.createdByWorkspaceArmId

error

error?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.error

expiryTime

expiryTime?: Date

Hodnota vlastnosti

Date

Zděděno zConnectionPropertiesV2.expiryTime

group

Skupina na základě kategorie připojení POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

group?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.group

isSharedToAll

isSharedToAll?: boolean

Hodnota vlastnosti

boolean

Zděděno zConnectionPropertiesV2.isSharedToAll

metadata

Ukládat metadata uživatelů pro toto připojení

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

Hodnota vlastnosti

{[propertyName: string]: string}

Zděděno zConnectionPropertiesV2.metadata

peRequirement

peRequirement?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.peRequirement

peStatus

peStatus?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.peStatus

sharedUserList

sharedUserList?: string[]

Hodnota vlastnosti

string[]

Zděděno zConnectionPropertiesV2.sharedUserList

target

target?: string

Hodnota vlastnosti

string

Zděděno zConnectionPropertiesV2.target

useWorkspaceManagedIdentity

useWorkspaceManagedIdentity?: boolean

Hodnota vlastnosti

boolean

Zděděno zConnectionPropertiesV2.useWorkspaceManagedIdentity