ApiKeyAuthWorkspaceConnectionProperties Class

Definition

Namespace:

Azure.ResourceManager.MachineLearning.Models

Assembly:

Azure.ResourceManager.MachineLearning.dll

Package:

Azure.ResourceManager.MachineLearning v1.2.0-beta.3

Source:

ApiKeyAuthWorkspaceConnectionProperties.cs

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

public class ApiKeyAuthWorkspaceConnectionProperties : Azure.ResourceManager.MachineLearning.Models.MachineLearningWorkspaceConnectionProperties

type ApiKeyAuthWorkspaceConnectionProperties = class
    inherit MachineLearningWorkspaceConnectionProperties

Public Class ApiKeyAuthWorkspaceConnectionProperties
Inherits MachineLearningWorkspaceConnectionProperties

Inheritance

Object

MachineLearningWorkspaceConnectionProperties

ApiKeyAuthWorkspaceConnectionProperties

Constructors

ApiKeyAuthWorkspaceConnectionProperties()

Initializes a new instance of ApiKeyAuthWorkspaceConnectionProperties.

Properties

Category	Category of the connection. (Inherited from MachineLearningWorkspaceConnectionProperties)
CredentialsKey	Gets or sets the credentials key.
ExpiryOn	Gets or sets the expiry on. (Inherited from MachineLearningWorkspaceConnectionProperties)
Metadata	Any object To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from MachineLearningWorkspaceConnectionProperties)
Target	Gets or sets the target. (Inherited from MachineLearningWorkspaceConnectionProperties)