Feedback Edit

AzureSqlDatabaseLinkedService Class

  • Reference

Microsoft Azure SQL Database linked service.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
AzureSqlDatabaseLinkedService

Constructor

AzureSqlDatabaseLinkedService(*, connection_string: object, additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, password: Optional[azure.synapse.artifacts.models._models_py3.AzureKeyVaultSecretReference] = None, service_principal_id: Optional[object] = None, service_principal_key: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, tenant: Optional[object] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of linked service.Constant filled by server.

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

List of tags that can be used for describing the linked service.

connection_string
object
Required

Required. The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

password
AzureKeyVaultSecretReference
Required

The Azure key vault secret reference of password in connection string.

service_principal_id
object
Required

The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).

service_principal_key
SecretBase
Required

The key of the service principal used to authenticate against Azure SQL Database.

tenant
object
Required

The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

encrypted_credential
object
Required

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).