Package com.azure.analytics.synapse.artifacts.models

Class AzureSqlDatabaseLinkedService

  • public class AzureSqlDatabaseLinkedService
extends LinkedService
    Microsoft Azure SQL Database linked service.

    • Constructor Detail

      • AzureSqlDatabaseLinkedService

        public AzureSqlDatabaseLinkedService()

    • Method Detail

      • getConnectionString

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

      • setConnectionString

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

      • getPassword

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

      • setPassword

        public AzureSqlDatabaseLinkedService setPassword​(AzureKeyVaultSecretReference password)
        Set the password property: The Azure key vault secret reference of password in connection string.
        Parameters:
        password - the password value to set.
        Returns:
        the AzureSqlDatabaseLinkedService object itself.

      • getServicePrincipalId

        public Object getServicePrincipalId()
        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.

      • setServicePrincipalId

        public AzureSqlDatabaseLinkedService setServicePrincipalId​(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 AzureSqlDatabaseLinkedService object itself.

      • getServicePrincipalKey

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

      • setServicePrincipalKey

        public AzureSqlDatabaseLinkedService setServicePrincipalKey​(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 AzureSqlDatabaseLinkedService object itself.

      • getTenant

        public Object getTenant()
        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.

      • setTenant

        public AzureSqlDatabaseLinkedService setTenant​(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 AzureSqlDatabaseLinkedService object itself.

      • getAzureCloudType

        public Object getAzureCloudType()
        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.

      • setAzureCloudType

        public AzureSqlDatabaseLinkedService setAzureCloudType​(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 AzureSqlDatabaseLinkedService object itself.

      • getEncryptedCredential

        public Object getEncryptedCredential()
        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.

      • setEncryptedCredential

        public AzureSqlDatabaseLinkedService setEncryptedCredential​(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 AzureSqlDatabaseLinkedService object itself.

      • setAnnotations

        public AzureSqlDatabaseLinkedService setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        setAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.