Class AzureSqlDWLinkedService


  • public final class AzureSqlDWLinkedService
    extends LinkedService
    Azure SQL Data Warehouse linked service.
    • Constructor Detail

      • AzureSqlDWLinkedService

        public AzureSqlDWLinkedService()
    • Method Detail

      • withDescription

        public AzureSqlDWLinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.
      • withAnnotations

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

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

        public AzureSqlDWLinkedService withConnectionString​(Object connectionString)
        Set the connectionString property: The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.
        Parameters:
        connectionString - the connectionString value to set.
        Returns:
        the AzureSqlDWLinkedService 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.
      • withPassword

        public AzureSqlDWLinkedService withPassword​(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 AzureSqlDWLinkedService object itself.
      • servicePrincipalId

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

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

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

        public AzureSqlDWLinkedService withServicePrincipalKey​(SecretBase servicePrincipalKey)
        Set the servicePrincipalKey property: The key of the service principal used to authenticate against Azure SQL Data Warehouse.
        Parameters:
        servicePrincipalKey - the servicePrincipalKey value to set.
        Returns:
        the AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService object itself.
      • credential

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

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