Share via


MySqlLinkedService Class

Linked service for MySQL data source.

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

Constructor

MySqlLinkedService(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, driver_version: MutableMapping[str, Any] | None = None, connection_string: MutableMapping[str, Any] | None = None, server: MutableMapping[str, Any] | None = None, port: MutableMapping[str, Any] | None = None, username: MutableMapping[str, Any] | None = None, database: MutableMapping[str, Any] | None = None, ssl_mode: MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str, Any] | None = None, password: _models.AzureKeyVaultSecretReference | None = None, encrypted_credential: str | None = None, allow_zero_date_time: MutableMapping[str, Any] | None = None, connection_timeout: MutableMapping[str, Any] | None = None, convert_zero_date_time: MutableMapping[str, Any] | None = None, guid_format: MutableMapping[str, Any] | None = None, ssl_cert: MutableMapping[str, Any] | None = None, ssl_key: MutableMapping[str, Any] | None = None, treat_tiny_as_boolean: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

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

Default value: None
driver_version
<xref:JSON>

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.

Default value: None
connection_string
<xref:JSON>

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

Default value: None
server
<xref:JSON>

Server name for connection. Type: string.

Default value: None
port
<xref:JSON>

The port for the connection. Type: integer.

Default value: None
username
<xref:JSON>

Username for authentication. Type: string.

Default value: None
database
<xref:JSON>

Database name for connection. Type: string.

Default value: None
ssl_mode
<xref:JSON>

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

Default value: None
use_system_trust_store
<xref:JSON>

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

Default value: None
password

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

Default value: None
encrypted_credential
str

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

Default value: None
allow_zero_date_time
<xref:JSON>

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

Default value: None
connection_timeout
<xref:JSON>

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

Default value: None
convert_zero_date_time
<xref:JSON>

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

Default value: None
guid_format
<xref:JSON>

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.

Default value: None
ssl_cert
<xref:JSON>

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

Default value: None
ssl_key
<xref:JSON>

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

Default value: None
treat_tiny_as_boolean
<xref:JSON>

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

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

type
str

Type of linked service. Required.

version
str

Version of the linked service.

connect_via

The integration runtime reference.

description
str

Linked service description.

parameters

Parameters for linked service.

annotations
list[<xref:JSON>]

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

driver_version
<xref:JSON>

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.

connection_string
<xref:JSON>

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

server
<xref:JSON>

Server name for connection. Type: string.

port
<xref:JSON>

The port for the connection. Type: integer.

username
<xref:JSON>

Username for authentication. Type: string.

database
<xref:JSON>

Database name for connection. Type: string.

ssl_mode
<xref:JSON>

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

use_system_trust_store
<xref:JSON>

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

password

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

encrypted_credential
str

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

allow_zero_date_time
<xref:JSON>

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

connection_timeout
<xref:JSON>

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

convert_zero_date_time
<xref:JSON>

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

guid_format
<xref:JSON>

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.

ssl_cert
<xref:JSON>

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

ssl_key
<xref:JSON>

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

treat_tiny_as_boolean
<xref:JSON>

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