Package com.azure.resourcemanager.datafactory.models

Class AzureSqlDatabaseLinkedService

java.lang.Object
com.azure.resourcemanager.datafactory.models.LinkedService
com.azure.resourcemanager.datafactory.models.AzureSqlDatabaseLinkedService
public final class AzureSqlDatabaseLinkedService extends LinkedService
Microsoft Azure SQL Database linked service.

  • Constructor Details

    • AzureSqlDatabaseLinkedService

      public AzureSqlDatabaseLinkedService()
      Creates an instance of AzureSqlDatabaseLinkedService class.

  • Method Details

    • withConnectVia

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

    • withDescription

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

    • withParameters

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

    • withAnnotations

      public AzureSqlDatabaseLinkedService 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.
      Returns:
      the connectionString value.

    • withConnectionString

      public AzureSqlDatabaseLinkedService withConnectionString(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.

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

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

    • alwaysEncryptedSettings

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

    • withAlwaysEncryptedSettings

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

    • credential

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

    • withCredential

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

    • validate

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