SqlAlwaysEncryptedProperties Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.models.SqlAlwaysEncryptedProperties

Implements

JsonSerializable<SqlAlwaysEncryptedProperties>

public final class SqlAlwaysEncryptedProperties
implements JsonSerializable<SqlAlwaysEncryptedProperties>

Sql always encrypted properties.

Constructor Summary

Constructor Description
SqlAlwaysEncryptedProperties()

Creates an instance of SqlAlwaysEncryptedProperties class.

Method Summary

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

Reads an instance of SqlAlwaysEncryptedProperties from the JsonReader.
SqlAlwaysEncryptedAkvAuthType getAlwaysEncryptedAkvAuthType()

Get the alwaysEncryptedAkvAuthType property: Sql always encrypted AKV authentication type.
CredentialReference getCredential()

Get the credential property: The credential reference containing authentication information.
Object getServicePrincipalId()

Get the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Azure Key Vault authentication.
SecretBase getServicePrincipalKey()

Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure Key Vault.
SqlAlwaysEncryptedProperties setAlwaysEncryptedAkvAuthType(SqlAlwaysEncryptedAkvAuthType alwaysEncryptedAkvAuthType)

Set the alwaysEncryptedAkvAuthType property: Sql always encrypted AKV authentication type.
SqlAlwaysEncryptedProperties setCredential(CredentialReference credential)

Set the credential property: The credential reference containing authentication information.
SqlAlwaysEncryptedProperties setServicePrincipalId(Object servicePrincipalId)

Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Azure Key Vault authentication.
SqlAlwaysEncryptedProperties setServicePrincipalKey(SecretBase servicePrincipalKey)

Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure Key Vault.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlAlwaysEncryptedProperties

public SqlAlwaysEncryptedProperties()

Creates an instance of SqlAlwaysEncryptedProperties class.

Method Details

fromJson

public static SqlAlwaysEncryptedProperties fromJson(JsonReader jsonReader)

Reads an instance of SqlAlwaysEncryptedProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlAlwaysEncryptedProperties 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.

getAlwaysEncryptedAkvAuthType

public SqlAlwaysEncryptedAkvAuthType getAlwaysEncryptedAkvAuthType()

Get the alwaysEncryptedAkvAuthType property: Sql always encrypted AKV authentication type. Type: string.

Returns:

the alwaysEncryptedAkvAuthType value.

getCredential

public CredentialReference getCredential()

Get the credential property: The credential reference containing authentication information.

Returns:

the credential value.

getServicePrincipalId

public Object getServicePrincipalId()

Get the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string).

Returns:

the servicePrincipalId value.

getServicePrincipalKey

public SecretBase getServicePrincipalKey()

Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure Key Vault.

Returns:

the servicePrincipalKey value.

setAlwaysEncryptedAkvAuthType

public SqlAlwaysEncryptedProperties setAlwaysEncryptedAkvAuthType(SqlAlwaysEncryptedAkvAuthType alwaysEncryptedAkvAuthType)

Set the alwaysEncryptedAkvAuthType property: Sql always encrypted AKV authentication type. Type: string.

Parameters:

alwaysEncryptedAkvAuthType - the alwaysEncryptedAkvAuthType value to set.

Returns:

the SqlAlwaysEncryptedProperties object itself.

setCredential

public SqlAlwaysEncryptedProperties setCredential(CredentialReference credential)

Set the credential property: The credential reference containing authentication information.

Parameters:

credential - the credential value to set.

Returns:

the SqlAlwaysEncryptedProperties object itself.

setServicePrincipalId

public SqlAlwaysEncryptedProperties setServicePrincipalId(Object servicePrincipalId)

Set the servicePrincipalId property: The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string).

Parameters:

servicePrincipalId - the servicePrincipalId value to set.

Returns:

the SqlAlwaysEncryptedProperties object itself.

setServicePrincipalKey

public SqlAlwaysEncryptedProperties setServicePrincipalKey(SecretBase servicePrincipalKey)

Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure Key Vault.

Parameters:

servicePrincipalKey - the servicePrincipalKey value to set.

Returns:

the SqlAlwaysEncryptedProperties object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to