Share via


TeradataLinkedService Class

Linked service for Teradata data source.

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

Constructor

TeradataLinkedService(*, 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.TeradataAuthenticationType | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, ssl_mode: MutableMapping[str, Any] | None = None, port_number: MutableMapping[str, Any] | None = None, https_port_number: MutableMapping[str, Any] | None = None, use_data_encryption: MutableMapping[str, Any] | None = None, character_set: MutableMapping[str, Any] | None = None, max_resp_size: 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

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

Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0.

Default value: None
server
<xref:JSON>

Server name for connection. Type: string (or Expression with resultType string).

Default value: None
authentication_type

AuthenticationType to be used for connection. Known values are: "Basic" and "Windows".

Default value: None
username
<xref:JSON>

Username for authentication. Type: string (or Expression with resultType string).

Default value: None
password

Password for authentication.

Default value: None
ssl_mode
<xref:JSON>

SSL mode for connection. Valid values including: "Disable", "Allow", "Prefer", "Require", "Verify-CA", "Verify-Full". Default value is "Verify-Full". Type: string (or Expression with resultType string). Only applied for version 2.0.

Default value: None
port_number
<xref:JSON>

The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0.

Default value: None
https_port_number
<xref:JSON>

The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.

Default value: None
use_data_encryption
<xref:JSON>

Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.

Default value: None
character_set
<xref:JSON>

The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0.

Default value: None
max_resp_size
<xref:JSON>

The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied 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

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.

connection_string
<xref:JSON>

Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0.

server
<xref:JSON>

Server name for connection. Type: string (or Expression with resultType string).

authentication_type

AuthenticationType to be used for connection. Known values are: "Basic" and "Windows".

username
<xref:JSON>

Username for authentication. Type: string (or Expression with resultType string).

password

Password for authentication.

ssl_mode
<xref:JSON>

SSL mode for connection. Valid values including: "Disable", "Allow", "Prefer", "Require", "Verify-CA", "Verify-Full". Default value is "Verify-Full". Type: string (or Expression with resultType string). Only applied for version 2.0.

port_number
<xref:JSON>

The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0.

https_port_number
<xref:JSON>

The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.

use_data_encryption
<xref:JSON>

Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0.

character_set
<xref:JSON>

The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0.

max_resp_size
<xref:JSON>

The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0.

encrypted_credential
str

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