AzureActiveDirectoryApplicationCredentials Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.AzureActiveDirectoryApplicationCredentials

Implements

JsonSerializable<AzureActiveDirectoryApplicationCredentials>

public final class AzureActiveDirectoryApplicationCredentials
implements JsonSerializable<AzureActiveDirectoryApplicationCredentials>

Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.

Constructor Summary

Constructor Description
AzureActiveDirectoryApplicationCredentials(String applicationId)

Creates an instance of AzureActiveDirectoryApplicationCredentials class.

Method Summary

Modifier and Type Method and Description
static AzureActiveDirectoryApplicationCredentials fromJson(JsonReader jsonReader)

Reads an instance of AzureActiveDirectoryApplicationCredentials from the JsonReader.
String getApplicationId()

Get the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest.
String getApplicationSecret()

Get the applicationSecret property: The authentication key of the specified AAD application.
AzureActiveDirectoryApplicationCredentials setApplicationSecret(String applicationSecret)

Set the applicationSecret property: The authentication key of the specified AAD application.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureActiveDirectoryApplicationCredentials

public AzureActiveDirectoryApplicationCredentials(String applicationId)

Creates an instance of AzureActiveDirectoryApplicationCredentials class.

Parameters:

applicationId - the applicationId value to set.

Method Details

fromJson

public static AzureActiveDirectoryApplicationCredentials fromJson(JsonReader jsonReader)

Reads an instance of AzureActiveDirectoryApplicationCredentials from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getApplicationId

public String getApplicationId()

Get the applicationId property: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.

Returns:

the applicationId value.

getApplicationSecret

public String getApplicationSecret()

Get the applicationSecret property: The authentication key of the specified AAD application.

Returns:

the applicationSecret value.

setApplicationSecret

public AzureActiveDirectoryApplicationCredentials setApplicationSecret(String applicationSecret)

Set the applicationSecret property: The authentication key of the specified AAD application.

Parameters:

applicationSecret - the applicationSecret value to set.

Returns:

the AzureActiveDirectoryApplicationCredentials object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to