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

Class AzureSqlDWLinkedService

java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.AzureSqlDWLinkedService
public class AzureSqlDWLinkedService extends LinkedService
Azure SQL Data Warehouse linked service.

  • Constructor Details

    • AzureSqlDWLinkedService

      public AzureSqlDWLinkedService()

  • Method Details

    • getConnectionString

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

    • setConnectionString

      public AzureSqlDWLinkedService setConnectionString(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.

    • 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService object itself.

    • getServicePrincipalId

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

    • setServicePrincipalId

      public AzureSqlDWLinkedService setServicePrincipalId(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.

    • getServicePrincipalKey

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

    • setServicePrincipalKey

      public AzureSqlDWLinkedService setServicePrincipalKey(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.

    • 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService 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 AzureSqlDWLinkedService object itself.

    • setConnectVia

      public AzureSqlDWLinkedService setConnectVia(IntegrationRuntimeReference connectVia)
      Set the connectVia property: The integration runtime reference.
      Overrides:
      setConnectVia in class LinkedService
      Parameters:
      connectVia - the connectVia value to set.
      Returns:
      the LinkedService object itself.

    • setDescription

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

    • setParameters

      public AzureSqlDWLinkedService setParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for linked service.
      Overrides:
      setParameters in class LinkedService
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the LinkedService object itself.

    • setAnnotations

      public AzureSqlDWLinkedService 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.