Class AzureSqlDatabaseLinkedServiceTypeProperties


  • public final class AzureSqlDatabaseLinkedServiceTypeProperties
    extends Object
    Azure SQL Database linked service properties.
    • Constructor Detail

      • AzureSqlDatabaseLinkedServiceTypeProperties

        public AzureSqlDatabaseLinkedServiceTypeProperties()
    • Method Detail

      • connectionString

        public Object connectionString()
        Get the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
        Returns:
        the connectionString value.
      • withConnectionString

        public AzureSqlDatabaseLinkedServiceTypeProperties withConnectionString​(Object connectionString)
        Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • password

        public AzureKeyVaultSecretReference password()
        Get the password property: The Azure key vault secret reference of password in connection string.
        Returns:
        the password value.
      • servicePrincipalId

        public Object servicePrincipalId()
        Get the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
        Returns:
        the servicePrincipalId value.
      • withServicePrincipalId

        public AzureSqlDatabaseLinkedServiceTypeProperties withServicePrincipalId​(Object servicePrincipalId)
        Set the servicePrincipalId property: The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).
        Parameters:
        servicePrincipalId - the servicePrincipalId value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • servicePrincipalKey

        public SecretBase servicePrincipalKey()
        Get the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Database.
        Returns:
        the servicePrincipalKey value.
      • withServicePrincipalKey

        public AzureSqlDatabaseLinkedServiceTypeProperties withServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Database.
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • tenant

        public Object tenant()
        Get the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Returns:
        the tenant value.
      • withTenant

        public AzureSqlDatabaseLinkedServiceTypeProperties withTenant​(Object tenant)
        Set the tenant property: The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).
        Parameters:
        tenant - the tenant value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • azureCloudType

        public Object azureCloudType()
        Get the azureCloudType property: Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
        Returns:
        the azureCloudType value.
      • withAzureCloudType

        public AzureSqlDatabaseLinkedServiceTypeProperties withAzureCloudType​(Object azureCloudType)
        Set the azureCloudType property: Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
        Parameters:
        azureCloudType - the azureCloudType value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • encryptedCredential

        public Object encryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.
      • withEncryptedCredential

        public AzureSqlDatabaseLinkedServiceTypeProperties withEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • alwaysEncryptedSettings

        public SqlAlwaysEncryptedProperties alwaysEncryptedSettings()
        Get the alwaysEncryptedSettings property: Sql always encrypted properties.
        Returns:
        the alwaysEncryptedSettings value.
      • withAlwaysEncryptedSettings

        public AzureSqlDatabaseLinkedServiceTypeProperties withAlwaysEncryptedSettings​(SqlAlwaysEncryptedProperties alwaysEncryptedSettings)
        Set the alwaysEncryptedSettings property: Sql always encrypted properties.
        Parameters:
        alwaysEncryptedSettings - the alwaysEncryptedSettings value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • credential

        public CredentialReference credential()
        Get the credential property: The credential reference containing authentication information.
        Returns:
        the credential value.
      • withCredential

        public AzureSqlDatabaseLinkedServiceTypeProperties withCredential​(CredentialReference credential)
        Set the credential property: The credential reference containing authentication information.
        Parameters:
        credential - the credential value to set.
        Returns:
        the AzureSqlDatabaseLinkedServiceTypeProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.