AzureSqlDatabaseLinkedServiceArgs

data class AzureSqlDatabaseLinkedServiceArgs(val alwaysEncryptedSettings: Output<SqlAlwaysEncryptedPropertiesArgs>? = null, val annotations: Output<List<Any>>? = null, val applicationIntent: Output<Any>? = null, val authenticationType: Output<Either<String, AzureSqlDatabaseAuthenticationType>>? = null, val azureCloudType: Output<Any>? = null, val commandTimeout: Output<Any>? = null, val connectRetryCount: Output<Any>? = null, val connectRetryInterval: Output<Any>? = null, val connectTimeout: Output<Any>? = null, val connectVia: Output<IntegrationRuntimeReferenceArgs>? = null, val connectionString: Output<Any>? = null, val credential: Output<CredentialReferenceArgs>? = null, val database: Output<Any>? = null, val description: Output<String>? = null, val encrypt: Output<Any>? = null, val encryptedCredential: Output<String>? = null, val failoverPartner: Output<Any>? = null, val hostNameInCertificate: Output<Any>? = null, val integratedSecurity: Output<Any>? = null, val loadBalanceTimeout: Output<Any>? = null, val maxPoolSize: Output<Any>? = null, val minPoolSize: Output<Any>? = null, val multiSubnetFailover: Output<Any>? = null, val multipleActiveResultSets: Output<Any>? = null, val packetSize: Output<Any>? = null, val parameters: Output<Map<String, ParameterSpecificationArgs>>? = null, val password: Output<AzureKeyVaultSecretReferenceArgs>? = null, val pooling: Output<Any>? = null, val server: Output<Any>? = null, val servicePrincipalCredential: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, val servicePrincipalCredentialType: Output<Any>? = null, val servicePrincipalId: Output<Any>? = null, val servicePrincipalKey: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, val tenant: Output<Any>? = null, val trustServerCertificate: Output<Any>? = null, val type: Output<String>, val userName: Output<Any>? = null, val version: Output<String>? = null) : ConvertibleToJava<AzureSqlDatabaseLinkedServiceArgs>

Microsoft Azure SQL Database linked service.

Constructors

Link copied to clipboard
constructor(alwaysEncryptedSettings: Output<SqlAlwaysEncryptedPropertiesArgs>? = null, annotations: Output<List<Any>>? = null, applicationIntent: Output<Any>? = null, authenticationType: Output<Either<String, AzureSqlDatabaseAuthenticationType>>? = null, azureCloudType: Output<Any>? = null, commandTimeout: Output<Any>? = null, connectRetryCount: Output<Any>? = null, connectRetryInterval: Output<Any>? = null, connectTimeout: Output<Any>? = null, connectVia: Output<IntegrationRuntimeReferenceArgs>? = null, connectionString: Output<Any>? = null, credential: Output<CredentialReferenceArgs>? = null, database: Output<Any>? = null, description: Output<String>? = null, encrypt: Output<Any>? = null, encryptedCredential: Output<String>? = null, failoverPartner: Output<Any>? = null, hostNameInCertificate: Output<Any>? = null, integratedSecurity: Output<Any>? = null, loadBalanceTimeout: Output<Any>? = null, maxPoolSize: Output<Any>? = null, minPoolSize: Output<Any>? = null, multiSubnetFailover: Output<Any>? = null, multipleActiveResultSets: Output<Any>? = null, packetSize: Output<Any>? = null, parameters: Output<Map<String, ParameterSpecificationArgs>>? = null, password: Output<AzureKeyVaultSecretReferenceArgs>? = null, pooling: Output<Any>? = null, server: Output<Any>? = null, servicePrincipalCredential: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, servicePrincipalCredentialType: Output<Any>? = null, servicePrincipalId: Output<Any>? = null, servicePrincipalKey: Output<Either<AzureKeyVaultSecretReferenceArgs, SecureStringArgs>>? = null, tenant: Output<Any>? = null, trustServerCertificate: Output<Any>? = null, type: Output<String>, userName: Output<Any>? = null, version: Output<String>? = null)

Properties

Link copied to clipboard

Sql always encrypted properties.

Link copied to clipboard
val annotations: Output<List<Any>>? = null

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

Link copied to clipboard
val applicationIntent: Output<Any>? = null

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

Link copied to clipboard

The type used for authentication. Type: string.

Link copied to clipboard
val azureCloudType: Output<Any>? = null

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

Link copied to clipboard
val commandTimeout: Output<Any>? = null

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

Link copied to clipboard
val connectionString: Output<Any>? = null

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

Link copied to clipboard
val connectRetryCount: Output<Any>? = null

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

Link copied to clipboard
val connectRetryInterval: Output<Any>? = null

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

Link copied to clipboard
val connectTimeout: Output<Any>? = null

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

Link copied to clipboard

The integration runtime reference.

Link copied to clipboard
val credential: Output<CredentialReferenceArgs>? = null

The credential reference containing authentication information.

Link copied to clipboard
val database: Output<Any>? = null

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

Link copied to clipboard
val description: Output<String>? = null

Linked service description.

Link copied to clipboard
val encrypt: Output<Any>? = null

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

Link copied to clipboard
val encryptedCredential: Output<String>? = null

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

Link copied to clipboard
val failoverPartner: Output<Any>? = null

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

Link copied to clipboard
val hostNameInCertificate: Output<Any>? = null

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

Link copied to clipboard
val integratedSecurity: Output<Any>? = null

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

Link copied to clipboard
val loadBalanceTimeout: Output<Any>? = null

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

Link copied to clipboard
val maxPoolSize: Output<Any>? = null

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

Link copied to clipboard
val minPoolSize: Output<Any>? = null

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

Link copied to clipboard
val multipleActiveResultSets: Output<Any>? = null

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

Link copied to clipboard
val multiSubnetFailover: Output<Any>? = null

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

Link copied to clipboard
val packetSize: Output<Any>? = null

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

Link copied to clipboard

Parameters for linked service.

Link copied to clipboard

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

Link copied to clipboard
val pooling: Output<Any>? = null

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

Link copied to clipboard
val server: Output<Any>? = null

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

Link copied to clipboard

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.

Link copied to clipboard
val servicePrincipalCredentialType: Output<Any>? = null

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

Link copied to clipboard
val servicePrincipalId: Output<Any>? = null

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

Link copied to clipboard

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

Link copied to clipboard
val tenant: Output<Any>? = null

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

Link copied to clipboard
val trustServerCertificate: Output<Any>? = null

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

Link copied to clipboard
val type: Output<String>

Type of linked service. Expected value is 'AzureSqlDatabase'.

Link copied to clipboard
val userName: Output<Any>? = null

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

Link copied to clipboard
val version: Output<String>? = null

Version of the linked service.

Functions

Link copied to clipboard
open override fun toJava(): AzureSqlDatabaseLinkedServiceArgs