Package com.azure.ai.openai.models

Class OnYourDataUserAssignedManagedIdentityAuthenticationOptions

java.lang.Object

com.azure.ai.openai.models.OnYourDataAuthenticationOptions

com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>

public final class OnYourDataUserAssignedManagedIdentityAuthenticationOptions
extends OnYourDataAuthenticationOptions

The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.

Constructor Summary

Constructors

Constructor	Description
OnYourDataUserAssignedManagedIdentityAuthenticationOptions(String managedIdentityResourceId)	Creates an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataUserAssignedManagedIdentityAuthenticationOptions	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions from the JsonReader.
String	getManagedIdentityResourceId()	Get the managedIdentityResourceId property: The resource ID of the user-assigned managed identity to use for authentication.
OnYourDataAuthenticationType	getType()	Get the type property: The authentication type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OnYourDataUserAssignedManagedIdentityAuthenticationOptions

public OnYourDataUserAssignedManagedIdentityAuthenticationOptions(String managedIdentityResourceId)

Creates an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions class.

Parameters:

managedIdentityResourceId - the managedIdentityResourceId value to set.

Method Details

getManagedIdentityResourceId

public String getManagedIdentityResourceId()

Get the managedIdentityResourceId property: The resource ID of the user-assigned managed identity to use for authentication.

Returns:

the managedIdentityResourceId value.

getType

public OnYourDataAuthenticationType getType()

Get the type property: The authentication type.

Overrides:

getType in class OnYourDataAuthenticationOptions

Returns:

the type value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>

Overrides:

toJson in class OnYourDataAuthenticationOptions

Throws:

IOException

fromJson

public static OnYourDataUserAssignedManagedIdentityAuthenticationOptions fromJson(com.azure.json.JsonReader jsonReader)
                                                                           throws IOException

Reads an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the OnYourDataUserAssignedManagedIdentityAuthenticationOptions.