Share via

OracleLinkedService Class

  • Reference

Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

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

Constructor

OracleLinkedService(*, 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, connection_string: MutableMapping[str, Any] | None = None, server: MutableMapping[str, Any] | None = None, authentication_type: str | _models.OracleAuthenticationType | None = None, username: MutableMapping[str, Any] | None = None, password: _models.AzureKeyVaultSecretReference | None = None, encryption_client: MutableMapping[str, Any] | None = None, encryption_types_client: MutableMapping[str, Any] | None = None, crypto_checksum_client: MutableMapping[str, Any] | None = None, crypto_checksum_types_client: MutableMapping[str, Any] | None = None, initial_lob_fetch_size: MutableMapping[str, Any] | None = None, fetch_size: MutableMapping[str, Any] | None = None, statement_cache_size: MutableMapping[str, Any] | None = None, initialization_string: MutableMapping[str, Any] | None = None, enable_bulk_load: MutableMapping[str, Any] | None = None, support_v1_data_types: MutableMapping[str, Any] | None = None, fetch_tswtz_as_timestamp: MutableMapping[str, Any] | None = None, encrypted_credential: str | 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
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

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
connection_string
<xref:JSON>

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.

Default value: None
server
<xref:JSON>

The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0.

Default value: None
authentication_type
str or OracleAuthenticationType

Authentication type for connecting to the Oracle database. Only used for Version 2.0. "Basic"

Default value: None
username
<xref:JSON>

The Oracle database username. Type: string. Only used for Version 2.0.

Default value: None
password
AzureKeyVaultSecretReference

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

Default value: None
encryption_client
<xref:JSON>

Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.

Default value: None
encryption_types_client
<xref:JSON>

Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0.

Default value: None
crypto_checksum_client
<xref:JSON>

Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.

Default value: None
crypto_checksum_types_client
<xref:JSON>

Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0.

Default value: None
initial_lob_fetch_size
<xref:JSON>

Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.

Default value: None
fetch_size
<xref:JSON>

Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0.

Default value: None
statement_cache_size
<xref:JSON>

Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0.

Default value: None
initialization_string
<xref:JSON>

Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.

Default value: None
enable_bulk_load
<xref:JSON>

Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0.

Default value: None
support_v1_data_types
<xref:JSON>

Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0.

Default value: None
fetch_tswtz_as_timestamp
<xref:JSON>

Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0.

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

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
IntegrationRuntimeReference

The integration runtime reference.
description
str

Linked service description.
parameters
dict[str, ParameterSpecification]

Parameters for linked service.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.
connection_string
<xref:JSON>

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.
server
<xref:JSON>

The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0.
authentication_type
str or OracleAuthenticationType

Authentication type for connecting to the Oracle database. Only used for Version 2.0. "Basic"
username
<xref:JSON>

The Oracle database username. Type: string. Only used for Version 2.0.
password
AzureKeyVaultSecretReference

The Azure key vault secret reference of password in connection string.
encryption_client
<xref:JSON>

Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
encryption_types_client
<xref:JSON>

Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0.
crypto_checksum_client
<xref:JSON>

Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0.
crypto_checksum_types_client
<xref:JSON>

Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0.
initial_lob_fetch_size
<xref:JSON>

Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.
fetch_size
<xref:JSON>

Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0.
statement_cache_size
<xref:JSON>

Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0.
initialization_string
<xref:JSON>

Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.
enable_bulk_load
<xref:JSON>

Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0.
support_v1_data_types
<xref:JSON>

Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0.
fetch_tswtz_as_timestamp
<xref:JSON>

Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0.
encrypted_credential
str

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