MySqlLinkedService interface

Package:

@azure/arm-datafactory

Linked service for MySQL data source.

Extends

LinkedService

Properties

allowZeroDateTime	This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean.
connectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
connectionTimeout	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer.
convertZeroDateTime	True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean.
database	Database name for connection. Type: string.
driverVersion	The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.
encryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
guidFormat	Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID.
password	The Azure key vault secret reference of password in connection string.
port	The port for the connection. Type: integer.
server	Server name for connection. Type: string.
sslCert	The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string.
sslKey	The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string.
sslMode	SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.
treatTinyAsBoolean	When set to true, TINYINT(1) values are returned as booleans. Type: bool.
type	Polymorphic discriminator, which specifies the different types this object can be
username	Username for authentication. Type: string.
useSystemTrustStore	Use system trust store for connection. Type: integer. 0: enable, 1: disable.

Inherited Properties

annotations	List of tags that can be used for describing the linked service.
connectVia	The integration runtime reference.
description	Linked service description.
parameters	Parameters for linked service.
version	Version of the linked service.

Property Details

allowZeroDateTime

This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean.

allowZeroDateTime?: any

Property Value

any

connectionString

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

connectionString?: any

Property Value

any

connectionTimeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer.

connectionTimeout?: any

Property Value

any

convertZeroDateTime

True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean.

convertZeroDateTime?: any

Property Value

any

database

Database name for connection. Type: string.

database?: any

Property Value

any

driverVersion

The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string.

driverVersion?: any

Property Value

any

encryptedCredential

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

encryptedCredential?: string

Property Value

string

guidFormat

Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID.

guidFormat?: any

Property Value

any

password

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

password?: AzureKeyVaultSecretReference

Property Value

AzureKeyVaultSecretReference

port

The port for the connection. Type: integer.

port?: any

Property Value

any

server

Server name for connection. Type: string.

server?: any

Property Value

any

sslCert

The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string.

sslCert?: any

Property Value

any

sslKey

The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string.

sslKey?: any

Property Value

any

sslMode

SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full.

sslMode?: any

Property Value

any

treatTinyAsBoolean

When set to true, TINYINT(1) values are returned as booleans. Type: bool.

treatTinyAsBoolean?: any

Property Value

any

type

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

type: "MySql"

Property Value

"MySql"

username

Username for authentication. Type: string.

username?: any

Property Value

any

useSystemTrustStore

Use system trust store for connection. Type: integer. 0: enable, 1: disable.

useSystemTrustStore?: any

Property Value

any

Inherited Property Details

annotations

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

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

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

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version