Package version:

Interface AzureSqlDatabaseLinkedService

Microsoft Azure SQL Database linked service.

interface AzureSqlDatabaseLinkedService {
    alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties;
    annotations?: any[];
    applicationIntent?: any;
    authenticationType?: string;
    azureCloudType?: any;
    commandTimeout?: any;
    connectionString?: any;
    connectRetryCount?: any;
    connectRetryInterval?: any;
    connectTimeout?: any;
    connectVia?: IntegrationRuntimeReference;
    credential?: CredentialReference;
    database?: any;
    description?: string;
    encrypt?: any;
    encryptedCredential?: string;
    failoverPartner?: any;
    hostNameInCertificate?: any;
    integratedSecurity?: any;
    loadBalanceTimeout?: any;
    maxPoolSize?: any;
    minPoolSize?: any;
    multipleActiveResultSets?: any;
    multiSubnetFailover?: any;
    packetSize?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    password?: AzureKeyVaultSecretReference;
    pooling?: any;
    server?: any;
    servicePrincipalCredential?: SecretBaseUnion;
    servicePrincipalCredentialType?: any;
    servicePrincipalId?: any;
    servicePrincipalKey?: SecretBaseUnion;
    tenant?: any;
    trustServerCertificate?: any;
    type: "AzureSqlDatabase";
    userName?: any;
    version?: string;
}

Hierarchy (view full)

Properties

alwaysEncryptedSettings? annotations? applicationIntent? authenticationType? azureCloudType? commandTimeout? connectionString? connectRetryCount? connectRetryInterval? connectTimeout? connectVia? credential? database? description? encrypt? encryptedCredential? failoverPartner? hostNameInCertificate? integratedSecurity? loadBalanceTimeout? maxPoolSize? minPoolSize? multipleActiveResultSets? multiSubnetFailover? packetSize? parameters? password? pooling? server? servicePrincipalCredential? servicePrincipalCredentialType? servicePrincipalId? servicePrincipalKey? tenant? trustServerCertificate? type userName? version?

Properties

OptionalalwaysEncryptedSettings

alwaysEncryptedSettings?: SqlAlwaysEncryptedProperties

Sql always encrypted properties.

Optionalannotations

annotations?: any[]

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

OptionalapplicationIntent

applicationIntent?: any

The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string).

OptionalauthenticationType

authenticationType?: string

The type used for authentication. Type: string.

OptionalazureCloudType

azureCloudType?: any

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

OptionalcommandTimeout

commandTimeout?: any

The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).

OptionalconnectionString

connectionString?: any

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

OptionalconnectRetryCount

connectRetryCount?: any

The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer).

OptionalconnectRetryInterval

connectRetryInterval?: any

The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer).

OptionalconnectTimeout

connectTimeout?: any

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer).

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionalcredential

credential?: CredentialReference

The credential reference containing authentication information.

Optionaldatabase

database?: any

The name of the database, used by recommended version. Type: string (or Expression with resultType string).

Optionaldescription

description?: string

Linked service description.

Optionalencrypt

encrypt?: any

Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string).

OptionalencryptedCredential

encryptedCredential?: string

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

OptionalfailoverPartner

failoverPartner?: any

The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string).

OptionalhostNameInCertificate

hostNameInCertificate?: any

The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string).

OptionalintegratedSecurity

integratedSecurity?: any

Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean).

OptionalloadBalanceTimeout

loadBalanceTimeout?: any

The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer).

OptionalmaxPoolSize

maxPoolSize?: any

The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).

OptionalminPoolSize

minPoolSize?: any

The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer).

OptionalmultipleActiveResultSets

multipleActiveResultSets?: any

When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean).

OptionalmultiSubnetFailover

multiSubnetFailover?: any

If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean).

OptionalpacketSize

packetSize?: any

The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer).

Optionalparameters

parameters?: {
    [propertyName: string]: ParameterSpecification;
}

Parameters for linked service.

Optionalpassword

password?: AzureKeyVaultSecretReference

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

Optionalpooling

pooling?: any

Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean).

Optionalserver

server?: any

The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string).

OptionalservicePrincipalCredential

servicePrincipalCredential?: SecretBaseUnion

The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.

OptionalservicePrincipalCredentialType

servicePrincipalCredentialType?: any

The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).

OptionalservicePrincipalId

servicePrincipalId?: any

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

OptionalservicePrincipalKey

servicePrincipalKey?: SecretBaseUnion

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

Optionaltenant

tenant?: any

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

OptionaltrustServerCertificate

trustServerCertificate?: any

Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean).

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserName

userName?: any

The user name to be used when connecting to server. Type: string (or Expression with resultType string).

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility