Package com.azure.ai.openai.models

Class OnYourDataAuthenticationType

java.lang.Object

com.azure.core.util.ExpandableStringEnum<OnYourDataAuthenticationType>

com.azure.ai.openai.models.OnYourDataAuthenticationType

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class OnYourDataAuthenticationType
extends com.azure.core.util.ExpandableStringEnum<OnYourDataAuthenticationType>

The authentication types supported with Azure OpenAI On Your Data.

Field Summary

Fields

Modifier and Type	Field	Description
static final OnYourDataAuthenticationType	ACCESS_TOKEN	Authentication via access token.
static final OnYourDataAuthenticationType	API_KEY	Authentication via API key.
static final OnYourDataAuthenticationType	CONNECTION_STRING	Authentication via connection string.
static final OnYourDataAuthenticationType	ENCODED_API_KEY	Authentication via encoded API key.
static final OnYourDataAuthenticationType	KEY_AND_KEY_ID	Authentication via key and key ID pair.
static final OnYourDataAuthenticationType	SYSTEM_ASSIGNED_MANAGED_IDENTITY	Authentication via system-assigned managed identity.
static final OnYourDataAuthenticationType	USER_ASSIGNED_MANAGED_IDENTITY	Authentication via user-assigned managed identity.
static final OnYourDataAuthenticationType	USERNAME_AND_PASSWORD	Authentication via username and password.

Constructor Summary

Constructors

Constructor	Description
OnYourDataAuthenticationType()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static OnYourDataAuthenticationType	fromString(String name)	Creates or finds a OnYourDataAuthenticationType from its string representation.
static Collection<OnYourDataAuthenticationType>	values()	Gets known OnYourDataAuthenticationType values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

API_KEY

public static final OnYourDataAuthenticationType API_KEY

Authentication via API key.

CONNECTION_STRING

public static final OnYourDataAuthenticationType CONNECTION_STRING

Authentication via connection string.

KEY_AND_KEY_ID

public static final OnYourDataAuthenticationType KEY_AND_KEY_ID

Authentication via key and key ID pair.

ENCODED_API_KEY

public static final OnYourDataAuthenticationType ENCODED_API_KEY

Authentication via encoded API key.

ACCESS_TOKEN

public static final OnYourDataAuthenticationType ACCESS_TOKEN

Authentication via access token.

SYSTEM_ASSIGNED_MANAGED_IDENTITY

public static final OnYourDataAuthenticationType SYSTEM_ASSIGNED_MANAGED_IDENTITY

Authentication via system-assigned managed identity.

USER_ASSIGNED_MANAGED_IDENTITY

public static final OnYourDataAuthenticationType USER_ASSIGNED_MANAGED_IDENTITY

Authentication via user-assigned managed identity.

USERNAME_AND_PASSWORD

public static final OnYourDataAuthenticationType USERNAME_AND_PASSWORD

Authentication via username and password.

Constructor Details

OnYourDataAuthenticationType

@Deprecated
public OnYourDataAuthenticationType()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of OnYourDataAuthenticationType value.

Method Details

fromString

public static OnYourDataAuthenticationType fromString(String name)

Creates or finds a OnYourDataAuthenticationType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding OnYourDataAuthenticationType.

values

public static Collection<OnYourDataAuthenticationType> values()

Gets known OnYourDataAuthenticationType values.

Returns:

known OnYourDataAuthenticationType values.