ApiKeyAuthConnectionProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
public class ApiKeyAuthConnectionProperties : Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesConnectionProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CognitiveServices.Models.ApiKeyAuthConnectionProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CognitiveServices.Models.ApiKeyAuthConnectionProperties>type ApiKeyAuthConnectionProperties = class
inherit CognitiveServicesConnectionProperties
interface IJsonModel<ApiKeyAuthConnectionProperties>
interface IPersistableModel<ApiKeyAuthConnectionProperties>Public Class ApiKeyAuthConnectionProperties
Inherits CognitiveServicesConnectionProperties
Implements IJsonModel(Of ApiKeyAuthConnectionProperties), IPersistableModel(Of ApiKeyAuthConnectionProperties)- Inheritance
- Implements
Constructors
| ApiKeyAuthConnectionProperties() |
Initializes a new instance of ApiKeyAuthConnectionProperties. |
Properties
| Category |
Category of the connection. (Inherited from CognitiveServicesConnectionProperties) |
| CreatedByWorkspaceArmId |
Gets the created by workspace arm id. (Inherited from CognitiveServicesConnectionProperties) |
| CredentialsKey |
Gets or sets the credentials key. |
| Error |
Provides the error message if the connection fails. (Inherited from CognitiveServicesConnectionProperties) |
| ExpiryOn |
Gets or sets the expiry on. (Inherited from CognitiveServicesConnectionProperties) |
| Group |
Group based on connection category. (Inherited from CognitiveServicesConnectionProperties) |
| IsSharedToAll |
Gets or sets the is shared to all. (Inherited from CognitiveServicesConnectionProperties) |
| Metadata |
Store user metadata for this connection. (Inherited from CognitiveServicesConnectionProperties) |
| PeRequirement |
Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. (Inherited from CognitiveServicesConnectionProperties) |
| PeStatus |
Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. (Inherited from CognitiveServicesConnectionProperties) |
| SharedUserList |
Gets the shared user list. (Inherited from CognitiveServicesConnectionProperties) |
| Target |
The connection URL to be used. (Inherited from CognitiveServicesConnectionProperties) |
| UseWorkspaceManagedIdentity |
Gets or sets the use workspace managed identity. (Inherited from CognitiveServicesConnectionProperties) |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
