Share via


AzureSqlDatabaseLinkedService Class

Definition

Microsoft Azure SQL Database linked service.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureSqlDatabaseLinkedService+AzureSqlDatabaseLinkedServiceConverter))]
public class AzureSqlDatabaseLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AzureSqlDatabaseLinkedService+AzureSqlDatabaseLinkedServiceConverter))>]
type AzureSqlDatabaseLinkedService = class
    inherit LinkedService
Public Class AzureSqlDatabaseLinkedService
Inherits LinkedService
Inheritance
AzureSqlDatabaseLinkedService
Attributes

Constructors

AzureSqlDatabaseLinkedService(Object)

Initializes a new instance of AzureSqlDatabaseLinkedService.

Properties

AdditionalProperties

Additional Properties.

(Inherited from LinkedService)
AlwaysEncryptedSettings

Sql always encrypted properties.

Annotations

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

(Inherited from LinkedService)
AzureCloudType

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).

ConnectionString

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

ConnectVia

The integration runtime reference.

(Inherited from LinkedService)
Credential

The credential reference containing authentication information.

Description

Linked service description.

(Inherited from LinkedService)
EncryptedCredential

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

Parameters

Parameters for linked service.

(Inherited from LinkedService)
Password

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

ServicePrincipalId

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

ServicePrincipalKey

The key of the service principal used to authenticate against Azure SQL Database. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Tenant

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

Applies to